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

AudioStreamPlaybackPolyphonic

Hereda: AudioStreamPlayback < RefCounted < Object

Instancia de reproducción para AudioStreamPolyphonic.

Descripción

Instancia de reproducción para AudioStreamPolyphonic. Después de establecer la propiedad stream de AudioStreamPlayer, AudioStreamPlayer2D o AudioStreamPlayer3D, la instancia de reproducción puede obtenerse llamando a los métodos AudioStreamPlayer.get_stream_playback(), AudioStreamPlayer2D.get_stream_playback() o AudioStreamPlayer3D.get_stream_playback().

Métodos

bool	is_stream_playing(stream: int) const
int	play_stream(stream: AudioStream, from_offset: float = 0, volume_db: float = 0, pitch_scale: float = 1.0, playback_type: PlaybackType = 0, bus: StringName = &"Master")
void	set_stream_pitch_scale(stream: int, pitch_scale: float)
void	set_stream_volume(stream: int, volume_db: float)
void	stop_stream(stream: int)

---

Constantes

INVALID_ID = -1 🔗

Devuelto por play_stream() en caso de que no se pudiera asignar un flujo para la reproducción.

---

Descripciones de Métodos

bool is_stream_playing(stream: int) const 🔗

Returns true if the stream associated with the given integer ID is still playing. Check play_stream() for information on when this ID becomes invalid.

---

int play_stream(stream: AudioStream, from_offset: float = 0, volume_db: float = 0, pitch_scale: float = 1.0, playback_type: PlaybackType = 0, bus: StringName = &"Master") 🔗

Reproduce un AudioStream con un desplazamiento inicial, volumen, escala de tono, tipo de reproducción y bus determinados. La reproducción comienza de inmediato.

El valor devuelto es un ID entero único asociado a esta reproducción, que puede usarse para controlarla.

Este ID se vuelve inválido cuando el flujo termina (si no está en bucle), cuando se detiene el AudioStreamPlaybackPolyphonic, o cuando se llama a stop_stream().

Esta función devuelve INVALID_ID si la cantidad de flujos actualmente en reproducción alcanza AudioStreamPolyphonic.polyphony. Si necesitas una mayor polifonía máxima, incrementa este valor.

---

void set_stream_pitch_scale(stream: int, pitch_scale: float) 🔗

Cambia la escala del tono del flujo. El argumento stream es un ID entero devuelto por play_stream().

---

void set_stream_volume(stream: int, volume_db: float) 🔗

Cambia el volumen del flujo (en dB). El argumento stream es un ID entero devuelto por play_stream().

---

void stop_stream(stream: int) 🔗

Detiene un flujo. El argumento stream es un ID entero devuelto por play_stream(), que se vuelve inválido después de llamar a esta función.