Attention: Here be dragons
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Checking the stable version of the documentation...
AudioStreamPlaylist¶
Inherits: AudioStream < Resource < RefCounted < Object
AudioStream that includes sub-streams and plays them back like a playslit.
Properties¶
|
||
|
||
|
||
|
Methods¶
get_bpm() const |
|
get_list_stream(stream_index: int) const |
|
void |
set_list_stream(stream_index: int, audio_stream: AudioStream) |
Constants¶
MAX_STREAMS = 64
Maximum amount of streams supported in the playlist.
Property Descriptions¶
float fade_time = 0.3
Fade time used when a stream ends, when going to the next one. Streams are expected to have an extra bit of audio after the end to help with fading.
bool loop = true
If true, the playlist will loop, otherwise the playlist when end when the last stream is played.
bool shuffle = false
Shuffle the playlist. Streams are played in random order.
int stream_count = 0
Amount of streams in the playlist.
Method Descriptions¶
float get_bpm() const
Return the bpm of the playlist, which can vary depending on the clip being played.
AudioStream get_list_stream(stream_index: int) const
Get the stream at playback position index.
void set_list_stream(stream_index: int, audio_stream: AudioStream)
Set the stream at playback position index.