Referencia de la Clase Yukino::Audio

Clase que gestiona el sistema de audio. Más...

#include <Audio.h>

Lista de todos los miembros.

Métodos públicos

UINT Init (int frequency, word format, int channels, int chunksize)
 Función para inicializar el objeto Audio.
void Release (void)
 Función para finalizar el objeto Audio.
UINT SetNumChannels (int channels)
 Función para cambiar el número de canales del audio.
int GetNumChannels (void)
 Función para obtener el número de canales del audio.
word GetFormat (void)
 Función para obtener el formato del audio.
int GetFrequency (void)
 Función para obtener la frecuencia del audio.
UINT SetVolume (int volume)
 Función para cambiar el volumen del audio.
int GetVolume (void)
 Función para obtener el volumen del audio.
UINT SetChannelVolume (int channel, int volume)
 Función para cambiar el volumen de un canal.
int GetChannelVolume (int channel)
 Función para obtener el volumen de un canal.
UINT SetChannelPan (int channel, byte left, byte right)
 Función para cambiar el panning de un canal.
UINT DelChannelPan (int channel)
 Función para borrar el panning de un canal.
UINT PlaySound (Sound &snd, int loops=PLAY_ONCE)
 Función para reproducir un sonido en un canal.
UINT PlaySound (Sound &snd, int channel, int loops)
 Función para reproducir un sonido en un canal.
UINT FadeInSound (Sound &snd, int ms, int loops=PLAY_ONCE)
 Función para reproducir un sonido en un canal con fade in.
UINT FadeInSound (Sound &snd, int ms, int channel, int loops)
 Función para reproducir un sonido en un canal con fade in.
void PauseSound (Sound &snd)
 Función para pausar un sonido de un canal.
void PauseChannel (int channel)
 Función para pausar un canal.
void PauseAudio (void)
 Función para pausar el audio.
void ResumeSound (Sound &snd)
 Función para resumir un sonido de un canal.
void ResumeChannel (int channel)
 Función para resumir un canal.
void ResumeAudio (void)
 Función para resumir el audio.
void StopSound (Sound &snd)
 Función para parar un sonido de un canal.
void StopChannel (int channel)
 Función para parar un canal.
void StopAudio (void)
 Función para parar el audio.
void FadeOutSound (Sound &snd, int ms)
 Función para parar un sonido de un canal con fade out.
void FadeOutChannel (int channel, int ms)
 Función para parar un canal con fade out.
void FadeOutAudio (int ms)
 Función para parar el audio con fade out.
bool IsPlayingSound (Sound &snd)
 Función para preguntar si un sonido está reproduciendose.
bool IsPlayingChannel (int channel)
 Función para preguntar si un canal está reproduciendose.
bool IsPausedSound (Sound &snd)
 Función para preguntar si un sonido está pausado.
bool IsPausedChannel (int channel)
 Función para preguntar si un canal está pausado.

Métodos públicos estáticos

static AudioGetInstance (void)
 Función para obtener la instancia de Audio.


Descripción detallada

Clase que gestiona el sistema de audio.

La clase Audio gestiona los temas relacionados con el sistema de audio, tales como manejar los canales de la aplicación. Pudiendo reproducir, pausar o parar sonidos en dichos canales, y otros efectos como el fade in y el fade out.


Documentación de las funciones miembro

UINT Yukino::Audio::DelChannelPan ( int  channel  ) 

Función para borrar el panning de un canal.

Esta función sirve para borrar el panning de un canal.

Parámetros:
channel Número de canal.
Ver también:
SetChannelPan().
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: AUDIO_ERROR_SETPAN.

UINT Yukino::Audio::FadeInSound ( Sound snd,
int  ms,
int  channel,
int  loops 
)

Función para reproducir un sonido en un canal con fade in.

Esta función sirve para reproducir un sonido en un canal con fade in.

Parámetros:
snd Sonido para reproducir.
ms Número de milisegundos para el fade in.
channel Número de canal.
loops Número de repeticiones.
Ver también:
PlaySound(), PauseSound(), ResumeSound(), StopSound(), FadeOutSound(), IsPlayingSound(), IsPausedSound().
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: AUDIO_ERROR_FADEINSOUND.

UINT Yukino::Audio::FadeInSound ( Sound snd,
int  ms,
int  loops = PLAY_ONCE 
)

Función para reproducir un sonido en un canal con fade in.

Esta función sirve para reproducir un sonido en un canal con fade in.

Parámetros:
snd Sonido para reproducir.
ms Número de milisegundos para el fade in.
loops Número de repeticiones.
Ver también:
PlaySound(), PauseSound(), ResumeSound(), StopSound(), FadeOutSound(), IsPlayingSound(), IsPausedSound().
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: AUDIO_ERROR_FADEINSOUND.

void Yukino::Audio::FadeOutAudio ( int  ms  )  [inline]

Función para parar el audio con fade out.

Esta función sirve para parar el audio con fade out.

Parámetros:
ms Número de milisegundos para el fade out.
Ver también:
PauseAudio(), ResumeAudio(), StopAudio().

