Translations by theadmin

If true, sounds will loop even when fadeout is occuring. This should be set to True for a sound effects or seamless music channel, and False if the music fades out on its own.

Returns true if the given channel is playing.

Audio

Ren'Py supports playing music and sound effects in the background, using the following audio file formats

OGG Vorbis

MP3

WAV (uncompressed PCM only)

Ren'Py supports an arbitrary number of audio channels. Three are defined by default:

music - A channel for music playback.

sound - A channel for sound effects.

voice - A channel for voice.

New channels can be registered with :func:`renpy.music.register_channel`.

The 'Music Volume', 'Sound Volume', and 'Voice Volume' settings of the in-game preferences menu are used to set individual volumes for these channels.

Sounds can also be set to play when buttons, menu choices, or imagemaps enter their hovered or activated states. See :ref:`Button Style Properties <button-style-properties>`. Two configuration variables, :var:`config.main_menu_music` and :var:`config.game_menu_music` allow for the given music files to be played as the main and game menu music, respectively.

In-game, the usual way to play music and sound in Ren'Py is using the three music/sound statements.

Play Statement

The play statement is used to play sound and music. If a file is currently playing, it is interrupted and replaced with the new file.

The name of a channel is expected following keyword ``play``, (Usually, this is either "sound", "music", or "voice"). This is followed by audiofile(s), where audiofile(s) can be one file or list of files. When the list is given, the item of it is played in order.

The ``fadein`` and ``fadeout`` clauses are optional. Fadeout gives the fadeout time for currently playing music, in seconds, while fadein gives the time it takes to fade in the new music. If fadeout is not given, config.fade_music is used.

The ``loop`` and ``noloop`` clauses are also optional. The loop clause causes the music to loop, while noloop causes it to play only once. If both of them isn't given, the default of the channel is used. ::

Stop Statement

The stop statement begin with keyword ``stop``, followed by the the name of a channel to stop sound on. It may optionally have a ``fadeout`` clause. ::

Queue Statement

The queue statement is used to queue up audio files. They will be played when the channel finishes playing the currently playing file.

The queue statement begin with keyword ``queue``, followed by the the name of a channel to play sound on. It optionally takes the ``loop`` and ``noloop`` clauses. ::

The advantage of using these statements is that your program will be checked for missing sound and music files when lint is run. The functions below exist to allow access to allow music and sound to be controlled from python, and to expose advanced (rarely-used) features.

Functions

Returns True if the given filename has been played at least once on the current user's system.

If the given channel is playing, returns the playing file name. Otherwise, returns None.

Returns True if the channel is currently playing a sound, False if it is not, or if the sound system isn't working.

This stops the music currently playing on the numbered channel, dequeues any queued music, and begins playing the specified file or files.

`filenames`

This may be a single file, or a list of files to be played.

`channel`

The channel to play the sound on.

`loop`

If this is True, the tracks will loop while they are the last thing in the queue.

`fadeout`

If not None, this is a time in seconds to fade for. Otherwise the fadeout time is taken from config.fade_music.

`synchro_start`

Ren'Py will ensure that all channels of with synchro_start set to true will start playing at exactly the same time. Synchro_start should be true when playing two audio files that are meant to be synchronized with each other.

`fadein`

This is the number of seconds to fade the music in for, on the first loop only.

`tight`

If this is True, then fadeouts will span into the next-queued sound.

`if_changed`

If this is True, and the music file is currently playing, then it will not be stopped/faded out and faded back in again, but instead will be kept playing. (This will always queue up an additional loop of the music.)

This queues the given filenames on the specified channel.

`clear_queue`