sound : Objetos de sonido.

Funciones
sonido	sound.load (string filename)
	Carga un sonido (Sólo MP3, AT3, BGM y WAV).
nil	sound.play (sonido objeto)
	Reproduce un objeto de sonido en el canal por defecto.
nil	sound.play (sonido objeto, int canal)
	Reproduce un objeto de sonido.
nil	sound.pause (sonido objeto, int mode)
	Pausa un objeto de sonido.
number	sound.volume (sonido objeto)
	Volumen de un sonido.
nil	sound.volume (sonido objeto, int volumen)
	Establece el volumen de un sonido.
nil	sound.volume (sonido objeto, int volumenL, int volumenR)
	Establece el volumen de un sonido, canales por separado.
nil	sound.stop (sonido objeto)
	Detiene un objeto de sonido.
nil	sound.free (sonido objeto)
	Libera un objeto de sonido.
boolean	sound.playing (sonido objeto)
	Devuelve si un sonido se está reproduciendo o no.
nil	sound.loop ()
	Detiene el sonido en modo loop.
nil	sound.loop (string ruta)
	Reproduce un archivo en modo loop.
table	sound.id3 (string ruta)
	Información ID3 (Sólo MP3).
imagen	sound.cover (string ruta)
	Carátula ID3 (Sólo MP3).
number	sound.position (sonido objeto)
	Posición de un sonido. (Sólo MP3, [en desarrollo los otros formatos]).
number	sound.duration (sonido objeto)
	Duración de un sonido. (Sólo MP3, [en desarrollo los otros formatos]).
number	sound.percent (sonido objeto)
	Devuelve el porcentaje reproducido de un sonido.
nil	sound.percent (sonido objeto, number percent)
	Setea el porcentaje reproducido de un sonido (Cambia la posición).
tabla	sound.vis (sonido objeto)
	Interfaz interno al visualizador.
tabla	sound.fft (sonido objeto)
	Interfaz interno al FFT (Fast Fourier Tranform).
tabla	sound.blit (sonido objeto, string tipo, number x, number y, number w, number h, color base)
	Dibuja una forma de onda o espectómetro (barritas del winamp).
tabla	sound.blit (sonido objeto, string tipo, number x, number y, number w, number h, color arriba, color abajo, color pico)
	Dibuja un espectómetro, pero con gradientes.
tabla	sound.blit (sonido objeto, string tipo, number x, number y, number w, number h, color fondo_arriba, color fondo_abajo, color barra_arriba, color barra_abajo, color pico, number espaciado)
	Dibuja un espectómetro de barras. (Estilo Winamp).

---

Descripción detallada

Con este módulo se cargará / reproducirá / controlará los sonidos en LuaDEV.
Formatos soportados: MP3, AT3, BGM, WAV

Excepciones:

En

HBL no se reproducirán ni los MP3, ni los AT3, pero están protegidos. Es decir, todas las funciones "funcionarán" pero de un modo "falso". O sea, puedes programar tranquilo una versión para CFW, que en HBL funcionará de igual modo, pero sin que se reproduzca el audio en cuestión.

---

Documentación de las funciones

sonido sound.load

(

string

filename

)

Carga un sonido (Sólo MP3, AT3, BGM y WAV).

Parámetros:

filename

Ruta del archivo a cargar.

Devuelve:

Un objeto del tipo sonido.

nil sound.play

(

sonido

objeto

)

Reproduce un objeto de sonido en el canal por defecto.

Parámetros:

objeto

Objeto de sonido a reproducir

Devuelve:

Nada.

nil sound.play	(	sonido	objeto,
		int	canal
	)

Reproduce un objeto de sonido.

Parámetros:

	objeto	Objeto de sonido a reproducir.
	canal	Canal dónde se reproducirá. Canal de 1 a 8.

Devuelve:

Nada.

nil sound.pause	(	sonido	objeto,
		int	mode
	)

Pausa un objeto de sonido.

Parámetros:

	objeto	Objeto de sonido a pausar.
	mode	Tipo de pausa, uno de los siguientes: -1 - Automática. Si no está pausado se pausa, si está pausado se resume. 0 - Resume el sonido (si está pausado). 1 - Pausa el sonido (si se está reproduciendo).

Devuelve:

Nada.

number sound.volume

(

sonido

objeto

)

Volumen de un sonido.

Parámetros:

objeto

Objeto de sonido.

Devuelve:

2 numeros. Volumen canal izquierdo y volumen canal derecho.

nil sound.volume	(	sonido	objeto,
		int	volumen
	)

Establece el volumen de un sonido.

Parámetros:

	objeto	Objeto de sonido.
	volumen	Un número. Entre 0 y 199.

Devuelve:

Nada.

nil sound.volume	(	sonido	objeto,
		int	volumenL,
		int	volumenR
	)

Establece el volumen de un sonido, canales por separado.

Parámetros:

	objeto	Objeto de sonido.
	volumenL	Volumen canal izquierdo. Un número. Entre 0 y 199.
	volumenR	Volumen canal derecho. Un número. Entre 0 y 199.

Devuelve:

Nada.

nil sound.stop

(

sonido

objeto

)

Detiene un objeto de sonido.

Parámetros:

objeto

Objeto de sonido a detener.

