orx  stable
Portable Game Engine
orxSound.h File Reference
#include "orxInclude.h"
#include "sound/orxSoundSystem.h"
#include "math/orxVector.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_MASTER_BUS   "master"
 
#define orxSOUND_KZ_RESOURCE_GROUP   "Sound"
 

Typedefs

typedef struct __orxSOUND_t orxSOUND
 

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_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_ClearCache ()
 
orxDLLAPI orxSOUND *orxFASTCALL orxSound_Create ()
 
orxDLLAPI orxSOUND *orxFASTCALL orxSound_CreateFromConfig (const orxSTRING _zConfigID)
 
orxDLLAPI orxSOUNDSYSTEM_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 (const orxSTRING _zName)
 
orxDLLAPI void orxFASTCALL orxSound_Exit ()
 
orxDLLAPI orxFLOAT orxFASTCALL orxSound_GetAttenuation (const orxSOUND *_pstSound)
 
orxDLLAPI orxU32 orxFASTCALL orxSound_GetBusChild (orxU32 _u32BusID)
 
orxDLLAPI orxFLOAT orxFASTCALL orxSound_GetBusGlobalPitch (orxU32 _u32BusID)
 
orxDLLAPI orxFLOAT orxFASTCALL orxSound_GetBusGlobalVolume (orxU32 _u32BusID)
 
orxDLLAPI orxU32 orxFASTCALL orxSound_GetBusID (const orxSOUND *_pstSound)
 
orxDLLAPI orxU32 orxFASTCALL orxSound_GetBusParent (orxU32 _u32BusID)
 
orxDLLAPI orxFLOAT orxFASTCALL orxSound_GetBusPitch (orxU32 _u32BusID)
 
orxDLLAPI orxU32 orxFASTCALL orxSound_GetBusSibling (orxU32 _u32BusID)
 
orxDLLAPI orxFLOAT orxFASTCALL orxSound_GetBusVolume (orxU32 _u32BusID)
 
orxDLLAPI orxFLOAT orxFASTCALL orxSound_GetDuration (const orxSOUND *_pstSound)
 
orxDLLAPI orxU32 orxFASTCALL orxSound_GetMasterBusID ()
 
orxDLLAPI const orxSTRING orxFASTCALL orxSound_GetName (const orxSOUND *_pstSound)
 
orxDLLAPI orxSOUND *orxFASTCALL orxSound_GetNext (const orxSOUND *_pstSound, orxU32 _u32BusID)
 
orxDLLAPI orxFLOAT orxFASTCALL orxSound_GetPitch (const orxSOUND *_pstSound)
 
orxDLLAPI orxVECTOR *orxFASTCALL orxSound_GetPosition (const orxSOUND *_pstSound, orxVECTOR *_pvPosition)
 
orxDLLAPI orxFLOAT orxFASTCALL orxSound_GetReferenceDistance (const orxSOUND *_pstSound)
 
orxDLLAPI orxSOUNDSYSTEM_SAMPLE *orxFASTCALL orxSound_GetSample (const orxSTRING _zName)
 
orxDLLAPI orxSOUND_STATUS orxFASTCALL orxSound_GetStatus (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_SetAttenuation (orxSOUND *_pstSound, orxFLOAT _fAttenuation)
 
orxDLLAPI orxSTATUS orxFASTCALL orxSound_SetBusID (orxSOUND *_pstSound, orxU32 _u32BusID)
 
orxDLLAPI orxSTATUS orxFASTCALL orxSound_SetBusParent (orxU32 _u32BusID, orxU32 _u32ParentBusID)
 
orxDLLAPI orxSTATUS orxFASTCALL orxSound_SetBusPitch (orxU32 _u32BusID, orxFLOAT _fPitch)
 
orxDLLAPI orxSTATUS orxFASTCALL orxSound_SetBusVolume (orxU32 _u32BusID, orxFLOAT _fVolume)
 
orxDLLAPI orxSTATUS orxFASTCALL orxSound_SetPitch (orxSOUND *_pstSound, orxFLOAT _fPitch)
 
orxDLLAPI orxSTATUS orxFASTCALL orxSound_SetPosition (orxSOUND *_pstSound, const orxVECTOR *_pvPosition)
 
orxDLLAPI orxSTATUS orxFASTCALL orxSound_SetReferenceDistance (orxSOUND *_pstSound, orxFLOAT _fDistance)
 
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


Generated for orx by doxygen 1.5.6