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

Encapsula un sonido. More...

#include <sdl_chunk.h>

Public Member Functions

 Chunk ()
 Constructor por defecto.
 
 Chunk (const char *file)
 Constructor.
 
 ~Chunk ()
 Destructor.
 
int Play (int ch=-1, int loops=0)
 Reproduce el sonido.
 
int MasterVolumen (int volumen)
 Valor del volumen maestro a establecer para todos los canales.
 
int Volumen (int volumen)
 Establece el volumen para la reproducción de sonidos en un canal.
 
void Pausa ()
 Detiene la reproducción de un sonido en el canal actual.
 
void Resume ()
 Restablece la reproducción del sonido en el canal actual.
 
bool Pausado ()
 Averigua si el sonido del canal actual está pausado.
 
int Halt ()
 Detiene el sonido en el canal actual.
 
int FadeIn (int loops=0, int ms=1000)
 Reproduce un nuevo objeto musical, incrementando el volumen del audio.
 
int FadeInTimed (int loops=0, int ms=1000, int ticks=-1)
 Reproduce un fragmento de audio en el canal actual, incrementando el volumen del audio, durante un tiempo máximo.
 
int FadeOut (int ms)
 Detiene el canal actual después de desvanecerlo durante un tiempo especificado.
 
Mix_Fading Fading ()
 Consulta el estado de desvanecimiento del canal actual.
 
int SetPosition (Sint16 angle, Uint8 distance)
 Establece la posición espacial de un canal.
 

Protected Attributes

Mix_Chunk * chunk
 
int channel
 

Detailed Description

Encapsula un sonido.

Constructor & Destructor Documentation

◆ Chunk()

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

Constructor.

Parameters
fileconst char* Fichero que contiene el sonido

◆ ~Chunk()

sdl::Chunk::~Chunk ( )
inline

Destructor.

Libera los recursos asociados al chunk

Member Function Documentation

◆ FadeIn()

int sdl::Chunk::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 sonido debe reproducirse en bucle, -1 para indefinidamente
msint El número de milisegundos de fundido de entrada.
Returns
int Devuelve cero en caso de éxito, -1 en caso de error.

◆ FadeInTimed()

int sdl::Chunk::FadeInTimed ( int loops = 0,
int ms = 1000,
int ticks = -1 )
inline

Reproduce un fragmento de audio en el canal actual, incrementando el volumen del audio, durante un tiempo máximo.

Parameters
loopsint El número de veces que sonido debe reproducirse en bucle, -1 para indefinidamente
msint El número de milisegundos de fundido de entrada.
ticksint El número máximo de milisegundos de este chunk a mezclar para la reproducción.
Returns
int Devuelve qué canal se utilizó para reproducir el sonido, o -1 si no se pudo reproducir el sonido.

◆ FadeOut()

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

Detiene el canal actual después de desvanecerlo durante un tiempo especificado.

Parameters
msint Número de milisegundos de fundido antes de detener el canal.
Returns
int Devuelve el número de canales programados para desvanecerse.

◆ Fading()

Mix_Fading sdl::Chunk::Fading ( )
inline

Consulta el estado de desvanecimiento del canal actual.

Returns
Mix_Fading Devuelve el estado actual de desvanecimiento del canal. MIX_NO_FADING, MIX_FADING_OUT o MIX_FADING_IN

◆ Halt()

int sdl::Chunk::Halt ( )
inline

Detiene el sonido en el canal actual.

Returns
int 0 si tiene éxito, -1 en caso de error

◆ MasterVolumen()

int sdl::Chunk::MasterVolumen ( int volumen)
inline

Valor del volumen maestro a establecer para todos los canales.

Parameters
volumenint Valor del volumen a establecer
Returns
int Volumen establecido

◆ Pausado()

bool sdl::Chunk::Pausado ( )
inline

Averigua si el sonido del canal actual está pausado.

Returns
bool true si el sonido está pausado

◆ Play()

int sdl::Chunk::Play ( int ch = -1,
int loops = 0 )
inline

Reproduce el sonido.

Parameters
chint Canal a utilizar, -1 para elegir uno libre
loopsint Número de repeticiones, 0 para repetir indefinidamente
Returns
int Devuelve el número del canal utilizado

◆ SetPosition()

int sdl::Chunk::SetPosition ( Sint16 angle,
Uint8 distance )
inline

Establece la posición espacial de un canal.

Parameters
angleSint16 Ángulo, en grados. El Norte es 0, y va en el sentido de las agujas del reloj.
distanceUint8 Distancia; 0 es el oyente, 255 es la distancia máxima.
Returns
Devuelve cero si hay error

◆ Volumen()

int sdl::Chunk::Volumen ( int volumen)
inline

Establece el volumen para la reproducción de sonidos en un canal.

Parameters
volumenint Valor del volumen a establecer
Returns
int Volumen establecido

Member Data Documentation

◆ channel

int sdl::Chunk::channel
protected

Canal de audio

◆ chunk

Mix_Chunk* sdl::Chunk::chunk
protected

Estructura encapsulada


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