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

Sound module Module that handles sound

Typedef Documentation

typedef struct __orxSOUND_t orxSOUND

Internal Sound structure

Definition at line 69 of file orxSound.h.

Enumeration Type Documentation

enum orxSOUND_EVENT

Event enum

Enumerator:

orxSOUND_EVENT_START	Event sent when a sound starts
orxSOUND_EVENT_STOP	Event sent when a sound stops
orxSOUND_EVENT_PACKET	Event sent when a sound packet is streamed
orxSOUND_EVENT_RECORDING_START	Event sent when recording starts
orxSOUND_EVENT_RECORDING_STOP	Event sent when recording stops
orxSOUND_EVENT_RECORDING_PACKET	Event sent when a packet has been recorded
orxSOUND_EVENT_NUMBER
orxSOUND_EVENT_NONE

Definition at line 74 of file orxSound.h.

enum orxSOUND_STATUS

Sound status enum

Enumerator:

orxSOUND_STATUS_PLAY
orxSOUND_STATUS_PAUSE
orxSOUND_STATUS_STOP
orxSOUND_STATUS_NUMBER
orxSOUND_STATUS_NONE

Definition at line 54 of file orxSound.h.

Function Documentation

orxDLLAPI orxSOUND* orxFASTCALL orxSound_CreateFromConfig ( const orxSTRING _zConfigID )

Creates sound from config

Parameters:

[in] _zConfigID Config ID @ return orxSOUND / orxNULL

orxDLLAPI orxSTATUS orxFASTCALL orxSound_Delete ( orxSOUND * _pstSound )

Deletes sound

Parameters:

[in] _pstSound Concerned Sound

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI void orxFASTCALL orxSound_Exit ( )

Exits from the sound module

orxDLLAPI orxFLOAT orxFASTCALL orxSound_GetAttenuation ( const orxSOUND * _pstSound )

Gets sound attenuation

Parameters:

[in] _pstSound Concerned Sound

Returns:: orxFLOAT

orxDLLAPI orxFLOAT orxFASTCALL orxSound_GetDuration ( const orxSOUND * _pstSound )

Gets sound duration

Parameters:

[in] _pstSound Concerned Sound

Returns:: orxFLOAT

orxDLLAPI const orxSTRING orxFASTCALL orxSound_GetName ( const orxSOUND * _pstSound )

Gets sound config name

Parameters:

[in] _pstSound Concerned sound

Returns:: orxSTRING / orxSTRING_EMPTY

orxDLLAPI orxFLOAT orxFASTCALL orxSound_GetPitch ( const orxSOUND * _pstSound )

Gets sound pitch

Parameters:

[in] _pstSound Concerned Sound

Returns:: orxFLOAT

orxDLLAPI orxVECTOR* orxFASTCALL orxSound_GetPosition	(	const orxSOUND *	_pstSound,
		orxVECTOR *	_pvPosition
	)

Gets sound position

Parameters:

[in]	_pstSound	Concerned Sound
[out]	_pvPosition	Sound's position

Returns:: orxVECTOR / orxNULL

orxDLLAPI orxFLOAT orxFASTCALL orxSound_GetReferenceDistance ( const orxSOUND * _pstSound )

Gets sound reference distance

Parameters:

[in] _pstSound Concerned Sound

Returns:: orxFLOAT

orxDLLAPI orxSOUND_STATUS orxFASTCALL orxSound_GetStatus ( const orxSOUND * _pstSound )

Gets sound status

Parameters:

[in] _pstSound Concerned Sound

Returns:: orxSOUND_STATUS

orxDLLAPI orxFLOAT orxFASTCALL orxSound_GetVolume ( const orxSOUND * _pstSound )

Gets sound volume

Parameters:

[in] _pstSound Concerned Sound

Returns:: orxFLOAT

orxDLLAPI orxBOOL orxFASTCALL orxSound_HasRecordingSupport ( )

Is recording possible on the current system?

Returns:: orxTRUE / orxFALSE

orxDLLAPI orxSTATUS orxFASTCALL orxSound_Init ( )

Initializes the sound module

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxBOOL orxFASTCALL orxSound_IsLooping ( const orxSOUND * _pstSound )

Is sound looping?

Parameters:

[in] _pstSound Concerned Sound

Returns:: orxTRUE / orxFALSE

orxDLLAPI orxBOOL orxFASTCALL orxSound_IsStream ( orxSOUND * _pstSound )

Is a stream (ie. music)?

Parameters:

[in] _pstSound Concerned Sound

Returns:: orxTRUE / orxFALSE

orxDLLAPI orxSTATUS orxFASTCALL orxSound_Loop	(	orxSOUND *	_pstSound,
		orxBOOL	_bLoop
	)

Loops sound

Parameters:

[in]	_pstSound	Concerned Sound
[in]	_bLoop	orxTRUE / orxFALSE

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxSound_Pause ( orxSOUND * _pstSound )

Pauses sound

Parameters:

[in] _pstSound Concerned Sound

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxSound_Play ( orxSOUND * _pstSound )

Plays sound

Parameters:

[in] _pstSound Concerned Sound

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxSound_SetAttenuation	(	orxSOUND *	_pstSound,
		orxFLOAT	_fAttenuation
	)

Sets sound attenuation

Parameters:

[in]	_pstSound	Concerned Sound
[in]	_fAttenuation	Desired attenuation

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxSound_SetPitch	(	orxSOUND *	_pstSound,
		orxFLOAT	_fPitch
	)

Sets sound pitch

Parameters:

[in]	_pstSound	Concerned Sound
[in]	_fPitch	Desired pitch

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxSound_SetPosition	(	orxSOUND *	_pstSound,
		const orxVECTOR *	_pvPosition
	)

Sets sound position

Parameters:

[in]	_pstSound	Concerned Sound
[in]	_pvPosition	Desired position

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxSound_SetReferenceDistance	(	orxSOUND *	_pstSound,
		orxFLOAT	_fDistance
	)

Sets sound reference distance

Parameters:

[in]	_pstSound	Concerned Sound
[in]	_fDistance	Within this distance, sound is perceived at its maximum volume

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI void orxFASTCALL orxSound_Setup ( )

Sound module setup

orxDLLAPI orxSTATUS orxFASTCALL orxSound_SetVolume	(	orxSOUND *	_pstSound,
		orxFLOAT	_fVolume
	)

Sets sound volume

Parameters:

[in]	_pstSound	Concerned Sound
[in]	_fVolume	Desired volume (0.0 - 1.0)

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxSound_StartRecording	(	const orxCHAR *	_zName,
		orxBOOL	_bWriteToFile,
		orxU32	_u32SampleRate,
		orxU32	_u32ChannelNumber
	)

Starts recording

Parameters:

[in]	_zName	Name for the recorded sound/file
[in]	_bWriteToFile	Should write to file?
[in]	_u32SampleRate	Sample rate, 0 for default rate (44100Hz)
[in]	_u32ChannelNumber	Channel number, 0 for default mono channel

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxSound_Stop ( orxSOUND * _pstSound )

Stops sound

Parameters:

[in] _pstSound Concerned Sound

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxSound_StopRecording ( )

Stops recording

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

OrxSound

Data Structures

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

Enumeration Type Documentation

Function Documentation