sdl2dll
Loading...
Searching...
No Matches
sdl::Music Class Reference

Clase para cargar y reproducir archivos de audio con música. More...

#include <sdl_music.h>

Public Member Functions

 Music ()
 Constructor por defecto.
 
 Music (const char *file)
 Constructor que carga un archivo de audio.
 
 ~Music ()
 Destructor.
 
void Load (const char *file)
 Carga un fichero de audio.
 
void Play (int loops)
 Reproduce el audio.
 
int Volume (int volume)
 Establece el volumen de reproducción.
 
void Pause ()
 Detiene la reproducción de la música.
 
void Resume ()
 Reanuda la reproducción de la música previamente pausada.
 
bool Paused ()
 Consulta si un canal determinado está en pausa.
 
void Halt ()
 Detiene la reproducción de la música.
 
int FadeIn (int loops=0, int ms=1000)
 Reproduce un nuevo objeto musical, incrementando el volumen del audio.
 
int FadeInPos (int loops=0, int ms=1000, double pos=0.0)
 Reproduce un nuevo objeto musical, incrementando el volumen del audio, desde una posición inicial.
 
int FadeOut (int ms)
 Detiene el flujo de música después de desvanecerlo durante un tiempo especificado.
 
Mix_Fading Fading ()
 Consulta el estado de desvanecimiento del flujo musical.
 

Protected Attributes

Mix_Music * music
 

Detailed Description

Clase para cargar y reproducir archivos de audio con música.

Constructor & Destructor Documentation

◆ Music()

sdl::Music::Music ( const char * file)
inline

Constructor que carga un archivo de audio.

Parameters
filechar* ruta del fichero a cargar

◆ ~Music()

sdl::Music::~Music ( )
inline

Destructor.

Libera la memoria asociada al fichero de música.

Member Function Documentation

◆ FadeIn()

int sdl::Music::FadeIn ( int loops = 0,
int ms = 1000 )
inline

Reproduce un nuevo objeto musical, incrementando el volumen del audio.

Parameters
loopsint El número de veces que la música debe reproducirse en bucle, -1 para reproducirlo (no realmente) infinitamente.
msint El número de milisegundos de fundido de entrada.
Returns
int 0 si tiene éxito, -1 en caso de error

◆ FadeInPos()

int sdl::Music::FadeInPos ( int loops = 0,
int ms = 1000,
double pos = 0.0 )
inline

Reproduce un nuevo objeto musical, incrementando el volumen del audio, desde una posición inicial.

Parameters
loopsint El número de veces que la música debe reproducirse en bucle, -1 para reproducirlo (no realmente) infinitamente.
msint El número de milisegundos de fundido de entrada.
posdouble La posición inicial dentro de la música, en segundos, donde debe comenzar la reproducción.
Returns
int 0 si tiene éxito, -1 en caso de error

◆ FadeOut()

int sdl::Music::FadeOut ( int ms)
inline

Detiene el flujo de música después de desvanecerlo durante un tiempo especificado.

Parameters
msint Número de milisegundos de fundido antes de detener el canal.
Returns
int Devuelve un valor distinto de cero si la música estaba programada para desvanecerse, cero en caso contrario. Si no se está reproduciendo música, devuelve cero.

◆ Fading()

Mix_Fading sdl::Music::Fading ( )
inline

Consulta el estado de desvanecimiento del flujo musical.

Returns
Mix_Fading Devuelve el estado actual de desvanecimiento del flujo musical: MIX_NO_FADING, MIX_FADING_OUT o MIX_FADING_IN

◆ Halt()

void sdl::Music::Halt ( )
inline

Detiene la reproducción de la música.

Esta función es la complementaria de Play, y no equivale a Pause.

◆ Load()

void sdl::Music::Load ( const char * file)
inline

Carga un fichero de audio.

Si ya se había cargado un fichero previamente, libera el objeto antes de cargar el nuevo.

Parameters
filechar* ruta del fichero a cargar

◆ Paused()

bool sdl::Music::Paused ( )
inline

Consulta si un canal determinado está en pausa.

Returns
bool verdadero si la reproducción está pausada

◆ Play()

void sdl::Music::Play ( int loops)
inline

Reproduce el audio.

Parameters
loopsint número de veces que se reproducirá. 0 para rsproducir una vez.

◆ Volume()

int sdl::Music::Volume ( int volume)
inline

Establece el volumen de reproducción.

Parameters
volumeint valor del volumen entre 0 y MIX_MAX_VOLUME (128)
Returns
int

Member Data Documentation

◆ music

Mix_Music* sdl::Music::music
protected

El formato interno de un fragmento de música interpretado a través de códecs


The documentation for this class was generated from the following file: