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...
AudioStream
Hereda: Resource < RefCounted < Object
Heredado por: AudioStreamGenerator, AudioStreamInteractive, AudioStreamMicrophone, AudioStreamMP3, AudioStreamOggVorbis, AudioStreamPlaylist, AudioStreamPolyphonic, AudioStreamRandomizer, AudioStreamSynchronized, AudioStreamWAV
Clase base para las transmisiones de audio.
Descripción
Base class for audio streams. Audio streams are used for sound effects and music playback, and support WAV (via AudioStreamWAV), Ogg (via AudioStreamOggVorbis), and MP3 (via AudioStreamMP3) file formats.
Tutoriales
Métodos
_get_bar_beats() virtual const |
|
_get_beat_count() virtual const |
|
_get_bpm() virtual const |
|
_get_length() virtual const |
|
_get_parameter_list() virtual const |
|
_get_stream_name() virtual const |
|
_get_tags() virtual const |
|
_has_loop() virtual const |
|
_instantiate_playback() virtual required const |
|
_is_monophonic() virtual const |
|
can_be_sampled() const |
|
generate_sample() const |
|
get_length() const |
|
is_meta_stream() const |
|
is_monophonic() const |
Señales
parameter_list_changed() 🔗
Señal a emitir para notificar cuando se modifica la lista de parámetros.
Descripciones de Métodos
int _get_bar_beats() virtual const 🔗
Sobrescribe este método para devolver los compases de esta transmisión.
int _get_beat_count() virtual const 🔗
Método sobrescribible. Debe devolver el número total de pulsos de esta secuencia de audio. El motor lo utiliza para determinar la posición de cada pulso.
Idealmente, el valor devuelto debería basarse en la frecuencia de muestreo de la secuencia (por ejemplo, AudioStreamWAV.mix_rate).
float _get_bpm() virtual const 🔗
Método que se puede sobrescribir. Debe devolver el tempo de este flujo de audio, en pulsos por minuto (BPM, siglas de Beats Per Minute). El motor lo utiliza para determinar la posición de cada pulso.
Idealmente, el valor devuelto debería basarse en la frecuencia de muestreo del flujo (AudioStreamWAV.mix_rate, por ejemplo).
float _get_length() virtual const 🔗
Sobrescribe este método para personalizar el valor devuelto por get_length(). Debe devolver la duración de este flujo de audio, en segundos.
Array[Dictionary] _get_parameter_list() virtual const 🔗
Devuelve los parámetros controlables de este flujo. Este array contiene diccionarios con una descripción de la propiedad en formato info (ver Object.get_property_list()). Además, el valor por defecto de cada parámetro debe añadirse a cada diccionario en el campo "default_value".
String _get_stream_name() virtual const 🔗
Sobrescribe este método para proporcionar el nombre que aparecerá en el menú de visibilidad del gizmo.
Dictionary _get_tags() virtual const 🔗
Sobrescribe este método para personalizar las etiquetas de este flujo de audio. Debe devolver un Dictionary de cadenas, con la etiqueta como clave y su contenido como valor.
Las etiquetas más comunes incluyen title, artist, album, tracknumber y date.
bool _has_loop() virtual const 🔗
Sobrescribe este método para devolver true si esta secuencia tiene un bucle.
AudioStreamPlayback _instantiate_playback() virtual required const 🔗
Sobrescribe este método para personalizar el valor devuelto por instantiate_playback(). Debe devolver un nuevo AudioStreamPlayback que se crea cuando el flujo se reproduce (por ejemplo, mediante un AudioStreamPlayer).
bool _is_monophonic() virtual const 🔗
Sobrescribe este método para personalizar el valor devuelto por is_monophonic(). Debe devolver true si este flujo de audio solo admite un canal.
Experimental: Este método podría ser modificado o eliminado en versiones futuras.
Devuelve si el AudioStream actual puede utilizarse como muestra. Solo los flujos estáticos pueden utilizarse como muestra.
AudioSample generate_sample() const 🔗
Experimental: Este método podría ser modificado o eliminado en versiones futuras.
Genera un AudioSample basado en la transmisión actual.
Devuelve la duración del flujo de audio en segundos. Si este flujo es un AudioStreamRandomizer, devuelve la duración del último flujo reproducido. Si este flujo tiene una duración indefinida (como en AudioStreamGenerator y AudioStreamMicrophone), devuelve 0.0.
AudioStreamPlayback instantiate_playback() 🔗
Devuelve un nuevo AudioStreamPlayback creado para reproducir este flujo de audio. Resulta útil cuando se desea extender _instantiate_playback(), pero llamando a instantiate_playback() desde un subrecurso AudioStream mantenido internamente. Un ejemplo de esto puede encontrarse en el código fuente de AudioStreamRandomPitch::instantiate_playback.
Devuelve true si la transmisión es una colección de otras transmisiones, false en caso contrario.
Devuelve true si este flujo de audio solo admite un canal (monofonía), o false si el flujo de audio admite dos o más canales (polifonía).