AudioStreamPlayer2D¶

Inherits: Node2D < CanvasItem < Node < Object

Plays positional sound in 2D space.

Descripción¶

Plays audio that dampens with distance from screen center.

See also AudioStreamPlayer to play a sound non-positionally.

Note: Hiding an AudioStreamPlayer2D node does not disable its audio output. To temporarily disable an AudioStreamPlayer2D's audio output, set volume_db to a very low value like -100 (which isn't audible to human hearing).

Tutoriales¶

Corriente de Audio

Propiedades¶

int	area_mask	`1`
float	attenuation	`1.0`
bool	autoplay	`false`
String	bus	`"Master"`
float	max_distance	`2000.0`
float	pitch_scale	`1.0`
bool	playing	`false`
AudioStream	stream
bool	stream_paused	`false`
float	volume_db	`0.0`

Métodos¶

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

Señales¶

finished ( )

Emitido cuando el audio deja de reproducirse.

Descripciones de Propiedades¶

int area_mask

Default	`1`
Setter	set_area_mask(value)
Getter	get_area_mask()

Áreas en las que se reproduce este sonido.

float attenuation

Default	`1.0`
Setter	set_attenuation(value)
Getter	get_attenuation()

Amortigua el audio a distancia con esto como exponente.

bool autoplay

Default	`false`
Setter	set_autoplay(value)
Getter	is_autoplay_enabled()

Si true, el audio se reproduce cuando se añade al árbol de la escena.

String bus

Default	`"Master"`
Setter	set_bus(value)
Getter	get_bus()

El bus en el que se está reproduciendo este audio.

float max_distance

Default	`2000.0`
Setter	set_max_distance(value)
Getter	get_max_distance()

Distancia máxima desde la que se puede oír el audio.

float pitch_scale

Default	`1.0`
Setter	set_pitch_scale(value)
Getter	get_pitch_scale()

El tono y el tempo del audio, como multiplicador de la tasa de muestreo de la muestra de audio.

bool playing

Default	`false`
Getter	is_playing()

Si true, el audio se está reproduciendo.

AudioStream stream

Setter	set_stream(value)
Getter	get_stream()

El objeto AudioStream que se va a reproducir.

bool stream_paused

Default	`false`
Setter	set_stream_paused(value)
Getter	get_stream_paused()

Si true, la reproducción se interrumpe. Puede reanudarla ajustando stream_paused a false.

float volume_db

Default	`0.0`
Setter	set_volume_db(value)
Getter	get_volume_db()

Volumen de la base sin amortiguar.

Descripciones de Métodos¶

float get_playback_position ( )

Devuelve la posición en el AudioStream.

AudioStreamPlayback get_stream_playback ( )

Devuelve el objeto AudioStreamPlayback asociado a este AudioStreamPlayer2D.

void play ( float from_position=0.0 )

Reproduce el audio desde la posición dada de_posición, en segundos.

void seek ( float to_position )

Establece la posición desde la que se reproducirá el audio, en segundos.

void stop ( )

Detiene el audio.