Referencia de la Clase Yukino::Sound

Clase para almacenar un sonido. Más...

#include <Sound.h>

Lista de todos los miembros.

Métodos públicos

 Sound ()
 Constructor de la clase Sound.
 Sound (const char *file)
 Constructor de la clase Sound.
 Sound (const string &file)
 Constructor de la clase Sound.
 Sound (const Sound &obj)
 Constructor copia de la clase Sound.
Soundoperator= (Sound &obj)
 Operador = de la clase Sound.
 ~Sound ()
 Destructor de la clase Sound.
UINT Load (const char *file)
 Función para cargar un sonido de un fichero.
UINT Load (const string &file)
 Función para cargar un sonido de un fichero.
void Free (void)
 Función para liberar los datos del objeto Sound.
UINT SetVolume (int vol)
 Función para cambiar el volumen actual del sonido.
int GetVolume (void) const
 Función para obtener el volumen actual del sonido.
int GetChannel (void) const
 Función para obtener el canal actual del sonido.


Descripción detallada

Clase para almacenar un sonido.

La clase Sound sirve para almacenar en memoria un sonido contenido en un fichero. Este puede ser un fichero WAV u OGG. Y se puede manipular el volumen de este.


Documentación del constructor y destructor

Yukino::Sound::Sound (  ) 

Constructor de la clase Sound.

Constructor por defecto de la clase Sound.

Ver también:
operator=(), ~Sound().

Yukino::Sound::Sound ( const char *  file  ) 

Constructor de la clase Sound.

Constructor de la clase Sound, que carga un fichero.

Parámetros:
file Ruta del fichero.
Ver también:
operator=(), ~Sound().

Yukino::Sound::Sound ( const string &  file  ) 

Constructor de la clase Sound.

Constructor de la clase Sound, que carga un fichero.

Parámetros:
file Ruta del fichero.
Ver también:
operator=(), ~Sound().

Yukino::Sound::Sound ( const Sound obj  ) 

Constructor copia de la clase Sound.

Parámetros:
obj Objeto Sound a copiar.
Ver también:
operator=(), ~Sound().

Yukino::Sound::~Sound (  ) 

Destructor de la clase Sound.

Ver también:
Sound(), operator=().


Documentación de las funciones miembro

void Yukino::Sound::Free ( void   ) 

Función para liberar los datos del objeto Sound.

Esta función sirve para liberar el contenido del objeto Sound.

Ver también:
Load().

int Yukino::Sound::GetChannel ( void   )  const [inline]

Función para obtener el canal actual del sonido.

Esta función sirve para obtener el canal actual del sonido.

Devuelve:
El canal actual.

int Yukino::Sound::GetVolume ( void   )  const [inline]

Función para obtener el volumen actual del sonido.

Esta función sirve para obtener el volumen actual del sonido.

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

UINT Yukino::Sound::Load ( const string &  file  )  [inline]

Función para cargar un sonido de un fichero.

Esta función sirve para cargar un sonido de un fichero.

Parámetros:
file Ruta del fichero.
Ver también:
Free().
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: SOUND_ERROR_LOAD.

UINT Yukino::Sound::Load ( const char *  file  ) 

Función para cargar un sonido de un fichero.

Esta función sirve para cargar un sonido de un fichero.

Parámetros:
file Ruta del fichero.
Ver también:
Free().
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: SOUND_ERROR_LOAD.

Sound & Yukino::Sound::operator= ( Sound obj  ) 

Operador = de la clase Sound.

Copia el objeto obj en el objeto actual, y este es devuelto.

Ver también:
Sound(), ~Sound().

UINT Yukino::Sound::SetVolume ( int  vol  ) 

Función para cambiar el volumen actual del sonido.

Esta función sirve para cambiar el volumen actual del sonido.

Parámetros:
vol Volumen del sonido.
Ver también:
GetVolume().
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: SOUND_ERROR_SETVOLUME.


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