Plays an audio stream non-positionally.
To play audio positionally, use AudioStreamPlayer2D or AudioStreamPlayer3D instead of AudioStreamPlayer.
Emitted when the audio stops playing.
MIX_TARGET_STEREO = 0
The audio will be played only on the first channel.
MIX_TARGET_SURROUND = 1
The audio will be played on all surround channels.
MIX_TARGET_CENTER = 2
The audio will be played on the second channel, which is usually the center.
If true
, audio plays when added to scene tree.
Bus on which this audio is playing.
Note: When setting this property, keep in mind that no validation is performed to see if the given name matches an existing bus. This is because audio bus layouts might be loaded after this property is set. If this given name can't be resolved at runtime, it will fall back to "Master"
.
The maximum number of sounds this node can play at the same time. Playing additional sounds after this value is reached will cut off the oldest sounds.
If the audio configuration has more than two speakers, this sets the target channels. See MixTarget constants.
The pitch and the tempo of the audio, as a multiplier of the audio sample's sample rate.
If true
, audio is playing.
The AudioStream object to be played.
If true
, the playback is paused. You can resume it by setting stream_paused to false
.
Volume of sound, in dB.
Returns the position in the AudioStream in seconds.
Returns the AudioStreamPlayback object associated with this AudioStreamPlayer.
Returns whether the AudioStreamPlayer can return the AudioStreamPlayback object or not.
Plays the audio from the given from_position
, in seconds.
Sets the position from which audio will be played, in seconds.
Stops the audio.