documentation indexreference manualfunction index

renpy.music.queue

Function: renpy.music.queue (filenames, channel="music", loop=None, clear_queue=True, fadein=0, tight=None):

This queues the given filenames on the named channel.

filenames - May either be a single filename, or a list of filenames.

loop - If True, this music will loop. If False, it will not. If None, takes the channel default.

clear_queue - If True, then the queue is cleared, making these files the files that are played when the currently playing file finishes. If it is False, then these files are placed at the back of the queue. In either case, if no music is playing these files begin playing immediately.

fadein - The number of seconds to fade the music in for, on the first loop only.

tight - If True, then fadeouts will span into the next-queued sound. If False, it will not, and if None, takes the channel default.

Example

    # Start some music playing in the background, looping between 2 music files
    $ renpy.music.queue(["mozart.ogg", "beethoven.ogg"], loop=True)

See also: Audio


documentation indexreference manualfunction index