AudioStreamPlaylist
Inherits: AudioStream < Resource < Shared < Object
AudioStream that includes sub-streams and plays them back like a playlist.
Description
Section titled “Description”An audio stream that can play back sub-streams in sequence. Streams can be added to the Playlist with set_list_stream(), and shuffled with shuffle.
Properties
Section titled “Properties”| Type | Name | Default |
|---|---|---|
| float | fade_time | 0.3 |
| bool | loop | true |
| bool | shuffle | false |
| int | stream_count | 0 |
Methods
Section titled “Methods”| Returns | Method |
|---|---|
| float | get_bpm() |
| AudioStream | get_list_stream(stream_index) |
| void | set_list_stream(stream_index, audio_stream) |
Enumerations and constants
Section titled “Enumerations and constants”- MAX_STREAMS =
64— Maximum amount of streams supported in the playlist.
Property descriptions
Section titled “Property descriptions”fade_time
Section titled “fade_time”float fade_time = 0.3
Setter/getter: set_fade_time(), get_fade_time()
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
Setter/getter: set_loop(), has_loop()
If true, the playlist will loop, otherwise the playlist will end when the last stream is finished.
shuffle
Section titled “shuffle”bool shuffle = false
Setter/getter: set_shuffle(), get_shuffle()
If true, the playlist will shuffle each time playback starts and each time it loops.
stream_count
Section titled “stream_count”int stream_count = 0
Setter/getter: set_stream_count(), get_stream_count()
Amount of streams in the playlist.
Method descriptions
Section titled “Method descriptions”get_bpm
Section titled “get_bpm”float get_bpm() const
Returns the BPM of the playlist, which can vary depending on the clip being played.
get_list_stream
Section titled “get_list_stream”AudioStream get_list_stream(stream_index: int) const
Returns the stream at playback position index.
set_list_stream
Section titled “set_list_stream”void set_list_stream(stream_index: int, audio_stream: AudioStream)
Sets the stream at playback position index.