Macros
#define	orxSOUNDPOINTER_KU32_SOUND_NUMBER 4

Typedefs
typedef struct __orxSOUNDPOINTER_t	orxSOUNDPOINTER

Functions
orxDLLAPI orxSTATUS orxFASTCALL	orxSoundPointer_AddFilter (orxSOUNDPOINTER _pstSoundPointer, const orxSOUND_FILTER_DATA _pstFilterData, orxBOOL _bUseCustomParam)

orxDLLAPI orxSTATUS orxFASTCALL	orxSoundPointer_AddFilterFromConfig (orxSOUNDPOINTER *_pstSoundPointer, const orxSTRING _zFilterConfigID)

orxDLLAPI orxSTATUS orxFASTCALL	orxSoundPointer_AddSound (orxSOUNDPOINTER _pstSoundPointer, orxSOUND _pstSound)

orxDLLAPI orxSTATUS orxFASTCALL	orxSoundPointer_AddSoundFromConfig (orxSOUNDPOINTER *_pstSoundPointer, const orxSTRING _zSoundConfigID)

orxDLLAPI orxSOUNDPOINTER *orxFASTCALL	orxSoundPointer_Create ()

orxDLLAPI orxSTATUS orxFASTCALL	orxSoundPointer_Delete (orxSOUNDPOINTER *_pstSoundPointer)

orxDLLAPI void orxFASTCALL	orxSoundPointer_Enable (orxSOUNDPOINTER *_pstSoundPointer, orxBOOL _bEnable)

orxDLLAPI void orxFASTCALL	orxSoundPointer_Exit ()

orxDLLAPI orxU32 orxFASTCALL	orxSoundPointer_GetCount (const orxSOUNDPOINTER *_pstSoundPointer)

orxDLLAPI orxSOUND *orxFASTCALL	orxSoundPointer_GetLastAddedSound (const orxSOUNDPOINTER *_pstSoundPointer)

orxDLLAPI orxSTATUS orxFASTCALL	orxSoundPointer_Init ()

orxDLLAPI orxBOOL orxFASTCALL	orxSoundPointer_IsEnabled (const orxSOUNDPOINTER *_pstSoundPointer)

orxDLLAPI orxSTATUS orxFASTCALL	orxSoundPointer_Pause (orxSOUNDPOINTER *_pstSoundPointer)

orxDLLAPI orxSTATUS orxFASTCALL	orxSoundPointer_Play (orxSOUNDPOINTER *_pstSoundPointer)

orxDLLAPI orxSTATUS orxFASTCALL	orxSoundPointer_RemoveAllFilters (orxSOUNDPOINTER *_pstSoundPointer)

orxDLLAPI orxSTATUS orxFASTCALL	orxSoundPointer_RemoveAllSounds (orxSOUNDPOINTER *_pstSoundPointer)

orxDLLAPI orxSTATUS orxFASTCALL	orxSoundPointer_RemoveLastFilter (orxSOUNDPOINTER *_pstSoundPointer)

orxDLLAPI orxSTATUS orxFASTCALL	orxSoundPointer_RemoveSound (orxSOUNDPOINTER _pstSoundPointer, orxSOUND _pstSound)

orxDLLAPI orxSTATUS orxFASTCALL	orxSoundPointer_RemoveSoundFromConfig (orxSOUNDPOINTER *_pstSoundPointer, const orxSTRING _zSoundConfigID)

orxDLLAPI orxSTATUS orxFASTCALL	orxSoundPointer_SetPanning (orxSOUNDPOINTER *_pstSoundPointer, orxFLOAT _fPanning, orxBOOL _bMix)

orxDLLAPI orxSTATUS orxFASTCALL	orxSoundPointer_SetPitch (orxSOUNDPOINTER *_pstSoundPointer, orxFLOAT _fPitch)

orxDLLAPI void orxFASTCALL	orxSoundPointer_Setup ()

orxDLLAPI orxSTATUS orxFASTCALL	orxSoundPointer_SetVolume (orxSOUNDPOINTER *_pstSoundPointer, orxFLOAT _fVolume)

orxDLLAPI orxSTATUS orxFASTCALL	orxSoundPointer_Stop (orxSOUNDPOINTER *_pstSoundPointer)

Detailed Description

Sound pointer module Allows to creates sound containers for objects.

Macro Definition Documentation

#define orxSOUNDPOINTER_KU32_SOUND_NUMBER 4

Misc defines

Definition at line 54 of file orxSoundPointer.h.

Typedef Documentation

typedef struct __orxSOUNDPOINTER_t orxSOUNDPOINTER

Internal SoundPointer structure

Definition at line 58 of file orxSoundPointer.h.

Function Documentation

orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_AddFilter	(	orxSOUNDPOINTER *	_pstSoundPointer,
		const orxSOUND_FILTER_DATA *	_pstFilterData,
		orxBOOL	_bUseCustomParam
	)

Adds a filter to all related sounds (cascading)

Parameters

[in]	_pstSoundPointer	Concerned SoundPointer
[in]	_pstFilterData	Concerned filter data
[in]	_bUseCustomParam	Filter uses custom parameters

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_AddFilterFromConfig	(	orxSOUNDPOINTER *	_pstSoundPointer,
		const orxSTRING	_zFilterConfigID
	)

Adds a filter to all related sounds from config (cascading)

Parameters