void Yukino::Audio::FadeOutChannel ( int  channel,
int  ms 
) [inline]

Función para parar un canal con fade out.

Esta función sirve para parar un canal con fade out.

Parámetros:
channel Canal para parar.
ms Número de milisegundos para el fade out.
Ver también:
PauseChannel(), ResumeChannel(), StopChannel(), IsPlayingChannel(), IsPausedChannel().

void Yukino::Audio::FadeOutSound ( Sound snd,
int  ms 
) [inline]

Función para parar un sonido de un canal con fade out.

Esta función sirve para parar un sonido de un canal con fade out.

Parámetros:
snd Sonido para parar.
ms Número de milisegundos para el fade out.
Ver también:
PlaySound(), FadeInSound(), PauseSound(), ResumeSound(), StopSound(), IsPlayingSound(), IsPausedSound().

int Yukino::Audio::GetChannelVolume ( int  channel  )  [inline]

Función para obtener el volumen de un canal.

Esta función sirve para obtener el volumen de un canal.

Parámetros:
channel Número de canal.
Ver también:
SetChannelVolume().
Devuelve:
El volumen de un canal.

word Yukino::Audio::GetFormat ( void   )  [inline]

Función para obtener el formato del audio.

Esta función sirve para obtener el formato del audio.

Devuelve:
El formato del audio.

int Yukino::Audio::GetFrequency ( void   )  [inline]

Función para obtener la frecuencia del audio.

Esta función sirve para obtener la frecuencia del audio.

Devuelve:
La frecuencia del audio.

Audio * Yukino::Audio::GetInstance ( void   )  [static]

Función para obtener la instancia de Audio.

Esta función crea una instancia de Audio, en caso de no estar creada, y devuelve un puntero a esta si tiene exito pidiendo memoria.

Devuelve:
Devuelve un puntero al objeto Audio si todo ha ido bien, en caso de no haber memoria para el objeto devuelve NULL.

int Yukino::Audio::GetNumChannels ( void   )  [inline]

Función para obtener el número de canales del audio.

Esta función sirve para obtener el número de canales del audio.

Ver también:
SetNumChannels().
Devuelve:
El número de canales del audio.

int Yukino::Audio::GetVolume ( void   )  [inline]

Función para obtener el volumen del audio.

Esta función sirve para obtener el volumen del audio.

Ver también:
SetVolume().
Devuelve:
El volumen del audio.

UINT Yukino::Audio::Init ( int  frequency,
word  format,
int  channels,
int  chunksize 
)

Función para inicializar el objeto Audio.

Esta función sirve para inicializar el objeto Audio, pasándole la frecuencia, el formato, el número de canales y el tamaño del buffer.

Parámetros:
frequency Frecuencia del audio.
format Formato del audio.
channels Número de canales del audio.
chunksize Tamaño del buffer del audio.
Ver también:
Release().
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: AUDIO_ERROR_OPEN, AUDIO_ERROR_QUERYSPEC, AUDIO_ERROR_NOTEQU.

bool Yukino::Audio::IsPausedChannel ( int  channel  )  [inline]

Función para preguntar si un canal está pausado.

Esta función sirve para preguntar si un canal está pausado.

Parámetros:
channel Canal en cuestión.
Ver también:
PauseChannel(), ResumeChannel(), StopChannel(), FadeOutChannel(), IsPlayingChannel().
Devuelve:
Si devuelve true, es que éstá pausado.

bool Yukino::Audio::IsPausedSound ( Sound snd  )  [inline]

Función para preguntar si un sonido está pausado.

Esta función sirve para preguntar si un sonido está pausado.

Parámetros:
snd Sonido en cuestión.
Ver también:
PlaySound(), FadeInSound(), PauseSound(), ResumeSound(), StopSound(), FadeOutSound(), IsPlayingSound().
Devuelve:
Si devuelve true, es que éstá pausado.

bool Yukino::Audio::IsPlayingChannel ( int  channel  )  [inline]

Función para preguntar si un canal está reproduciendose.

Esta función sirve para preguntar si un canal está reproduciendose.

Parámetros:
channel Canal en cuestión.
Ver también:
PauseChannel(), ResumeChannel(), StopChannel(), FadeOutChannel(), IsPausedChannel().
Devuelve:
Si devuelve true, es que éstá siendo reproducido.

bool Yukino::Audio::IsPlayingSound ( Sound snd  )  [inline]

Función para preguntar si un sonido está reproduciendose.

Esta función sirve para preguntar si un sonido está reproduciendose.

Parámetros:
snd Sonido en cuestión.
Ver también:
PlaySound(), FadeInSound(), PauseSound(), ResumeSound(), StopSound(), FadeOutSound(), IsPausedSound().
Devuelve:
Si devuelve true, es que éstá siendo reproducido.

void Yukino::Audio::PauseAudio ( void   )  [inline]

Función para pausar el audio.

Esta función sirve para pausar el audio.

Ver también:
ResumeAudio(), StopAudio(), FadeOutAudio().

void Yukino::Audio::PauseChannel ( int  channel  )  [inline]

Función para pausar un canal.

