Audio Library


Data Structures

struct  pgeAudioLibChannelInfo

Defines

#define PGE_NUM_AUDIO_CHANNELS   4
#define PGE_NUM_AUDIO_SAMPLES   1024
#define PGE_VOLUME_MAX   0x8000

Typedefs

typedef void(*) pgeAudioLibCallback (void *buf, unsigned int reqn, void *pdata)

Functions

int pgeAudioLibInit (int priority)
void pgeAudioLibShutdown ()
void pgeAudioLibSetVolume (int channel, int left, int right)
void pgeAudioLibSetChannelCallback (int channel, pgeAudioLibCallback callback, void *data)
int pgeAudioLibOutBlocking (unsigned int channel, unsigned int left, unsigned int right, void *data)

Define Documentation

#define PGE_NUM_AUDIO_CHANNELS   4

#define PGE_NUM_AUDIO_SAMPLES   1024

#define PGE_VOLUME_MAX   0x8000


Typedef Documentation

typedef void(* ) pgeAudioLibCallback(void *buf, unsigned int reqn, void *pdata)

Audio callback


Function Documentation

int pgeAudioLibInit ( int  priority  ) 

Initialise the Audio Library

Parameters:
priority - Priority to use for the audio threads.
Returns:
1 on success.

int pgeAudioLibOutBlocking ( unsigned int  channel,
unsigned int  left,
unsigned int  right,
void *  data 
)

Panned Output

Parameters:
channel - The audio channel.
left - Left volume.
right - Right volume.
data - The data to pass.
Returns:
< 0 on error

void pgeAudioLibSetChannelCallback ( int  channel,
pgeAudioLibCallback  callback,
void *  data 
)

Setup an audio callback

Parameters:
channel - The audio channel.
callback - The callback function.
data - The data to pass.

void pgeAudioLibSetVolume ( int  channel,
int  left,
int  right 
)

Set channel volume

Parameters:
channel - The audio channel.
left - Left volume.
right - Right volume.

void pgeAudioLibShutdown (  ) 

Shutdown the Audio Library


Generated on Tue May 15 07:21:01 2007 for Phoenix Game Engine by  doxygen 1.5.2