[in]	_pstSoundPointer	Concerned SoundPointer
[in]	_zFilterConfigID	Config ID of the filter to add

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_AddSound	(	orxSOUNDPOINTER *	_pstSoundPointer,
		orxSOUND *	_pstSound
	)

Adds a sound

Parameters

[in]	_pstSoundPointer	Concerned SoundPointer
[in]	_pstSound	Sound to add

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_AddSoundFromConfig	(	orxSOUNDPOINTER *	_pstSoundPointer,
		const orxSTRING	_zSoundConfigID
	)

Adds a sound using its config ID

Parameters

[in]	_pstSoundPointer	Concerned SoundPointer
[in]	_zSoundConfigID	Config ID of the sound to add

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSOUNDPOINTER* orxFASTCALL orxSoundPointer_Create ( )

Creates an empty SoundPointer

Returns: orxSOUNDPOINTER / orxNULL

orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_Delete ( orxSOUNDPOINTER * _pstSoundPointer )

Deletes a SoundPointer

Parameters

[in] _pstSoundPointer Concerned SoundPointer

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI void orxFASTCALL orxSoundPointer_Enable	(	orxSOUNDPOINTER *	_pstSoundPointer,
		orxBOOL	_bEnable
	)

Enables/disables a SoundPointer

Parameters

[in]	_pstSoundPointer	Concerned SoundPointer
[in]	_bEnable	Enable / disable

orxDLLAPI void orxFASTCALL orxSoundPointer_Exit ( )

Exits from the SoundPointer module

orxDLLAPI orxU32 orxFASTCALL orxSoundPointer_GetCount ( const orxSOUNDPOINTER * _pstSoundPointer )

Gets how many sounds are currently in use

Parameters

[in] _pstSoundPointer Concerned SoundPointer

Returns: orxU32

orxDLLAPI orxSOUND* orxFASTCALL orxSoundPointer_GetLastAddedSound ( const orxSOUNDPOINTER * _pstSoundPointer )

Gets last added sound (Do NOT destroy it directly before removing it!!!)

Parameters

[in] _pstSoundPointer Concerned SoundPointer

Returns: orxSOUND / orxNULL

orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_Init ( )

Inits the SoundPointer module

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxBOOL orxFASTCALL orxSoundPointer_IsEnabled ( const orxSOUNDPOINTER * _pstSoundPointer )

Is SoundPointer enabled?

Parameters

[in] _pstSoundPointer Concerned SoundPointer

Returns: orxTRUE if enabled, orxFALSE otherwise

orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_Pause ( orxSOUNDPOINTER * _pstSoundPointer )

Pauses all related sounds

Parameters

[in] _pstSoundPointer Concerned SoundPointer

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_Play ( orxSOUNDPOINTER * _pstSoundPointer )

Plays all related sounds

Parameters

[in] _pstSoundPointer Concerned SoundPointer

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_RemoveAllFilters ( orxSOUNDPOINTER * _pstSoundPointer )

Removes all filters from all related sounds

Parameters

[in] _pstSoundPointer Concerned SoundPointer

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_RemoveAllSounds ( orxSOUNDPOINTER * _pstSoundPointer )

Removes all sounds

Parameters

[in] _pstSoundPointer Concerned SoundPointer

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_RemoveLastFilter ( orxSOUNDPOINTER * _pstSoundPointer )

Removes last added filter from all related sounds

Parameters

[in] _pstSoundPointer Concerned SoundPointer

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_RemoveSound	(	orxSOUNDPOINTER *	_pstSoundPointer,
		orxSOUND *	_pstSound
	)

Removes a sound

Parameters

[in]	_pstSoundPointer	Concerned SoundPointer
[in]	_pstSound	Sound to remove

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_RemoveSoundFromConfig	(	orxSOUNDPOINTER *	_pstSoundPointer,
		const orxSTRING	_zSoundConfigID
	)

Removes a sound using its config ID

Parameters

[in]	_pstSoundPointer	Concerned SoundPointer
[in]	_zSoundConfigID	Config ID of the sound to remove

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_SetPanning	(	orxSOUNDPOINTER *	_pstSoundPointer,
		orxFLOAT	_fPanning,
		orxBOOL	_bMix
	)

Sets panning of all related sounds

Parameters

[in]	_pstSoundPointer	Concerned SoundPointer
[in]	_fPanning	Sound panning, -1.0f for full left, 0.0f for center, 1.0f for full right
[in]	_bMix	Left/Right channels will be mixed if orxTRUE or act like a balance otherwise

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_SetPitch	(	orxSOUNDPOINTER *	_pstSoundPointer,
		orxFLOAT	_fPitch
	)

Sets pitch of all related sounds

Parameters

[in]	_pstSoundPointer	Concerned SoundPointer
[in]	_fPitch	Desired pitch

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI void orxFASTCALL orxSoundPointer_Setup ( )

SoundPointer module setup

orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_SetVolume	(	orxSOUNDPOINTER *	_pstSoundPointer,
		orxFLOAT	_fVolume
	)

Sets volume of all related sounds

Parameters

[in]	_pstSoundPointer	Concerned SoundPointer
[in]	_fVolume	Desired volume (0.0 - 1.0)

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_Stop ( orxSOUNDPOINTER * _pstSoundPointer )

Stops all related sounds

Parameters

[in] _pstSoundPointer Concerned SoundPointer

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

Macros

Typedefs

Functions

Detailed Description

Macro Definition Documentation

Typedef Documentation

Function Documentation