Defines | Typedefs | Functions

OrxSoundPointer

Defines

#define orxSOUNDPOINTER_KU32_SOUND_NUMBER   4

Typedefs

typedef struct __orxSOUNDPOINTER_t orxSOUNDPOINTER

Functions

orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_AddSound (orxSOUNDPOINTER *_pstSoundPointer, orxSOUND *_pstSound)
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_AddSoundFromConfig (orxSOUNDPOINTER *_pstSoundPointer, const orxSTRING _zSoundConfigID)
orxDLLAPI orxSOUNDPOINTER
*orxFASTCALL 		orxSoundPointer_Create (const orxSTRUCTURE *_pstOwner)
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_Delete (orxSOUNDPOINTER *_pstSoundPointer)
orxDLLAPI void orxFASTCALL orxSoundPointer_Enable (orxSOUNDPOINTER *_pstSoundPointer, orxBOOL _bEnable)
orxDLLAPI void orxFASTCALL orxSoundPointer_Exit ()
orxDLLAPI orxSOUND *orxFASTCALL orxSoundPointer_GetLastAddedSound (const orxSOUNDPOINTER *_pstSoundPointer)
orxDLLAPI orxSTRUCTURE *orxFASTCALL orxSoundPointer_GetOwner (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_RemoveSound (orxSOUNDPOINTER *_pstSoundPointer, orxSOUND *_pstSound)
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_RemoveSoundFromConfig (orxSOUNDPOINTER *_pstSoundPointer, const orxSTRING _zSoundConfigID)
orxDLLAPI void orxFASTCALL orxSoundPointer_Setup ()
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_Stop (orxSOUNDPOINTER *_pstSoundPointer)

Detailed Description

Sound pointer module Allows to creates sound containers for objects.

Define 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_AddSound ( orxSOUNDPOINTER *  _pstSoundPointer,
orxSOUND *  _pstSound 
)

Adds a sound

Parameters:
[in]_pstSoundPointerConcerned SoundPointer
[in]_pstSoundSound 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]_pstSoundPointerConcerned SoundPointer
[in]_zSoundConfigIDConfig ID of the sound to add
Returns:
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSOUNDPOINTER* orxFASTCALL orxSoundPointer_Create ( const orxSTRUCTURE *  _pstOwner )

Creates an empty SoundPointer

Parameters:
[in]_pstOwnerSound's owner used for event callbacks (usually an orxOBJECT)
Returns:
orxSOUNDPOINTER / orxNULL
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_Delete ( orxSOUNDPOINTER *  _pstSoundPointer )

Deletes a SoundPointer

Parameters:
[in]_pstSoundPointerConcerned SoundPointer
Returns:
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI void orxFASTCALL orxSoundPointer_Enable ( orxSOUNDPOINTER *  _pstSoundPointer,
orxBOOL  _bEnable 
)

Enables/disables a SoundPointer

Parameters:
[in]_pstSoundPointerConcerned SoundPointer
[in]_bEnableEnable / disable
orxDLLAPI void orxFASTCALL orxSoundPointer_Exit (  )

Exits from the SoundPointer module

orxDLLAPI orxSOUND* orxFASTCALL orxSoundPointer_GetLastAddedSound ( const orxSOUNDPOINTER *  _pstSoundPointer )

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

Parameters:
[in]_pstSoundPointerConcerned SoundPointer
Returns:
orxSOUND / orxNULL
orxDLLAPI orxSTRUCTURE* orxFASTCALL orxSoundPointer_GetOwner ( const orxSOUNDPOINTER *  _pstSoundPointer )

Gets a SoundPointer owner

Parameters:
[in]_pstSoundPointerConcerned SoundPointer
Returns:
orxSTRUCTURE / 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]_pstSoundPointerConcerned SoundPointer
Returns:
orxTRUE if enabled, orxFALSE otherwise
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_Pause ( orxSOUNDPOINTER *  _pstSoundPointer )

Pauses all related sounds

Parameters:
[in]_pstSoundPointerConcerned SoundPointer
Returns:
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_Play ( orxSOUNDPOINTER *  _pstSoundPointer )

Plays all related sounds

Parameters:
[in]_pstSoundPointerConcerned SoundPointer
Returns:
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_RemoveSound ( orxSOUNDPOINTER *  _pstSoundPointer,
orxSOUND *  _pstSound 
)

Removes a sound

Parameters:
[in]_pstSoundPointerConcerned SoundPointer
[in]_pstSoundSound to remove
Returns:
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_RemoveSoundFromConfig ( orxSOUNDPOINTER *  _pstSoundPointer,
const orxSTRING  _zSoundConfigID 
)

Removes a sound using using its config ID

Parameters:
[in]_pstSoundPointerConcerned SoundPointer
[in]_zSoundConfigIDConfig ID of the sound to remove
Returns:
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI void orxFASTCALL orxSoundPointer_Setup (  )

SoundPointer module setup

orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_Stop ( orxSOUNDPOINTER *  _pstSoundPointer )

Stops all related sounds

Parameters:
[in]_pstSoundPointerConcerned SoundPointer
Returns:
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
Generated for orx by doxygen 1.5.6