MezzanineEngine 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Classes | Enumerations
Mezzanine::Audio Namespace Reference

This namespace is for all the classes belonging to the Audio Subsystem. More...

Classes

class  AudioManager
 This is the base manager class for the Audio subsystem and it's operations. More...
 
struct  AutowahParameters
 This is a struct containing all the parameters needed to describe an Auto-Wah effect. More...
 
struct  ChorusParameters
 This is a struct containing all the parameters needed to describe a Chorus effect. More...
 
struct  CompressorParameters
 This is a struct containing all the parameters needed to describe a compressor effect. More...
 
struct  DistortionParameters
 This is a struct containing all the parameters needed to describe a Distortion effect. More...
 
struct  EAXReverbParameters
 This is a struct containing all the parameters needed to describe an EAX Reverb effect. More...
 
struct  EchoParameters
 This is a struct containing all the parameters needed to describe an echo effect. More...
 
struct  EqualizerParameters
 This is a struct containing all the parameters needed to describe an equalizer effect. More...
 
struct  FlangerParameters
 This is a struct containing all the parameters needed to describe an flanger effect. More...
 
struct  FrequencyShiftParameters
 This is a struct containing all the parameters needed to describe a frequency shift effect. More...
 
class  iBufferUpdate2DWorkUnit
 This is the work unit for updating audio buffers as necessary for audio playback. More...
 
class  iBufferUpdate3DWorkUnit
 This is the work unit for updating audio buffers as necessary for audio playback. More...
 
class  iDecoder
 This is an interface class for the decoding of audio from a stream. More...
 
class  iDecoderFactory
 This is an interface class for factories that create decoders. More...
 
class  iEffect
 This is an interface class for an effect that can be applied to a sound. More...
 
class  iEffectFilterCleanWorkUnit
 This is the work unit for marking all effects and filters as clean after sounds have been processed. More...
 
class  iEffectsHandler
 This is an interface class for the creation, destruction, and overall management of audio effects. More...
 
class  iFilter
 This is an interface class for the application of filters to audio playback. More...
 
class  iListener
 This is an interface class for a listener (such as a player) in the 3D audio world. More...
 
class  iRecorder
 This is an interface class for the recording of audio. More...
 
class  iSound
 This is an interface class for a non-spacialized sound. More...
 
class  MusicPlayer
 This is a convenience class for the playing of music in a game. More...
 
struct  PitchShifterParameters
 This is a struct containing all the parameters needed to describe a pitch shift effect. More...
 
class  Playlist
 This class is a list of sounds with common playlist features. More...
 
struct  ReverbParameters
 This is a struct containing all the parameters needed to describe a Reverb effect. More...
 
struct  RingModulatorParameters
 This is a struct containing all the parameters needed to describe a ring modulation effect. More...
 
class  SoundProxy
 This is a proxy class for representing a sound being played in 3D space. More...
 
class  SoundScapeManager
 This is the base manager class for audio being played in a 3D environment. More...
 
class  SoundSet
 This is a vector that stores sounds. More...
 
struct  VocalMorpherParameters
 This is a struct containing all the parameters needed to describe a vocal morpher effect. More...
 

Enumerations

enum  BitConfig {
  BC_8Bit_Mono = 1, BC_8Bit_Stereo, BC_16Bit_Mono, BC_16Bit_Stereo,
  BC_24Bit_Mono, BC_24Bit_Stereo
}
 Used to describe the different bit configurations supported by this audio system.
 
enum  EffectType {
  ET_Null, ET_EAX_Reverb, ET_Reverb, ET_Chorus,
  ET_Distortion, ET_Echo, ET_Flanger, ET_Frequency_Shifter,
  ET_Vocal_Morpher, ET_Pitch_Shifter, ET_Ring_Modulator, ET_Autowah,
  ET_Compressor, ET_Equalizer
}
 Used by the iEffect class to describe what type of effect it is. More...
 
enum  Encoding {
  Enc_RAW = 1, Enc_WAV = 2, Enc_FLAC = 3, Enc_VORBIS = 4,
  Enc_MP3 = 5, Enc_SPEEX = 6, Enc_OPUS = 7
}
 The encoding to use when reading or writing an audio buffer. More...
 
enum  FilterType { FT_Null, FT_LowPass, FT_HighPass, FT_BandPass }
 Used by the iFilter class to describe what type of filter it is. More...
 
enum  SoundType { ST_Ambient = 1, ST_Dialog = 2, ST_Effect = 3, ST_Music = 4 }
 Used by the iSound class to describe what type of sound it is. More...
 

Detailed Description

This namespace is for all the classes belonging to the Audio Subsystem.

Our Audio subsystem is based on a heavily modified/forked version of cAudio, and as such uses a similiar structure of classes and interfaces.

Enumeration Type Documentation

Used by the iEffect class to describe what type of effect it is.

Enumerator
ET_Null 

Null type with no values.

ET_EAX_Reverb 

See EAXReverbParameters.

ET_Reverb 

See ReverbParameters.

ET_Chorus 

See ChorusParameters.

ET_Distortion 

See DistortionParameters.

ET_Echo 

See EchoParameters.

ET_Flanger 

See FlangerParameters.

ET_Frequency_Shifter 

See FrequencyShifterParameters.

ET_Vocal_Morpher 

See VocalMorpherParameters.

ET_Pitch_Shifter 

See PitchShifterParameters.

ET_Ring_Modulator 

See RingModulatorParameters.

ET_Autowah 

See AutowahParameters.

ET_Compressor 

See CompressorParameters.

ET_Equalizer 

See RqualizerParameters.

Definition at line 77 of file audioenumerations.h.

The encoding to use when reading or writing an audio buffer.

Enumerator
Enc_RAW 

Unknown or error condition.

Enc_WAV 

Used in .wav files.

Enc_FLAC 

Used in .flac files.

Enc_VORBIS 

Used in .ogg files.

Enc_MP3 

Used in .mp3 files.

Enc_SPEEX 

Used in .spx files.

Enc_OPUS 

Used in .opus files.

Definition at line 64 of file audioenumerations.h.

Used by the iFilter class to describe what type of filter it is.

Enumerator
FT_Null 

Null type with no values.

FT_LowPass 

Filters out high frequency audio from a sound beyond a certain threshold.

FT_HighPass 

Filters out low frequency audio from a sound below a certain threshold.

FT_BandPass 

Filters out both high and low frequency audio from a sound outside of specified thresholds.

Definition at line 97 of file audioenumerations.h.

Used by the iSound class to describe what type of sound it is.

Enumerator
ST_Ambient 

Environmental sounds. Bird's chirping, water washing against rocks, etc.

ST_Dialog 

Character sounds and speech.

ST_Effect 

Various effects such as objects colliding, explosions, guns firing, etc.

ST_Music 

Self explanitory. The game SoundTrack.

Definition at line 107 of file audioenumerations.h.