Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

AudioStreamPlayer

Inherits: Node < Object

Plays back audio non-positionally.

Description

Plays an audio stream non-positionally.

To play audio positionally, use AudioStreamPlayer2D or AudioStreamPlayer3D instead of AudioStreamPlayer.

Tutorials

• Audio streams

• 2D Dodge The Creeps Demo

• Audio Device Changer Demo

• Audio Generator Demo

• Audio Mic Record Demo

• Audio Spectrum Demo

Properties

bool	autoplay	false
StringName	bus	&"Master"
int	max_polyphony	1
MixTarget	mix_target	0
float	pitch_scale	1.0
bool	playing	false
AudioStream	stream
bool	stream_paused	false
float	volume_db	0.0

Methods

float	get_playback_position ( )
AudioStreamPlayback	get_stream_playback ( )
bool	has_stream_playback ( )
void	play ( float from_position=0.0 )
void	seek ( float to_position )
void	stop ( )

---

Signals

finished ( )

Emitted when the audio stops playing.

---

Enumerations

enum MixTarget:

MixTarget MIX_TARGET_STEREO = 0

The audio will be played only on the first channel.

MixTarget MIX_TARGET_SURROUND = 1

The audio will be played on all surround channels.

MixTarget MIX_TARGET_CENTER = 2

The audio will be played on the second channel, which is usually the center.

---

Property Descriptions

bool autoplay = false

• void set_autoplay ( bool value )

• bool is_autoplay_enabled ( )

If true, audio plays when added to scene tree.

---

StringName