OgreOggSound  1.26
OgreOggSound Namespace Reference

Classes

struct  ChunkHeader
 CHUNK header information. More...
 
struct  cSound
 Holds information about a create sound request. More...
 
struct  efxProperty
 Holds information about a EFX effect. More...
 
class  LocklessQueue
 LocklessQueue template: as provid3ed by Lf3THn4D. More...
 
class  OgreOggISound
 A single sound object. More...
 
class  OgreOggListener
 Listener object (Users ears) More...
 
class  OgreOggSoundFactory
 MovableFactory for creating Sound instances. More...
 
class  OgreOggSoundManager
 Sound Manager: Manages all sounds for an application. More...
 
class  OgreOggSoundPlugin
 Plugin instance for the MovableText. More...
 
class  OgreOggSoundRecord
 Captures audio data. More...
 
class  OgreOggStaticSound
 A single static buffer sound (OGG) More...
 
class  OgreOggStaticWavSound
 A single static buffer sound (WAV) More...
 
class  OgreOggStreamSound
 A single streaming sound (OGG) More...
 
class  OgreOggStreamWavSound
 A single streaming sound (WAV) More...
 
class  OOSCallback
 Callbacks for sound states. More...
 
class  OSSCallbackPointer
 Callback template. More...
 
struct  sharedAudioBuffer
 Holds information about a static shared audio buffer. More...
 
struct  SOggFile
 Structure describing an ogg stream. More...
 
struct  SoundAction
 Holds information about a sound action. More...
 
struct  WaveHeader
 WAVEFORMATEX header information. More...
 
struct  WAVEHEADER
 WAVE file header information. More...
 
struct  WavFormatData
 WAVEFORMATEXTENSIBLE sound information. More...
 
struct  wFormat
 WAVE file format structure. More...
 

Typedefs

typedef std::map< std::string, OgreOggISound * > SoundMap
 
typedef std::map< std::string, ALuint > EffectList
 
typedef std::map< ALenum, bool > FeatureList
 
typedef std::list< OgreOggISound * > ActiveList
 
typedef std::deque< ALuint > SourceList
 
typedef std::vector< ALuint > BufferList
 
typedef Ogre::SharedPtr< BufferListBufferListPtr
 
typedef std::map< std::string, sharedAudioBuffer * > SharedBufferList
 

Enumerations

enum  FadeControl { FC_NONE = 0x00, FC_PAUSE = 0x01, FC_STOP = 0x02 }
 Action to perform after a fade has completed. More...
 
enum  SoundState {
  SS_NONE, SS_PLAYING, SS_PAUSED, SS_STOPPED,
  SS_DESTROYED
}
 The current state of the sound. More...
 
enum  SOUND_ACTION {
  LQ_PLAY, LQ_STOP, LQ_PAUSE, LQ_LOAD,
  LQ_GLOBAL_PITCH, LQ_STOP_ALL, LQ_PAUSE_ALL, LQ_RESUME_ALL,
  LQ_REACTIVATE, LQ_DESTROY_TEMPORARY, LQ_ATTACH_EFX, LQ_DETACH_EFX,
  LQ_SET_EFX_PROPERTY
}
 Various sound commands. More...
 

Typedef Documentation

typedef std::vector<ALuint> OgreOggSound::BufferList
typedef std::map<std::string, ALuint> OgreOggSound::EffectList
typedef std::map<ALenum, bool> OgreOggSound::FeatureList
typedef std::map<std::string, sharedAudioBuffer*> OgreOggSound::SharedBufferList
typedef std::map<std::string, OgreOggISound*> OgreOggSound::SoundMap
typedef std::deque<ALuint> OgreOggSound::SourceList

Enumeration Type Documentation

Action to perform after a fade has completed.

Remarks
Use this to specify what to do on a sound after it has finished fading. i.e. after fading out pause.
Enumerator
FC_NONE 
FC_PAUSE 
FC_STOP 

Various sound commands.

Enumerator
LQ_PLAY 
LQ_STOP 
LQ_PAUSE 
LQ_LOAD 
LQ_GLOBAL_PITCH 
LQ_STOP_ALL 
LQ_PAUSE_ALL 
LQ_RESUME_ALL 
LQ_REACTIVATE 
LQ_DESTROY_TEMPORARY 
LQ_ATTACH_EFX 
LQ_DETACH_EFX 
LQ_SET_EFX_PROPERTY 

The current state of the sound.

Remarks
This is separate from what OpenAL thinks the current state of the sound is. A separate state is maintained in order to make sure the correct state is available when using multi-threaded sound streaming since the OpenAL sound is stopped and started multiple times while it is still technically in a "playing" state.
Enumerator
SS_NONE 
SS_PLAYING 
SS_PAUSED 
SS_STOPPED 
SS_DESTROYED