Funciones
SOUND	sound.load (STRING path)
	Carga un sonido para reproducirlo posteriormente. Más...

NIL	sound.play (SOUND snd)
	Reproduce un objeto tipo sound (en un canal libre). Más...

NIL	sound.play (SOUND snd, NUMBER channel)
	Reproduce un objeto tipo sound en el canal especificado. Más...

NIL	sound.loop (SOUND snd)
	Aplica/Quita el efecto loop a un objeto tipo sound. Más...

BOOLEAN	sound.looping (SOUND snd)
	Permite conocer si un objeto tipo sound esta en modo loop. Más...

NIL	sound.pause (SOUND snd)
	Pausa/Resumir un objeto tipo sound. Más...

NIL	sound.pause (SOUND snd, NUMBER mode)
	Pausa/Resumir un objeto tipo sound. Más...

BOOLEAN	sound.playing (SOUND snd)
	Permite conocer si un sonido está reproduciéndose. Más...

NIL	sound.stop (SOUND snd)
	Detiene un objeto tipo sound. Más...

BOOLEAN	sound.endstream (SOUND snd)
	Permite conocer si un sonido está finalizado. Más...

NUMBER	sound.vol (SOUND snd)
	Permite conocer el volumen de un sonido. Más...

NIL	sound.vol (SOUND snd, NUMBER porcent)
	Permite setear el volumen de un sonido. Más...

TABLE	sound.getid3 (STRING path)
	Información ID3 (Solo MP3). Más...

BOOLEAN	sound.extractcover (STRING mp3, STRING path)
	Permite extraer la imagen (COVER) de un MP3. Más...

TABLE	sound.vis (SOUND snd)
	Interfaz interno al visualizador de onda. Más...

Descripción detallada

Funciones relacionadas al sonido.

Documentación de las funciones

SOUND sound.load ( STRING path )

Carga un sonido para reproducirlo posteriormente.

Parámetros

path	Ruta del archivo a cargar (en formato mp3, s3m, bgm o wav).

Devuelve: Un objeto tipo sound, listo para reproducirse.

NIL sound.play ( SOUND snd )

Reproduce un objeto tipo sound (en un canal libre).

Parámetros

snd	Un objeto tipo sound.

Devuelve: Nada.

NIL sound.play	(	SOUND	snd,
		NUMBER	channel
	)

Reproduce un objeto tipo sound en el canal especificado.

Parámetros

snd	Un objeto tipo sound.
channel	Canal donde se va a reproducir (8 canales numerados del 1 al 8).

Devuelve: Nada.

NIL sound.loop ( SOUND snd )

Aplica/Quita el efecto loop a un objeto tipo sound.

Parámetros

snd	Un objeto tipo sound.

Nota: Si tiene el efecto lo quita, de lo contrario lo aplica.

Devuelve: Nada.

BOOLEAN sound.looping ( SOUND snd )

Permite conocer si un objeto tipo sound esta en modo loop.

Parámetros

snd	Un objeto tipo sound.

Devuelve: true si tiene el efecto, false de lo contrario.

NIL sound.pause ( SOUND snd )

Pausa/Resumir un objeto tipo sound.

Parámetros

snd	Un objeto tipo sound.

Devuelve: Nada.

NIL sound.pause	(	SOUND	snd,
		NUMBER	mode
	)

Pausa/Resumir un objeto tipo sound.

Parámetros

snd	Un objeto tipo sound.
mode	Tipo de pausa: -1 Si el objeto sound está pausado se resume, si no está en pausa es pausado. 0 Resume el objeto sound si está pausado. 1 Pausa el objeto sound si está reproduciéndose.

Devuelve: Nada.

BOOLEAN sound.playing ( SOUND snd )

Permite conocer si un sonido está reproduciéndose.

Parámetros

snd	Un objeto tipo sound.

Devuelve: True, si el objeto sound se está en estado "play", en caso contrario devolverá false.

NIL sound.stop ( SOUND snd )

Detiene un objeto tipo sound.

Parámetros

snd	Un objeto tipo sound.

Devuelve: Nada.

BOOLEAN sound.endstream ( SOUND snd )

Permite conocer si un sonido está finalizado.

Parámetros

snd	Un objeto tipo sound.

Nota: El estado finalizado, aplica si se acabo el sonido o si se hizo un stop.

Devuelve: True, si el objeto sound esta finalizado, en caso contrario devolverá false.

NUMBER sound.vol ( SOUND snd )

Permite conocer el volumen de un sonido.

Parámetros

snd	Un objeto tipo sound.

Devuelve: Un número con un valor del 0 - 100% del volumen del sonido.

NIL sound.vol	(	SOUND	snd,
		NUMBER	porcent
	)

Permite setear el volumen de un sonido.

Parámetros

snd	Un objeto tipo sound.
porcent	Un número con un valor del 0 - 100%

Devuelve: Nada.

TABLE sound.getid3 ( STRING path )

Información ID3 (Solo MP3).

Parámetros

path	Es la ruta al archivo MP3.

Devuelve

Una tabla con los siguientes campos:

title (STRING).
artist (STRING).
album (STRING).
year (STRING).
genre (STRING).
comment (STRING).
track (NUMBER).
version (STRING).
cover (IMAGE).

BOOLEAN sound.extractcover	(	STRING	mp3,
		STRING	path
	)

Permite extraer la imagen (COVER) de un MP3.

Parámetros

mp3	Es la ruta al archivo MP3.
path	Es la ruta donde se va a extraer la imagen "cover".

Devuelve: True, si la imagen "cover" se extrajo con exito, False en caso contrario.

TABLE sound.vis ( SOUND snd )

Interfaz interno al visualizador de onda.

Parámetros

snd	Un objeto tipo sound.

Devuelve: Una tabla de 256 campos númericos, con los valores de la forma de onda en ese preciso instante.