AudioStreamSample¶

Inherits: AudioStream < Resource < Reference < Object

Almacena datos de audio cargados desde archivos WAV.

Descripción¶

AudioStreamSample stores sound samples loaded from WAV files. To play the stored sound, use an AudioStreamPlayer (for non-positional audio) or AudioStreamPlayer2D/AudioStreamPlayer3D (for positional audio). The sound can be looped.

This class can also be used to store dynamically-generated PCM audio data. See also AudioStreamGenerator for procedural audio generation.

Propiedades¶

PoolByteArray	data	`PoolByteArray( )`
Format	format	`0`
int	loop_begin	`0`
int	loop_end	`0`
LoopMode	loop_mode	`0`
int	mix_rate	`44100`
bool	stereo	`false`

Métodos¶

Error

save_to_wav ( String path )

Enumeraciones¶

enum Format:

FORMAT_8_BITS = 0 --- Códec de audio de 8 bits.
FORMAT_16_BITS = 1 --- Códec de audio de 16 bits.
FORMAT_IMA_ADPCM = 2 --- El audio se comprime usando IMA ADPCM.

enum LoopMode:

LOOP_DISABLED = 0 --- El audio no se reproduce en bucle.
LOOP_FORWARD = 1 --- El audio hace un bucle con los datos entre loop_begin y loop_end, reproduciéndose sólo hacia adelante.
LOOP_PING_PONG = 2 --- El audio hace un bucle con los datos entre loop_begin y loop_end, reproduciéndose hacia adelante y hacia atrás.
LOOP_BACKWARD = 3 --- El audio hace un bucle con los datos entre loop_begin y loop_end, reproduciéndose sólo hacia atrás.

Descripciones de Propiedades¶

PoolByteArray data

Default	`PoolByteArray( )`
Setter	set_data(value)
Getter	get_data()

Contiene los datos de audio en bytes.

Nota: Esta propiedad espera datos firmados de PCM8. Para convertir PCM8 sin firmar en PCM8 firmado, reste 128 de cada byte.

Format format

Default	`0`
Setter	set_format(value)
Getter	get_format()

Formato de audio. Véase las constantes Format para los valores.

int loop_begin

Default	`0`
Setter	set_loop_begin(value)
Getter	get_loop_begin()

El punto de inicio del bucle (en número de muestras, en relación con el inicio de la muestra). Esta información se importará automáticamente desde el archivo WAV si está presente.

int loop_end

Default	`0`
Setter	set_loop_end(value)
Getter	get_loop_end()

El punto final del bucle (en número de muestras, relativo al comienzo de la muestra). Esta información se importará automáticamente desde el archivo WAV si está presente.

LoopMode loop_mode

Default	`0`
Setter	set_loop_mode(value)
Getter	get_loop_mode()

El modo de bucle. Esta información se importará automáticamente desde el archivo WAV si está presente. Ver las constantes LoopMode para los valores.

int mix_rate

Default	`44100`
Setter	set_mix_rate(value)
Getter	get_mix_rate()

The sample rate for mixing this audio. Higher values require more storage space, but result in better quality.

In games, common sample rates in use are 11025, 16000, 22050, 32000, 44100, and 48000.

According to the Nyquist-Shannon sampling theorem, there is no quality difference to human hearing when going past 40,000 Hz (since most humans can only hear up to ~20,000 Hz, often less). If you are using lower-pitched sounds such as voices, lower sample rates such as 32000 or 22050 may be usable with no loss in quality.

bool stereo

Default	`false`
Setter	set_stereo(value)
Getter	is_stereo()

Si true, el audio es estéreo.

Descripciones de Métodos¶

Error save_to_wav ( String path )

Guarda el AudioStreamSample como un archivo WAV en path. Las muestras con formato IMA ADPCM no pueden ser guardadas.

Nota: Una extensión .wav se añade automáticamente a path si falta.