A node for audio playback.
The AudioStreamPlayer node plays an audio stream non-positionally. It is ideal for user interfaces, menus, or background music.
To use this node, stream needs to be set to a valid AudioStream resource. Playing more than one sound at the same time is also supported, see max_polyphony.
If you need to play audio at a specific position, use AudioStreamPlayer2D or AudioStreamPlayer3D instead.
The target bus name. All sounds from this node will be playing on this bus.
Note: At runtime, if no bus with the given name exists, all sounds will fall back on "Master". See also AudioServer.get_bus_name().
The maximum number of sounds this node can play at the same time. Calling play() after this value is reached will cut off the oldest sounds.
The mix target channels. Has no effect when two speakers or less are detected (see AudioServer.SpeakerMode).
The audio's pitch and tempo, as a multiplier of the stream's sample rate. A value of 2.0 doubles the audio's pitch, while a value of 0.5 halves the pitch.
The playback type of the stream player. If set other than to the default value, it will force that playback type.
The AudioStream resource to be played. Setting this property stops all currently playing sounds. If left empty, the AudioStreamPlayer does not work.
If true, the sounds are paused. Setting stream_paused to false resumes all sounds.
Note: This property is automatically changed when exiting or entering the tree, or this node is paused (see Node.process_mode).
Volume of sound, in decibels. This is an offset of the stream's volume.
Note: To convert between decibel and linear energy (like most volume sliders do), use volume_linear, or db_to_linear() and linear_to_db().
Volume of sound, as a linear value.
Note: This member modifies volume_db for convenience. The returned value is equivalent to the result of db_to_linear() on volume_db. Setting this member is equivalent to setting volume_db to the result of linear_to_db() on a value.
Returns the position in the AudioStream of the latest sound, in seconds. Returns 0.0 if no sounds are playing.
Note: The position is not always accurate, as the AudioServer does not mix audio every processed frame. To get more accurate results, add AudioServer.get_time_since_last_mix() to the returned position.
Note: This method always returns 0.0 if the stream is an AudioStreamInteractive, since it can have multiple clips playing at once.
Returns the latest AudioStreamPlayback of this node, usually the most recently created by play(). If no sounds are playing, this method fails and returns an empty playback.
Returns true if any sound is active, even if stream_paused is set to true. See also playing and get_stream_playback().
Restarts all sounds to be played from the given to_position, in seconds. Does nothing if no sounds are playing.
Emitted when a sound finishes playing without interruptions. This signal is not emitted when calling stop(), or when exiting the tree while sounds are playing.