Data Structures | Typedefs | Enumerations | Functions

include/sound/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

Typedefs

typedef struct __orxSOUND_t orxSOUND

Enumerations

enum  orxSOUND_EVENT {
  orxSOUND_EVENT_START = 0, orxSOUND_EVENT_STOP, 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 orxSOUND *orxFASTCALL orxSound_CreateFromConfig (const orxSTRING _zConfigID)
orxDLLAPI orxSTATUS orxFASTCALL orxSound_Delete (orxSOUND *_pstSound)
orxDLLAPI void orxFASTCALL orxSound_Exit ()
orxDLLAPI orxFLOAT orxFASTCALL orxSound_GetAttenuation (const orxSOUND *_pstSound)
orxDLLAPI orxFLOAT orxFASTCALL orxSound_GetDuration (const orxSOUND *_pstSound)
orxDLLAPI const orxSTRING
orxFASTCALL 
orxSound_GetName (const orxSOUND *_pstSound)
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 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_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_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 ()

Detailed Description

Date:
13/07/2008
Author:
iarwain@orx-project.org
Todo:

Definition in file orxSound.h.


Generated for orx by doxygen 1.5.6