AudioStreamPlayer

public bool Autoplay { get; set; }

If true, this node calls AudioStreamPlayer.Play when entering the tree.

public StringName Bus { get; set; }

Name of the receiving bus. If it is absent from the layout, audio falls back to Master. Check GetBusIndex(name) during project setup so the fallback does not hide a typo.

public int MaxPolyphony { get; set; }

Maximum simultaneous voices in this player. A new Play exceeding the limit replaces the oldest voice. Use a positive value; choose 1 for a single controlled music stream.

public AudioStreamPlayer.MixTargetEnum MixTarget { get; set; }

The mix target channels. Has no effect when two speakers or less are detected (see AudioServer.SpeakerMode).

public float PitchScale { get; set; }

A positive speed and pitch multiplier. A value of 2 raises pitch and speeds up an ordinary stream; this is not independent time stretching. Zero is not a pause: use StreamPaused.

public AudioServer.PlaybackType PlaybackType { get; set; }

The playback type of the stream player. If set other than to the default value, it will force that playback type.

public bool Playing { get; set; }

If true, this node is playing sounds. Setting this property has the same effect as AudioStreamPlayer.Play and AudioStreamPlayer.Stop.

public AudioStream Stream { get; set; }

The AudioStream resource to be played. Setting this property stops all currently playing sounds. If left empty, the AudioStreamPlayer does not work.

public bool StreamPaused { get; set; }

Pauses or resumes existing voices. A pending pause is not retained when no voices exist. In Stream mode, pausing makes IsPlaying() false while HasStreamPlayback() remains true.

public float VolumeDb { get; set; }

Volume of sound, in decibels. This is an offset of the AudioStreamPlayer.Stream's volume. Note: To convert between decibel and linear energy (like most volume sliders do), use AudioStreamPlayer.VolumeLinear, or @GlobalScope.db_to_linear and @GlobalScope.linear_to_db.

public float VolumeLinear { get; set; }

Volume of sound, as a linear value. Note: This member modifies AudioStreamPlayer.VolumeDb for convenience. The returned value is equivalent to the result of @GlobalScope.db_to_linear on AudioStreamPlayer.VolumeDb. Setting this member is equivalent to setting AudioStreamPlayer.VolumeDb to the result of @GlobalScope.linear_to_db on a value.

public float GetPlaybackPosition();

Returns the most recently created voice's position in seconds, not the combined time of all voices. It can advance in steps between mixes. For a single stream at speed 1, time since the last mix can refine an estimate; handle pause, seeking and output latency separately.

public AudioStreamPlayback GetStreamPlayback();

Returns the most recently created playback object. Check HasStreamPlayback() first; without voices the method reports an error. A retained decoder reference does not prove its voice remains attached to the player/mixer.

public bool HasStreamPlayback();

Checks whether the player retains playback objects, including paused ones. This does not prove audible output: mute, distance or pause can produce silence.

public bool IsPlaying();

In Stream mode, returns true for an actively playing voice. Returns false while paused; use HasStreamPlayback() or StreamPaused to detect retained playback. Do not reject a resume command using this method.

public void Play(float fromPosition = 0f);

Creates playback of the assigned Stream at the requested position in seconds; requires the player inside the tree. Repeated calls add voices within MaxPolyphony rather than necessarily resuming an old one. Use StreamPaused = false to resume.

public void Seek(float toPosition);

Restarts the player at a position in seconds only while actively playing. Stops previous voices and starts a new one at the position. In Stream mode it does nothing while paused or stopped. To seek while retaining pause, save the flag, call Stop(), Play(position), then restore StreamPaused.

public void Stop();

Stops every voice in this player and clears its playback list. Does not emit Finished. Use Play() for a new start; this differs from resuming a pause.

public event Action Finished;

Emitted when an update removes one or more naturally ended voices. Other voices may still be playing. Stop() and voice-limit replacement are not natural completion; looping does not emit this signal each cycle.