Table of Contents

Class AudioStreamPlaylist

Namespace
Godot
Assembly
GodotSharp.dll
public class AudioStreamPlaylist : AudioStream, IDisposable
Inheritance
AudioStreamPlaylist
Implements
Inherited Members

Constructors

AudioStreamPlaylist() 

public AudioStreamPlaylist()

Fields

MaxStreams

Maximum amount of streams supported in the playlist.

public const long MaxStreams = 64

Field Value

long

Properties

FadeTime

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.

public float FadeTime { get; set; }

Property Value

float

Loop

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

public bool Loop { get; set; }

Property Value

bool

Shuffle

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

public bool Shuffle { get; set; }

Property Value

bool

StreamCount

Amount of streams in the playlist.

public int StreamCount { get; set; }

Property Value

int

Methods

GetBpm()

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

public double GetBpm()

Returns

double

GetListStream(int)

Returns the stream at playback position index.

public AudioStream GetListStream(int streamIndex)

Parameters

streamIndex int

Returns

AudioStream

HasGodotClassMethod(in godot_string_name)

Check if the type contains a method with the given name. This method is used by Godot to check if a method exists before invoking it. Do not call or override this method.

protected override bool HasGodotClassMethod(in godot_string_name method)

Parameters

method godot_string_name

Name of the method to check for.

Returns

bool

HasGodotClassSignal(in godot_string_name)

Check if the type contains a signal with the given name. This method is used by Godot to check if a signal exists before raising it. Do not call or override this method.

protected override bool HasGodotClassSignal(in godot_string_name signal)

Parameters

signal godot_string_name

Name of the signal to check for.

Returns

bool

InvokeGodotClassMethod(in godot_string_name, NativeVariantPtrArgs, out godot_variant)

Invokes the method with the given name, using the given arguments. This method is used by Godot to invoke methods from the engine side. Do not call or override this method.

protected override bool InvokeGodotClassMethod(in godot_string_name method, NativeVariantPtrArgs args, out godot_variant ret)

Parameters

method godot_string_name

Name of the method to invoke.

args NativeVariantPtrArgs

Arguments to use with the invoked method.

ret godot_variant

Value returned by the invoked method.

Returns

bool

SetListStream(int, AudioStream)

Sets the stream at playback position index.

public void SetListStream(int streamIndex, AudioStream audioStream)

Parameters

streamIndex int
audioStream AudioStream
Edit this page