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...

AudioStreamPlayer2D

Hereda: Node2D < CanvasItem < Node < Object

Reproduce sonido posicional en el espacio 2D.

Descripción

Reproduce audio que se atenúa según la distancia al oyente.

Por defecto, el audio se escucha desde el centro de la pantalla. Esto se puede cambiar agregando un nodo AudioListener2D a la escena y activándolo llamando a AudioListener2D.make_current().

Véase también AudioStreamPlayer para reproducir un sonido sin posicionamiento.

Nota: Ocultar un nodo AudioStreamPlayer2D no desactiva su salida de audio. Para desactivar temporalmente el audio de un AudioStreamPlayer2D, establece volume_db a un valor muy bajo como -100 (que no es audible para el oído humano).

Tutoriales

Propiedades

int

area_mask

0

float

attenuation

1.0

bool

autoplay

false

StringName

bus

&"Master"

float

max_distance

2000.0

int

max_polyphony

1

float

panning_strength

1.0

float

pitch_scale

1.0

PlaybackType

playback_type

0

bool

playing

false

AudioStream

stream

bool

stream_paused

false

float

volume_db

0.0

float

volume_linear

Métodos

float

get_playback_position()

AudioStreamPlayback

get_stream_playback()

bool

has_stream_playback()

void

play(from_position: float = 0.0)

void

seek(to_position: float)

void

stop()

Señales

finished() 🔗

Emitida cuando el audio deja de reproducirse.

Descripciones de Propiedades

int area_mask = 0 🔗

  • void set_area_mask(value: int)

  • int get_area_mask()

Determina qué capas de Area2D afectan el sonido para la reverberación y los efectos del bus de audio. Las áreas pueden usarse para redirigir AudioStreams de manera que se reproduzcan en un bus de audio específico. Un ejemplo de uso sería crear un área de "agua" para que los sonidos reproducidos dentro del agua se redirijan a través de un bus de audio, haciendo que suenen como si se reprodujeran bajo el agua.

float attenuation = 1.0 🔗

  • void set_attenuation(value: float)

  • float get_attenuation()

The volume is attenuated over distance with this as an exponent.

bool autoplay = false 🔗

  • void set_autoplay(value: bool)

  • bool is_autoplay_enabled()

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

StringName bus = &"Master" 🔗

Bus en el que se está reproduciendo este audio.

Nota: Al establecer esta propiedad, ten en cuenta que no se realiza ninguna validación para verificar si el nombre proporcionado coincide con un bus existente. Esto se debe a que los diseños de buses de audio podrían cargarse después de que se haya establecido esta propiedad. Si el nombre proporcionado no se puede resolver en tiempo de ejecución, se usará como valor predeterminado "Master".

float max_distance = 2000.0 🔗

  • void set_max_distance(value: float)

  • float get_max_distance()

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

int max_polyphony = 1 🔗

  • void set_max_polyphony(value: int)

  • int get_max_polyphony()

El número máximo de sonidos que este nodo puede reproducir simultáneamente. Reproducir sonidos adicionales después de alcanzar este límite hará que se corten los sonidos más antiguos.

float panning_strength = 1.0 🔗

  • void set_panning_strength(value: float)

  • float get_panning_strength()

Escala la intensidad del paneo de este nodo multiplicando el valor base de ProjectSettings.audio/general/2d_panning_strength por este factor. Valores más altos harán que el audio se panee de izquierda a derecha de manera más pronunciada que los valores bajos.

float pitch_scale = 1.0 🔗

  • void set_pitch_scale(value: float)

  • float get_pitch_scale()

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

PlaybackType playback_type = 0 🔗

Experimental: Esta propiedad podría ser modificada o eliminada en versiones futuras.

El tipo de reproducción del reproductor de flujo. Si se establece un valor distinto al predeterminado, se forzará ese tipo de reproducción.

bool playing = false 🔗

  • void set_playing(value: bool)

  • bool is_playing()

If true, audio is playing or is queued to be played (see play()).

AudioStream stream 🔗

El objeto AudioStream que se va a reproducir.

bool stream_paused = false 🔗

  • void set_stream_paused(value: bool)

  • bool get_stream_paused()

Si es true, la reproducción se pausa. Puede reanudarla estableciendo stream_paused en false.

float volume_db = 0.0 🔗

  • void set_volume_db(value: float)

  • float get_volume_db()

Base volume before attenuation, in decibels.

float volume_linear 🔗

  • void set_volume_linear(value: float)

  • float get_volume_linear()

Volumen base antes de la atenuación, como un valor lineal.

Nota: Este miembro modifica volume_db por conveniencia. El valor devuelto es equivalente al resultado de @GlobalScope.db_to_linear() aplicado a volume_db. Configurar este miembro es equivalente a establecer volume_db al resultado de @GlobalScope.linear_to_db() aplicado a un valor.

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.

bool has_stream_playback() 🔗

Returns whether the AudioStreamPlayer can return the AudioStreamPlayback object or not.

void play(from_position: float = 0.0) 🔗

Pone el audio en cola para reproducirse en el siguiente cuadro de física, desde la posición dada from_position, en segundos.

void seek(to_position: float) 🔗

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

void stop() 🔗

Detiene el audio.