:py:mod:`calliope.play`
=======================

.. py:module:: calliope.play

.. autoapi-nested-parse::

   Render a playlist to an audio file.

   See also: :command:`cpe play`.



Package Contents
----------------


Functions
~~~~~~~~~

.. autoapisummary::

   calliope.play.play



.. py:function:: play(tracks, audio_output)

   Render playlist to an audio file using `GStreamer <https://gstreamer.freedesktop.org/>`_.

   The audio output will be in WAV format, and will be written to
   `audio_output`.

   :returns: The input playlist, with an additional `play.start_time` field set.
             This can be used to produce a CUE sheet with :mod:`calliope.export`.