Devuelve:

Nada.

nil sound.free

(

sonido

objeto

)

Libera un objeto de sonido.

Parámetros:

objeto

Objeto de sonido a liberar.

Devuelve:

Nada.

boolean sound.playing

(

sonido

objeto

)

Devuelve si un sonido se está reproduciendo o no.

Parámetros:

objeto

Objeto de sonido.

Devuelve:

True si está reproduciendo, false en caso contrario.

nil sound.loop

(

)

Detiene el sonido en modo loop.

Devuelve:

Nada.

nil sound.loop

(

string

ruta

)

Reproduce un archivo en modo loop.

Parámetros:

ruta

La ruta del archivo a reproducir como loop.

Devuelve:

Nada.

table sound.id3

(

string

ruta

)

Información ID3 (Sólo MP3).

Parámetros:

ruta

La ruta del archivo MP3.

Devuelve:

Una tabla, con los siguientes campos:

• title (string)
• artist (string)
• album (string)
• year (string)
• comment (string)
• genrecode (string)
• genre (string)
• track (string)
• tracknumber (number)
• length (number) (en segundos)
• cover (boolean) (si tiene o no imagen)
• imagetype (string) [ "JPG" \ "PNG" ]

imagen sound.cover

(

string

ruta

)

Carátula ID3 (Sólo MP3).

Parámetros:

ruta

La ruta del archivo MP3.

Devuelve:

Una imagen si existe, o nil.

number sound.position

(

sonido

objeto

)

Posición de un sonido. (Sólo MP3, [en desarrollo los otros formatos]).

Parámetros:

objeto

Objeto de sonido.

Devuelve:

Un número. Indicando la posición en segundos.

number sound.duration

(

sonido

objeto

)

Duración de un sonido. (Sólo MP3, [en desarrollo los otros formatos]).

Parámetros:

objeto

Objeto de sonido.

Devuelve:

Un número. Indicando la duración en segundos.

number sound.percent

(

sonido

objeto

)

Devuelve el porcentaje reproducido de un sonido.

Parámetros:

objeto

Objeto de sonido.

Devuelve:

Un número. Indicando el porcentaje.

nil sound.percent	(	sonido	objeto,
		number	percent
	)

Setea el porcentaje reproducido de un sonido (Cambia la posición).

Parámetros:

	objeto	Objeto de sonido.
	percent	Un número. Indicando el porcentaje.

Devuelve:

Nada.

tabla sound.vis

(

sonido

objeto

)

Interfaz interno al visualizador.

Parámetros:

objeto

Objeto de sonido.

Devuelve:

Una tabla, con los valores de la forma de onda en ese preciso instante.

tabla sound.fft

(

sonido

objeto

)

Interfaz interno al FFT (Fast Fourier Tranform).

Parámetros:

objeto

Objeto de sonido.

Devuelve:

Una tabla, con los valores de potencias separados en frecuencias. (16 rangos).

tabla sound.blit	(	sonido	objeto,
		string	tipo,
		number	x,
		number	y,
		number	w,
		number	h,
		color	base
	)

Dibuja una forma de onda o espectómetro (barritas del winamp).

Parámetros:

	objeto	Objeto de sonido.
	tipo	Uno de los siguientes: "wave" - Forma de onda (tipo KIT, de el coche fantástico) "waveline" - Forma de onda (sólo la línea, tipo Winamp) "spectrum_lines" - Espectómetro.
	x	Posición X.
	y	Posición Y.
	w	Ancho en píxels.
	h	Alto en píxels.
	base	Color de la forma de onda o espectómetro.

Devuelve:

Nada.

tabla sound.blit	(	sonido	objeto,
		string	tipo,
		number	x,
		number	y,
		number	w,
		number	h,
		color	arriba,
		color	abajo,
		color	pico
	)

Dibuja un espectómetro, pero con gradientes.

Parámetros:

	objeto	Objeto de sonido.
	tipo	Uno de los siguientes: "spectrum_gradlines" - Forma de onda (tipo KIT, de el coche fantástico)
	x	Posición X.
	y	Posición Y.
	w	Ancho en píxels.
	h	Alto en píxels.
	arriba	Color de la barra arriba.
	abajo	Color de la barra abajo.
	pico	Color del pico.

Devuelve:

Nada.

tabla sound.blit	(	sonido	objeto,
		string	tipo,
		number	x,
		number	y,
		number	w,
		number	h,
		color	fondo_arriba,
		color	fondo_abajo,
		color	barra_arriba,
		color	barra_abajo,
		color	pico,
		number	espaciado
	)

Dibuja un espectómetro de barras. (Estilo Winamp).

Parámetros:

	objeto	Objeto de sonido.
	tipo	Uno de los siguientes: "spectrum_bars" - Forma de onda (tipo KIT, de el coche fantástico)
	x	Posición X.
	y	Posición Y.
	w	Ancho en píxels.
	h	Alto en píxels.
	fondo_arriba	Color de la barra del fondo arriba.
	fondo_abajo	Color de la barra del fondo abajo.
	barra_arriba	Color de la barra arriba.
	barra_abajo	Color de la barra abajo.
	pico	Color del pico.
	espaciado	Espaciado vertical (para crear cuadritos).

Devuelve:

Nada.