Métodos públicos | Métodos públicos estáticos | Métodos protegidos

Referencia de la Clase Song

Recurso que representa a los ficheros de audio .mp3 u .ogg. Más...

#include <song.h>

Lista de todos los miembros.

Métodos públicos

 Song (Ogre::ResourceManager *creator, const Ogre::String &name, Ogre::ResourceHandle handle, const Ogre::String &group, bool isManual=false, Ogre::ManualResourceLoader *loader=0)
 ~Song ()
void play (int loop=-1)
void pause ()
void stop ()
void fadeIn (int ms, int loop=-1)
void fadeOut (int ms)

Métodos públicos estáticos

static bool isPlaying ()

Métodos protegidos

void loadImpl ()
void unloadImpl ()
size_t calculateSize () const

Descripción detallada

Recurso que representa a los ficheros de audio .mp3 u .ogg.

Autor:
David Saltares Márquez
Fecha:
28-12-2010

La clase Song es un tipo de Recurso utilizado para reproducir y manejar ficheros de audio tipo .mp3 u .ogg. Para efectos de sonido acude a la clase Sound.

Para acceder a un recurso de este tipo se utiliza la clase SongManager. Lo usual es obtener un objeto SongPtr a través de SongManager.


Documentación del constructor y destructor

Song::Song ( Ogre::ResourceManager *  creator,
const Ogre::String &  name,
Ogre::ResourceHandle  handle,
const Ogre::String &  group,
bool  isManual = false,
Ogre::ManualResourceLoader *  loader = 0 
)

Constructor

Parámetros:
creator gestor de recursos que crea la música.
name nombre que identifica al recurso.
handle identificador que permite un acceso más rápido al recurso.
group grupo de recursos al que pertenece el recurso.
isManual si su valor es true indica que el recurso está siendo creado mediante un Ogre::ManualResourceLoader
loader Ogre::ManualResourceLoader encargado de crear el recurso.

Crea pero no carga el recurso.

Song::~Song (  ) 

Destruye el recurso y libera la memoria ocupada


Documentación de las funciones miembro

size_t Song::calculateSize (  )  const [protected]
Devuelve:
espacio en memoria que ocupa el objeto.
void Song::fadeIn ( int  ms,
int  loop = -1 
)
Parámetros:
ms milisegundos que dura el efecto de suavizado
loop número de veces que se reproduce la música. Por defecto es -1 (bucle infinito).

Es semejante a Song::play() pero aplica un efecto de suavizado a la entrada. La música va aumentando de volumen hasta llegar a su estado normal.

void Song::fadeOut ( int  ms  ) 
Parámetros:
ms milisegundos que dura el efecto de suavizado

Es semejante a Song::stop() pero aplica un efecto de suavizado a la salida. La música va disminuyendo su volumen hasta que se para.

bool Song::isPlaying (  )  [static]
Devuelve:
true si existe alguna música en reproducción, false en caso contrario.
void Song::loadImpl (  )  [protected]

Carga el fichero de audio.

void Song::pause (  ) 

Pausa la música.

void Song::play ( int  loop = -1  ) 
Parámetros:
loop indica el número de veces que debe repetirse la música. Por defecto es -1 (bucle infinito).

Reproduce la música y detiene la que esté actualmente en reproducción (si hay alguna). Si la música estaba en pausa, la retoma por donde estaba.

void Song::stop (  ) 

Para la música. La próxima vez que se reproduzca, comenzará desde el principio.

void Song::unloadImpl (  )  [protected]

Libera la memoria ocupada por el audio.


La documentación para esta clase fue generada a partir de los siguientes ficheros: