orxSound.h File Reference

#include "orxInclude.h"
#include "math/orxVector.h"
#include "sound/orxSoundSystem.h"

Go to the source code of this file.

Data Structures
struct	orxSOUND_EVENT_PAYLOAD
struct	orxSOUND_STREAM_INFO
struct	orxSOUND_STREAM_PACKET

Macros
#define	orxSOUND_KZ_LOCALE_GROUP   "Sound"
#define	orxSOUND_KZ_MASTER_BUS   "master"
#define	orxSOUND_KZ_RESOURCE_GROUP   "Sound"

Typedefs
typedef struct __orxSOUND_t	orxSOUND
typedef struct __orxSOUND_SAMPLE_t	orxSOUND_SAMPLE

Enumerations
enum	orxSOUND_EVENT {   orxSOUND_EVENT_START = 0, orxSOUND_EVENT_STOP, orxSOUND_EVENT_ADD, orxSOUND_EVENT_REMOVE,   orxSOUND_EVENT_PACKET, orxSOUND_EVENT_RECORDING_START, orxSOUND_EVENT_RECORDING_STOP, orxSOUND_EVENT_RECORDING_PACKET,   orxSOUND_EVENT_SET_FILTER_PARAM, orxSOUND_EVENT_NUMBER, orxSOUND_EVENT_NONE = orxENUM_NONE }
enum	orxSOUND_STATUS {   orxSOUND_STATUS_PLAY = 0, orxSOUND_STATUS_PAUSE, orxSOUND_STATUS_STOP, orxSOUND_STATUS_NUMBER,   orxSOUND_STATUS_NONE = orxENUM_NONE }

Functions
orxDLLAPI orxSTATUS orxFASTCALL	orxSound_AddBusFilter (orxSTRINGID _stBusID, const orxSOUND_FILTER_DATA *_pstFilterData, orxBOOL _bUseCustomParam)
orxDLLAPI orxSTATUS orxFASTCALL	orxSound_AddBusFilterFromConfig (orxSTRINGID _stBusID, const orxSTRING _zFilterConfigID)
orxDLLAPI orxSTATUS orxFASTCALL	orxSound_AddFilter (orxSOUND *_pstSound, const orxSOUND_FILTER_DATA *_pstFilterData, orxBOOL _bUseCustomParam)
orxDLLAPI orxSTATUS orxFASTCALL	orxSound_AddFilterFromConfig (orxSOUND *_pstSound, const orxSTRING _zFilterConfigID)
orxDLLAPI orxSTATUS orxFASTCALL	orxSound_ClearCache ()
orxDLLAPI orxSOUND *orxFASTCALL	orxSound_Create ()
orxDLLAPI orxSOUND *orxFASTCALL	orxSound_CreateFromConfig (const orxSTRING _zConfigID)
orxDLLAPI orxSOUND_SAMPLE *orxFASTCALL	orxSound_CreateSample (orxU32 _u32ChannelNumber, orxU32 _u32FrameNumber, orxU32 _u32SampleRate, const orxSTRING _zName)
orxDLLAPI orxSOUND *orxFASTCALL	orxSound_CreateWithEmptyStream (orxU32 _u32ChannelNumber, orxU32 _u32SampleRate, const orxSTRING _zName)
orxDLLAPI orxSTATUS orxFASTCALL	orxSound_Delete (orxSOUND *_pstSound)
orxDLLAPI orxSTATUS orxFASTCALL	orxSound_DeleteSample (orxSOUND_SAMPLE *_pstSample)
orxDLLAPI void orxFASTCALL	orxSound_Exit ()
orxDLLAPI orxSTRINGID orxFASTCALL	orxSound_GetBusChild (orxSTRINGID _stBusID)
orxDLLAPI orxFLOAT orxFASTCALL	orxSound_GetBusGlobalPitch (orxSTRINGID _stBusID)
orxDLLAPI orxFLOAT orxFASTCALL	orxSound_GetBusGlobalVolume (orxSTRINGID _stBusID)
orxDLLAPI orxSTRINGID orxFASTCALL	orxSound_GetBusID (const orxSOUND *_pstSound)
orxDLLAPI orxSTRINGID orxFASTCALL	orxSound_GetBusParent (orxSTRINGID _stBusID)
orxDLLAPI orxFLOAT orxFASTCALL	orxSound_GetBusPitch (orxSTRINGID _stBusID)
orxDLLAPI orxSTRINGID orxFASTCALL	orxSound_GetBusSibling (orxSTRINGID _stBusID)
orxDLLAPI orxFLOAT orxFASTCALL	orxSound_GetBusVolume (orxSTRINGID _stBusID)
orxDLLAPI orxFLOAT orxFASTCALL	orxSound_GetDuration (const orxSOUND *_pstSound)
orxDLLAPI orxSTRINGID orxFASTCALL	orxSound_GetMasterBusID ()
orxDLLAPI const orxSTRING orxFASTCALL	orxSound_GetName (const orxSOUND *_pstSound)
orxDLLAPI orxSOUND *orxFASTCALL	orxSound_GetNext (const orxSOUND *_pstSound, orxSTRINGID _stBusID)
orxDLLAPI orxSTATUS orxFASTCALL	orxSound_GetPanning (const orxSOUND *_pstSound, orxFLOAT *_pfPanning, orxBOOL *_pbMix)
orxDLLAPI orxFLOAT orxFASTCALL	orxSound_GetPitch (const orxSOUND *_pstSound)
orxDLLAPI orxVECTOR *orxFASTCALL	orxSound_GetPosition (const orxSOUND *_pstSound, orxVECTOR *_pvPosition)
orxDLLAPI orxSTATUS orxFASTCALL	orxSound_GetSampleInfo (const orxSOUND_SAMPLE *_pstSample, orxU32 *_pu32ChannelNumber, orxU32 *_pu32FrameNumber, orxU32 *_pu32SampleRate)
orxDLLAPI orxSTATUS orxFASTCALL	orxSound_GetSpatialization (const orxSOUND *_pstSound, orxFLOAT *_pfMinDistance, orxFLOAT *_pfMaxDistance, orxFLOAT *_pfMinGain, orxFLOAT *_pfMaxGain, orxFLOAT *_pfRollOff)
orxDLLAPI orxSOUND_STATUS orxFASTCALL	orxSound_GetStatus (const orxSOUND *_pstSound)
orxDLLAPI orxFLOAT orxFASTCALL	orxSound_GetTime (const orxSOUND *_pstSound)
orxDLLAPI orxFLOAT orxFASTCALL	orxSound_GetVolume (const orxSOUND *_pstSound)
orxDLLAPI orxBOOL orxFASTCALL	orxSound_HasRecordingSupport ()
orxDLLAPI orxSTATUS orxFASTCALL	orxSound_Init ()
orxDLLAPI orxBOOL orxFASTCALL	orxSound_IsLooping (const orxSOUND *_pstSound)
orxDLLAPI orxBOOL orxFASTCALL	orxSound_IsStream (orxSOUND *_pstSound)
orxDLLAPI orxSTATUS orxFASTCALL	orxSound_LinkSample (orxSOUND *_pstSound, const orxSTRING _zSampleName)
orxDLLAPI orxSTATUS orxFASTCALL	orxSound_Loop (orxSOUND *_pstSound, orxBOOL _bLoop)
orxDLLAPI orxSTATUS orxFASTCALL	orxSound_Pause (orxSOUND *_pstSound)
orxDLLAPI orxSTATUS orxFASTCALL	orxSound_Play (orxSOUND *_pstSound)
orxDLLAPI orxSTATUS orxFASTCALL	orxSound_RemoveAllBusFilters (orxSTRINGID _stBusID)
orxDLLAPI orxSTATUS orxFASTCALL	orxSound_RemoveAllFilters (orxSOUND *_pstSound)
orxDLLAPI orxSTATUS orxFASTCALL	orxSound_RemoveLastBusFilter (orxSTRINGID _stBusID)
orxDLLAPI orxSTATUS orxFASTCALL	orxSound_RemoveLastFilter (orxSOUND *_pstSound)
orxDLLAPI orxSTATUS orxFASTCALL	orxSound_SetBusID (orxSOUND *_pstSound, orxSTRINGID _stBusID)
orxDLLAPI orxSTATUS orxFASTCALL	orxSound_SetBusParent (orxSTRINGID _stBusID, orxSTRINGID _stParentBusID)
orxDLLAPI orxSTATUS orxFASTCALL	orxSound_SetBusPitch (orxSTRINGID _stBusID, orxFLOAT _fPitch)
orxDLLAPI orxSTATUS orxFASTCALL	orxSound_SetBusVolume (orxSTRINGID _stBusID, orxFLOAT _fVolume)
orxDLLAPI orxSTATUS orxFASTCALL	orxSound_SetPanning (orxSOUND *_pstSound, orxFLOAT _fPanning, orxBOOL _bMix)
orxDLLAPI orxSTATUS orxFASTCALL	orxSound_SetPitch (orxSOUND *_pstSound, orxFLOAT _fPitch)
orxDLLAPI orxSTATUS orxFASTCALL	orxSound_SetPosition (orxSOUND *_pstSound, const orxVECTOR *_pvPosition)
orxDLLAPI orxSTATUS orxFASTCALL	orxSound_SetSampleData (orxSOUND_SAMPLE *_pstSample, const orxFLOAT *_afData, orxU32 _u32SampleNumber)
orxDLLAPI orxSTATUS orxFASTCALL	orxSound_SetSpatialization (orxSOUND *_pstSound, orxFLOAT _fMinDistance, orxFLOAT _fMaxDistance, orxFLOAT _fMinGain, orxFLOAT _fMaxGain, orxFLOAT _fRollOff)
orxDLLAPI orxSTATUS orxFASTCALL	orxSound_SetTime (orxSOUND *_pstSound, orxFLOAT _fTime)
orxDLLAPI void orxFASTCALL	orxSound_Setup ()
orxDLLAPI orxSTATUS orxFASTCALL	orxSound_SetVolume (orxSOUND *_pstSound, orxFLOAT _fVolume)
orxDLLAPI orxSTATUS orxFASTCALL	orxSound_StartRecording (const orxCHAR *_zName, orxBOOL _bWriteToFile, orxU32 _u32SampleRate, orxU32 _u32ChannelNumber)
orxDLLAPI orxSTATUS orxFASTCALL	orxSound_Stop (orxSOUND *_pstSound)
orxDLLAPI orxSTATUS orxFASTCALL	orxSound_StopRecording ()
orxDLLAPI orxSTATUS orxFASTCALL	orxSound_UnlinkSample (orxSOUND *_pstSound)

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 orxSound.h.