orxSoundSystem.h File Reference

#include "orxInclude.h"
#include "math/orxVector.h"
#include "plugin/orxPluginCore.h"

Go to the source code of this file.

Data Structures
struct	orxSOUND_FILTER_DATA

Macros
#define	orxSOUNDSYSTEM_KZ_CONFIG_CHANNELS   "Channels"
#define	orxSOUNDSYSTEM_KZ_CONFIG_LISTENERS   "Listeners"
#define	orxSOUNDSYSTEM_KZ_CONFIG_MUTE_IN_BACKGROUND   "MuteInBackground"
#define	orxSOUNDSYSTEM_KZ_CONFIG_RATIO   "DimensionRatio"
#define	orxSOUNDSYSTEM_KZ_CONFIG_SECTION   "SoundSystem"

Typedefs
typedef void(orxFASTCALL *	orxSOUND_FILTER_FUNCTION) (orxFLOAT *_afSampleListOut, const orxFLOAT *_afSampleListIn, orxU32 _u32SampleCount, orxU32 _u32ChannelCount, orxU32 _u32SampleRate, orxSTRINGID _stNameID, void *_pContext)
typedef struct __orxSOUNDSYSTEM_SAMPLE_t	orxSOUNDSYSTEM_SAMPLE
typedef struct __orxSOUNDSYSTEM_SOUND_t	orxSOUNDSYSTEM_SOUND

Enumerations
enum	orxSOUND_FILTER_TYPE {   orxSOUND_FILTER_TYPE_BIQUAD = 0 , orxSOUND_FILTER_TYPE_LOW_PASS , orxSOUND_FILTER_TYPE_HIGH_PASS , orxSOUND_FILTER_TYPE_BAND_PASS ,   orxSOUND_FILTER_TYPE_LOW_SHELF , orxSOUND_FILTER_TYPE_HIGH_SHELF , orxSOUND_FILTER_TYPE_NOTCH , orxSOUND_FILTER_TYPE_PEAKING ,   orxSOUND_FILTER_TYPE_DELAY , orxSOUND_FILTER_TYPE_CUSTOM , orxSOUND_FILTER_TYPE_NUMBER , orxSOUND_FILTER_TYPE_NONE = orxENUM_NONE }
enum	orxSOUNDSYSTEM_STATUS {   orxSOUNDSYSTEM_STATUS_PLAY = 0 , orxSOUNDSYSTEM_STATUS_PAUSE , orxSOUNDSYSTEM_STATUS_STOP , orxSOUNDSYSTEM_STATUS_NUMBER ,   orxSOUNDSYSTEM_STATUS_NONE = orxENUM_NONE }
enum	orxSOUNDSYSTEM_STREAM_TYPE {   orxSOUNDSYSTEM_STREAM_TYPE_EMPTY = 0 , orxSOUNDSYSTEM_STREAM_TYPE_WHITE , orxSOUNDSYSTEM_STREAM_TYPE_PINK , orxSOUNDSYSTEM_STREAM_TYPE_BROWNIAN ,   orxSOUNDSYSTEM_STREAM_TYPE_SINE , orxSOUNDSYSTEM_STREAM_TYPE_SQUARE , orxSOUNDSYSTEM_STREAM_TYPE_TRIANGLE , orxSOUNDSYSTEM_STREAM_TYPE_SAWTOOTH ,   orxSOUNDSYSTEM_STREAM_TYPE_RESOURCE , orxSOUNDSYSTEM_STREAM_TYPE_NUMBER , orxSOUNDSYSTEM_STREAM_TYPE_NONE = orxENUM_NONE }

