Table of Contents

Class AudioStreamSynchronized

Namespace
Godot
Assembly
GodotSharp.dll

This is a stream that can be fitted with sub-streams, which will be played in-sync. The streams being at exactly the same time when play is pressed, and will end when the last of them ends. If one of the sub-streams loops, then playback will continue.

public class AudioStreamSynchronized : AudioStream, IDisposable
Inheritance
AudioStreamSynchronized
Implements
Inherited Members

Constructors

AudioStreamSynchronized() 

public AudioStreamSynchronized()

Fields

MaxStreams

Maximum amount of streams that can be synchronized.

public const long MaxStreams = 32

Field Value

long

Properties

StreamCount

Set the total amount of streams that will be played back synchronized.

public int StreamCount { get; set; }

Property Value

int

Methods

GetSyncStream(int)

Get one of the synchronized streams, by index.

public AudioStream GetSyncStream(int streamIndex)

Parameters

streamIndex int

Returns

AudioStream

GetSyncStreamVolume(int)

Get the volume of one of the synchronized streams, by index.

public float GetSyncStreamVolume(int streamIndex)

Parameters

streamIndex int

Returns

float

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

SetSyncStream(int, AudioStream)

Set one of the synchronized streams, by index.

public void SetSyncStream(int streamIndex, AudioStream audioStream)

Parameters

streamIndex int
audioStream AudioStream

SetSyncStreamVolume(int, float)

Set the volume of one of the synchronized streams, by index.

public void SetSyncStreamVolume(int streamIndex, float volumeDb)

Parameters

streamIndex int
volumeDb float
Edit this page