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

AudioStreamPlayback

Hereda: RefCounted < Object

Heredado por: AudioStreamPlaybackInteractive, AudioStreamPlaybackPlaylist, AudioStreamPlaybackPolyphonic, AudioStreamPlaybackResampled, AudioStreamPlaybackSynchronized

Meta clase para reproducir el audio.

Descripción

Puede reproducir, loopear, pausar y desplazarse a través del audio. Véase AudioStream y AudioStreamOggVorbis para su uso.

Tutoriales

• Demo de Generador de Audio

Métodos

int	_get_loop_count() virtual const
Variant	_get_parameter(name: StringName) virtual const
float	_get_playback_position() virtual required const
bool	_is_playing() virtual required const
int	_mix(buffer: AudioFrame*, rate_scale: float, frames: int) virtual required
void	_seek(position: float) virtual
void	_set_parameter(name: StringName, value: Variant) virtual
void	_start(from_pos: float) virtual required
void	_stop() virtual required
void	_tag_used_streams() virtual
int	get_loop_count() const
float	get_playback_position() const
AudioSamplePlayback	get_sample_playback() const
bool	is_playing() const
PackedVector2Array	mix_audio(rate_scale: float, frames: int)
void	seek(time: float = 0.0)
void	set_sample_playback(playback_sample: AudioSamplePlayback)
void	start(from_pos: float = 0.0)
void	stop()

---

Descripciones de Métodos

int _get_loop_count() virtual const 🔗

Método sobrescribible. Debe devolver cuántas veces se ha repetido este flujo de audio en bucle. La mayoría de las reproducciones integradas siempre devuelven 0.

---

Variant _get_parameter(name: StringName) virtual const 🔗

Devuelve el valor actual de un parámetro de reproducción por nombre (véase AudioStream._get_parameter_list()).

---

float _get_playback_position() virtual required const 🔗

Overridable method. Should return the current progress along the audio stream, in seconds.

---

bool _is_playing() virtual required const 🔗

Método sobrescribible. Debe devolver true si esta reproducción está activa y reproduciendo su flujo de audio.

---

int _mix(buffer: AudioFrame*, rate_scale: float, frames: int) virtual required 🔗

Sobrescribe este método para personalizar cómo se mezcla el flujo de audio. Este método se llama incluso si la reproducción no está activa.

Nota: No es útil sobrescribir este método en GDScript o C#. Solo GDExtension puede aprovecharlo.

---

void _seek(position: float) virtual 🔗

Sobrescribe este método para personalizar qué sucede al buscar una posición en este flujo de audio en la position dada, como por ejemplo llamando a AudioStreamPlayer.seek().

---

void _set_parameter(name: StringName, value: Variant) virtual 🔗

Establece el valor actual de un parámetro de reproducción por su nombre (ver AudioStream._get_parameter_list()).

---

void _start(from_pos: float) virtual required 🔗

Sobrescribe este método para personalizar lo que ocurre cuando la reproducción comienza en la posición indicada, por ejemplo, al llamar a AudioStreamPlayer.play().

---

void _stop() virtual required 🔗

Sobrescriba este método para personalizar lo que sucede cuando se detiene la reproducción, como por ejemplo al llamar a AudioStreamPlayer.stop().

---

void _tag_used_streams() virtual 🔗

Método que se puede sobrescribir. Se llama siempre que se mezcla el flujo de audio si la reproducción está activa y AudioServer.set_enable_tagging_used_audio_streams() se ha establecido en true. Los complementos del editor pueden usar este método para "marcar" la posición actual a lo largo del flujo de audio y mostrarla en una vista previa.

---

int get_loop_count() const 🔗

Returns the number of times the stream has looped.

---

float get_playback_position() const 🔗

Returns the current position in the stream, in seconds.

---

AudioSamplePlayback get_sample_playback() const 🔗

Experimental: Este método podría ser modificado o eliminado en versiones futuras.

Returns the AudioSamplePlayback associated with this AudioStreamPlayback for playing back the audio sample of this stream.

---

bool is_playing() const 🔗

Returns true if the stream is playing.

---

PackedVector2Array mix_audio(rate_scale: float, frames: int) 🔗

Mezcla hasta frames de audio del flujo desde la posición actual, a una velocidad de rate_scale, avanzando el flujo.

Devuelve un PackedVector2Array donde cada elemento contiene los niveles de volumen de los canales izquierdo y derecho de cada frame.

Nota: Puede devolver menos frames de los solicitados; asegúrate de usar el tamaño del valor devuelto.

---

void seek(time: float = 0.0) 🔗

Seeks the stream at the given time, in seconds.

---

void set_sample_playback(playback_sample: AudioSamplePlayback) 🔗

Experimental: Este método podría ser modificado o eliminado en versiones futuras.

Associates AudioSamplePlayback to this AudioStreamPlayback for playing back the audio sample of this stream.

---

void start(from_pos: float = 0.0) 🔗

Inicia la transmisión desde la from_pos dada, en segundos.

---

void stop() 🔗

Detiene la transmisión.