Functions
orxDLLAPI orxSTATUS orxFASTCALL	orxSoundSystem_AddBusFilter (orxHANDLE _hBus, const orxSOUND_FILTER_DATA *_pstFilterData, orxBOOL _bUseCustomParam)
orxDLLAPI orxSTATUS orxFASTCALL	orxSoundSystem_AddFilter (orxSOUNDSYSTEM_SOUND *_pstSound, const orxSOUND_FILTER_DATA *_pstFilterData, orxBOOL _bUseCustomParam)
orxDLLAPI orxHANDLE orxFASTCALL	orxSoundSystem_CreateBus (orxSTRINGID _stBusID)
orxDLLAPI orxSOUNDSYSTEM_SOUND *orxFASTCALL	orxSoundSystem_CreateFromSample (orxHANDLE _hUserData, const orxSOUNDSYSTEM_SAMPLE *_pstSample)
orxDLLAPI orxSOUNDSYSTEM_SAMPLE *orxFASTCALL	orxSoundSystem_CreateSample (orxU32 _u32ChannelNumber, orxU32 _u32FrameNumber, orxU32 _u32SampleRate)
orxDLLAPI orxSOUNDSYSTEM_SOUND *orxFASTCALL	orxSoundSystem_CreateStream (orxHANDLE _hUserData, orxSOUNDSYSTEM_STREAM_TYPE _eType, orxU32 _u32ChannelNumber, orxU32 _u32SampleRate)
orxDLLAPI orxSTATUS orxFASTCALL	orxSoundSystem_Delete (orxSOUNDSYSTEM_SOUND *_pstSound)
orxDLLAPI orxSTATUS orxFASTCALL	orxSoundSystem_DeleteBus (orxHANDLE _hBus)
orxDLLAPI orxSTATUS orxFASTCALL	orxSoundSystem_DeleteSample (orxSOUNDSYSTEM_SAMPLE *_pstSample)
orxDLLAPI void orxFASTCALL	orxSoundSystem_EnableListener (orxU32 _u32ListenerIndex, orxBOOL _bEnable)
orxDLLAPI void orxFASTCALL	orxSoundSystem_Exit ()
orxDLLAPI orxFLOAT orxFASTCALL	orxSoundSystem_GetDuration (const orxSOUNDSYSTEM_SOUND *_pstSound)
orxDLLAPI orxFLOAT orxFASTCALL	orxSoundSystem_GetGlobalVolume ()
orxDLLAPI orxU32 orxFASTCALL	orxSoundSystem_GetListenerCount ()
orxDLLAPI orxVECTOR *orxFASTCALL	orxSoundSystem_GetListenerPosition (orxU32 _u32Index, orxVECTOR *_pvPosition)
orxDLLAPI orxSTATUS orxFASTCALL	orxSoundSystem_GetPanning (const orxSOUNDSYSTEM_SOUND *_pstSound, orxFLOAT *_pfPanning, orxBOOL *_pbMix)
orxDLLAPI orxFLOAT orxFASTCALL	orxSoundSystem_GetPitch (const orxSOUNDSYSTEM_SOUND *_pstSound)
orxDLLAPI orxVECTOR *orxFASTCALL	orxSoundSystem_GetPosition (const orxSOUNDSYSTEM_SOUND *_pstSound, orxVECTOR *_pvPosition)
orxDLLAPI orxSTATUS orxFASTCALL	orxSoundSystem_GetSampleInfo (const orxSOUNDSYSTEM_SAMPLE *_pstSample, orxU32 *_pu32ChannelNumber, orxU32 *_pu32FrameNumber, orxU32 *_pu32SampleRate)
orxDLLAPI orxSTATUS orxFASTCALL	orxSoundSystem_GetSpatialization (const orxSOUNDSYSTEM_SOUND *_pstSound, orxFLOAT *_pfMinDistance, orxFLOAT *_pfMaxDistance, orxFLOAT *_pfMinGain, orxFLOAT *_pfMaxGain, orxFLOAT *_pfRollOff)
orxDLLAPI orxSOUNDSYSTEM_STATUS orxFASTCALL	orxSoundSystem_GetStatus (const orxSOUNDSYSTEM_SOUND *_pstSound)
orxDLLAPI orxFLOAT orxFASTCALL	orxSoundSystem_GetTime (const orxSOUNDSYSTEM_SOUND *_pstSound)
orxDLLAPI orxFLOAT orxFASTCALL	orxSoundSystem_GetVolume (const orxSOUNDSYSTEM_SOUND *_pstSound)
orxDLLAPI orxBOOL orxFASTCALL	orxSoundSystem_HasRecordingSupport ()
orxDLLAPI orxSTATUS orxFASTCALL	orxSoundSystem_Init ()
orxDLLAPI orxBOOL orxFASTCALL	orxSoundSystem_IsListenerEnabled (orxU32 _u32ListenerIndex)
orxDLLAPI orxBOOL orxFASTCALL	orxSoundSystem_IsLooping (const orxSOUNDSYSTEM_SOUND *_pstSound)
orxDLLAPI orxSOUNDSYSTEM_SAMPLE *orxFASTCALL	orxSoundSystem_LoadSample (const orxSTRING _zFilename)
orxDLLAPI orxSOUNDSYSTEM_SOUND *orxFASTCALL	orxSoundSystem_LoadStream (orxHANDLE _hUserData, const orxSTRING _zFilename)
orxDLLAPI orxSTATUS orxFASTCALL	orxSoundSystem_Loop (orxSOUNDSYSTEM_SOUND *_pstSound, orxBOOL _bLoop)
orxDLLAPI orxSTATUS orxFASTCALL	orxSoundSystem_Pause (orxSOUNDSYSTEM_SOUND *_pstSound)
orxDLLAPI orxSTATUS orxFASTCALL	orxSoundSystem_Play (orxSOUNDSYSTEM_SOUND *_pstSound)
orxDLLAPI orxSTATUS orxFASTCALL	orxSoundSystem_RemoveAllBusFilters (orxHANDLE _hBus)
orxDLLAPI orxSTATUS orxFASTCALL	orxSoundSystem_RemoveAllFilters (orxSOUNDSYSTEM_SOUND *_pstSound)
orxDLLAPI orxSTATUS orxFASTCALL	orxSoundSystem_RemoveLastBusFilter (orxHANDLE _hBus)
orxDLLAPI orxSTATUS orxFASTCALL	orxSoundSystem_RemoveLastFilter (orxSOUNDSYSTEM_SOUND *_pstSound)
orxDLLAPI orxSTATUS orxFASTCALL	orxSoundSystem_SetBus (orxSOUNDSYSTEM_SOUND *_pstSound, orxHANDLE _hBus)
orxDLLAPI orxSTATUS orxFASTCALL	orxSoundSystem_SetBusParent (orxHANDLE _hBus, orxHANDLE _hParentBus)
orxDLLAPI orxSTATUS orxFASTCALL	orxSoundSystem_SetGlobalVolume (orxFLOAT _fGlobalVolume)
orxDLLAPI orxSTATUS orxFASTCALL	orxSoundSystem_SetListenerPosition (orxU32 _u32Index, const orxVECTOR *_pvPosition)
orxDLLAPI orxSTATUS orxFASTCALL	orxSoundSystem_SetPanning (orxSOUNDSYSTEM_SOUND *_pstSound, orxFLOAT _fPanning, orxBOOL _bMix)
orxDLLAPI orxSTATUS orxFASTCALL	orxSoundSystem_SetPitch (orxSOUNDSYSTEM_SOUND *_pstSound, orxFLOAT _fPitch)
orxDLLAPI orxSTATUS orxFASTCALL	orxSoundSystem_SetPosition (orxSOUNDSYSTEM_SOUND *_pstSound, const orxVECTOR *_pvPosition)
orxDLLAPI orxSTATUS orxFASTCALL	orxSoundSystem_SetSampleData (orxSOUNDSYSTEM_SAMPLE *_pstSample, const orxFLOAT *_afData, orxU32 _u32SampleNumber)
orxDLLAPI orxSTATUS orxFASTCALL	orxSoundSystem_SetSpatialization (orxSOUNDSYSTEM_SOUND *_pstSound, orxFLOAT _fMinDistance, orxFLOAT _fMaxDistance, orxFLOAT _fMinGain, orxFLOAT _fMaxGain, orxFLOAT _fRollOff)
orxDLLAPI orxSTATUS orxFASTCALL	orxSoundSystem_SetTime (orxSOUNDSYSTEM_SOUND *_pstSound, orxFLOAT _fTime)
orxDLLAPI void orxFASTCALL	orxSoundSystem_Setup ()
orxDLLAPI orxSTATUS orxFASTCALL	orxSoundSystem_SetVolume (orxSOUNDSYSTEM_SOUND *_pstSound, orxFLOAT _fVolume)
orxDLLAPI orxSTATUS orxFASTCALL	orxSoundSystem_StartRecording (const orxCHAR *_zName, orxBOOL _bWriteToFile, orxU32 _u32SampleRate, orxU32 _u32ChannelNumber)
orxDLLAPI orxSTATUS orxFASTCALL	orxSoundSystem_Stop (orxSOUNDSYSTEM_SOUND *_pstSound)
orxDLLAPI orxSTATUS orxFASTCALL	orxSoundSystem_StopRecording ()

Detailed Description

Date

13/07/2008

Author

iarwa.nosp@m.in@o.nosp@m.rx-pr.nosp@m.ojec.nosp@m.t.org

Todo

Definition in file orxSoundSystem.h.