Esta función sirve para pausar un canal.

Parámetros:
channel Canal para pausar.
Ver también:
ResumeChannel(), StopChannel(), FadeOutChannel(), IsPlayingChannel(), IsPausedChannel().

void Yukino::Audio::PauseSound ( Sound snd  )  [inline]

Función para pausar un sonido de un canal.

Esta función sirve para pausar un sonido de un canal.

Parámetros:
snd Sonido para pausar.
Ver también:
PlaySound(), FadeInSound(), ResumeSound(), StopSound(), FadeOutSound(), IsPlayingSound(), IsPausedSound().

UINT Yukino::Audio::PlaySound ( Sound snd,
int  channel,
int  loops 
)

Función para reproducir un sonido en un canal.

Esta función sirve para reproducir un sonido en un canal.

Parámetros:
snd Sonido para reproducir.
channel Número de canal.
loops Número de repeticiones.
Ver también:
FadeInSound(), PauseSound(), ResumeSound(), StopSound(), FadeOutSound(), IsPlayingSound(), IsPausedSound().
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: AUDIO_ERROR_PLAYSOUND.

UINT Yukino::Audio::PlaySound ( Sound snd,
int  loops = PLAY_ONCE 
)

Función para reproducir un sonido en un canal.

Esta función sirve para reproducir un sonido en un canal.

Parámetros:
snd Sonido para reproducir.
loops Número de repeticiones.
Ver también:
FadeInSound(), PauseSound(), ResumeSound(), StopSound(), FadeOutSound(), IsPlayingSound(), IsPausedSound().
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: AUDIO_ERROR_PLAYSOUND.

void Yukino::Audio::Release ( void   ) 

Función para finalizar el objeto Audio.

Esta función sirve para finalizar el objeto Audio.

Ver también:
Init().

void Yukino::Audio::ResumeAudio ( void   )  [inline]

Función para resumir el audio.

Esta función sirve para resumir el audio.

Ver también:
PauseAudio(), StopAudio(), FadeOutAudio().

void Yukino::Audio::ResumeChannel ( int  channel  )  [inline]

Función para resumir un canal.

Esta función sirve para resumir un canal.

Parámetros:
channel Canal para resumir.
Ver también:
PauseChannel(), StopChannel(), FadeOutChannel(), IsPlayingChannel(), IsPausedChannel().

void Yukino::Audio::ResumeSound ( Sound snd  )  [inline]

Función para resumir un sonido de un canal.

Esta función sirve para resumir un sonido de un canal.

Parámetros:
snd Sonido para resumir.
Ver también:
PlaySound(), FadeInSound(), PauseSound(), StopSound(), FadeOutSound(), IsPlayingSound(), IsPausedSound().

UINT Yukino::Audio::SetChannelPan ( int  channel,
byte  left,
byte  right 
)

Función para cambiar el panning de un canal.

Esta función sirve para cambiar el panning de un canal.

Parámetros:
channel Número de canal.
left Nivel en la izquierda.
right Nivel en la derecha.
Ver también:
DelChannelPan().
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: AUDIO_ERROR_SETPAN.

UINT Yukino::Audio::SetChannelVolume ( int  channel,
int  volume 
)

Función para cambiar el volumen de un canal.

Esta función sirve para cambiar el volumen de un canal.

Parámetros:
channel Número de canal.
volume Nuevo volumen.
Ver también:
GetChannelVolume().
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: AUDIO_ERROR_SETVOLUME.

UINT Yukino::Audio::SetNumChannels ( int  channels  ) 

Función para cambiar el número de canales del audio.

Esta función sirve para cambiar el número de canales del audio.

Parámetros:
channels Nuevo número de canales.
Ver también:
GetNumChannels().
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: AUDIO_ERROR_ALLOCATE.

UINT Yukino::Audio::SetVolume ( int  volume  ) 

Función para cambiar el volumen del audio.

Esta función sirve para cambiar el volumen del audio.

Parámetros:
volume Nuevo volumen.
Ver también:
GetVolume().
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: AUDIO_ERROR_SETVOLUME.

void Yukino::Audio::StopAudio ( void   )  [inline]

Función para parar el audio.

Esta función sirve para parar el audio.

Ver también:
PauseAudio(), ResumeAudio(), FadeOutAudio().

void Yukino::Audio::StopChannel ( int  channel  )  [inline]

Función para parar un canal.

Esta función sirve para parar un canal.

Parámetros:
channel Canal para parar.
Ver también:
PauseChannel(), ResumeChannel(), FadeOutChannel(), IsPlayingChannel(), IsPausedChannel().

void Yukino::Audio::StopSound ( Sound snd  )  [inline]

Función para parar un sonido de un canal.

Esta función sirve para parar un sonido de un canal.

Parámetros:
snd Sonido para parar.
Ver también:
PlaySound(), FadeInSound(), PauseSound(), ResumeSound(), FadeOutSound(), IsPlayingSound(), IsPausedSound().


La documentación para esta clase fué generada a partir de los siguientes archivos:
Generado el Sun Jun 25 03:44:44 2006 para Yukino por  doxygen 1.4.7