Table of Contents

Class AudioStreamPlaylist

AudioStream that includes sub-streams and plays them back like a playlist.

Inheritance
AudioStreamPlaylist

Fields

MAX_STREAMS

Maximum amount of streams supported in the playlist.

const MAX_STREAMS = 64

Properties

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.

var fade_time : float = 0.3

Property Value

float

Remarks

  • void set_fade_time(float value)
  • float get_fade_time

loop

If true, the playlist will loop, otherwise the playlist will end when the last stream is finished.

var loop : bool = true

Property Value

bool

Remarks

  • void set_loop(bool value)
  • bool has_loop

shuffle

If true, the playlist will shuffle each time playback starts and each time it loops.

var shuffle : bool = false

Property Value

bool

Remarks

  • void set_shuffle(bool value)
  • bool get_shuffle

stream_count

Amount of streams in the playlist.

var stream_count : int = 0

Property Value

int

Remarks

  • void set_stream_count(int value)
  • int get_stream_count

Methods

get_bpm

Qualifiers: const

Returns the BPM of the playlist, which can vary depending on the clip being played.

float get_bpm

get_list_stream(int)

Qualifiers: const

Returns the stream at playback position index.

AudioStream get_list_stream(int stream_index)

Parameters

stream_index int

set_list_stream(int, AudioStream)

Sets the stream at playback position index.

void set_list_stream(int stream_index, AudioStream audio_stream)

Parameters

stream_index int
audio_stream AudioStream