hx3d  1
2D/3D Simple Game Framework
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | Static Public Attributes | List of all members
hx3d::audio::AudioDevice Class Reference

Audio device management. More...

#include <audio.hpp>

Public Member Functions

void registerEffect (const int channel, Effect &effect)
 Register an effect on a channel. More...
 
void clearEffects (const int channel)
 Clear all the effects for a channel. More...
 
unsigned int getFrequencyRate ()
 Get the audio device frequency rate. More...
 
unsigned int getSampleSize ()
 Get the audio device sample size. More...
 

Static Public Attributes

static int PostChannel = MIX_CHANNEL_POST
 Post Channel Identifier.
 

Detailed Description

Audio device management.

Permit to register and clear effects.

Definition at line 40 of file audio.hpp.

Member Function Documentation

void hx3d::audio::AudioDevice::clearEffects ( const int  channel)

Clear all the effects for a channel.

Use Audio::PostChannel to put on the post channel.

Parameters
channelChannel

Definition at line 86 of file audio.cpp.

unsigned int hx3d::audio::AudioDevice::getFrequencyRate ( )

Get the audio device frequency rate.

Returns
Frequency rate

Definition at line 90 of file audio.cpp.

unsigned int hx3d::audio::AudioDevice::getSampleSize ( )

Get the audio device sample size.

It is used for WAV chunk loading.

Returns
Sample size

Definition at line 94 of file audio.cpp.

void hx3d::audio::AudioDevice::registerEffect ( const int  channel,
Effect effect 
)

Register an effect on a channel.

Use Audio::PostChannel to put on the post channel.

Parameters
channelChannel
effectEffect

Definition at line 73 of file audio.cpp.


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