Table of Contents

Class AudioStreamPlayback

Namespace
Godot
Assembly
GodotSharp.dll

Can play, loop, pause a scroll through audio. See AudioStream and AudioStreamOggVorbis for usage.

public class AudioStreamPlayback : RefCounted, IDisposable
Inheritance
AudioStreamPlayback
Implements
Derived
Inherited Members

Constructors

AudioStreamPlayback() 

public AudioStreamPlayback()

Methods

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

_GetLoopCount()

Overridable method. Should return how many times this audio stream has looped. Most built-in playbacks always return 0.

public virtual int _GetLoopCount()

Returns

int

_GetPlaybackPosition()

Overridable method. Should return the current progress along the audio stream, in seconds.

public virtual double _GetPlaybackPosition()

Returns

double

_IsPlaying()

Overridable method. Should return true if this playback is active and playing its audio stream.

public virtual bool _IsPlaying()

Returns

bool

_Seek(double)

Override this method to customize what happens when seeking this audio stream at the given position, such as by calling Seek(float).

public virtual void _Seek(double position)

Parameters

position double

_Start(double)

Override this method to customize what happens when the playback starts at the given position, such as by calling Play(float).

public virtual void _Start(double fromPos)

Parameters

fromPos double

_Stop()

Override this method to customize what happens when the playback is stopped, such as by calling Stop().

public virtual void _Stop()

_TagUsedStreams()

Overridable method. Called whenever the audio stream is mixed if the playback is active and SetEnableTaggingUsedAudioStreams(bool) has been set to true. Editor plugins may use this method to "tag" the current position along the audio stream and display it in a preview.

public virtual void _TagUsedStreams()
Edit this page