orx 1.16
Portable Game Engine
Loading...
Searching...
No Matches
OrxSoundSystem

Data Structures

struct  orxSOUND_FILTER_DATA

Macros

#define orxSOUNDSYSTEM_KZ_CONFIG_CHANNELS   "Channels"
#define orxSOUNDSYSTEM_KZ_CONFIG_LISTENERS   "Listeners"
#define orxSOUNDSYSTEM_KZ_CONFIG_MUTE_IN_BACKGROUND   "MuteInBackground"
#define orxSOUNDSYSTEM_KZ_CONFIG_RATIO   "DimensionRatio"
#define orxSOUNDSYSTEM_KZ_CONFIG_SECTION   "SoundSystem"

Typedefs

typedef void(orxFASTCALL * orxSOUND_FILTER_FUNCTION) (orxFLOAT *_afSampleListOut, const orxFLOAT *_afSampleListIn, orxU32 _u32SampleCount, orxU32 _u32ChannelCount, orxU32 _u32SampleRate, orxSTRINGID _stNameID, void *_pContext)
typedef struct __orxSOUNDSYSTEM_SAMPLE_t orxSOUNDSYSTEM_SAMPLE
typedef struct __orxSOUNDSYSTEM_SOUND_t orxSOUNDSYSTEM_SOUND

Enumerations

enum  orxSOUND_FILTER_TYPE {
  orxSOUND_FILTER_TYPE_BIQUAD = 0 , orxSOUND_FILTER_TYPE_LOW_PASS , orxSOUND_FILTER_TYPE_HIGH_PASS , orxSOUND_FILTER_TYPE_BAND_PASS ,
  orxSOUND_FILTER_TYPE_LOW_SHELF , orxSOUND_FILTER_TYPE_HIGH_SHELF , orxSOUND_FILTER_TYPE_NOTCH , orxSOUND_FILTER_TYPE_PEAKING ,
  orxSOUND_FILTER_TYPE_DELAY , orxSOUND_FILTER_TYPE_CUSTOM , orxSOUND_FILTER_TYPE_NUMBER , orxSOUND_FILTER_TYPE_NONE = orxENUM_NONE
}
enum  orxSOUNDSYSTEM_STATUS {
  orxSOUNDSYSTEM_STATUS_PLAY = 0 , orxSOUNDSYSTEM_STATUS_PAUSE , orxSOUNDSYSTEM_STATUS_STOP , orxSOUNDSYSTEM_STATUS_NUMBER ,
  orxSOUNDSYSTEM_STATUS_NONE = orxENUM_NONE
}
enum  orxSOUNDSYSTEM_STREAM_TYPE {
  orxSOUNDSYSTEM_STREAM_TYPE_EMPTY = 0 , orxSOUNDSYSTEM_STREAM_TYPE_WHITE , orxSOUNDSYSTEM_STREAM_TYPE_PINK , orxSOUNDSYSTEM_STREAM_TYPE_BROWNIAN ,
  orxSOUNDSYSTEM_STREAM_TYPE_SINE , orxSOUNDSYSTEM_STREAM_TYPE_SQUARE , orxSOUNDSYSTEM_STREAM_TYPE_TRIANGLE , orxSOUNDSYSTEM_STREAM_TYPE_SAWTOOTH ,
  orxSOUNDSYSTEM_STREAM_TYPE_RESOURCE , orxSOUNDSYSTEM_STREAM_TYPE_NUMBER , orxSOUNDSYSTEM_STREAM_TYPE_NONE = orxENUM_NONE
}

Functions

orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_AddBusFilter (orxHANDLE _hBus, const orxSOUND_FILTER_DATA *_pstFilterData, orxBOOL _bUseCustomParam)
orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_AddFilter (orxSOUNDSYSTEM_SOUND *_pstSound, const orxSOUND_FILTER_DATA *_pstFilterData, orxBOOL _bUseCustomParam)
orxDLLAPI orxHANDLE orxFASTCALL orxSoundSystem_CreateBus (orxSTRINGID _stBusID)
orxDLLAPI orxSOUNDSYSTEM_SOUND *orxFASTCALL orxSoundSystem_CreateFromSample (orxHANDLE _hUserData, const orxSOUNDSYSTEM_SAMPLE *_pstSample)
orxDLLAPI orxSOUNDSYSTEM_SAMPLE *orxFASTCALL orxSoundSystem_CreateSample (orxU32 _u32ChannelNumber, orxU32 _u32FrameNumber, orxU32 _u32SampleRate)
orxDLLAPI orxSOUNDSYSTEM_SOUND *orxFASTCALL orxSoundSystem_CreateStream (orxHANDLE _hUserData, orxSOUNDSYSTEM_STREAM_TYPE _eType, orxU32 _u32ChannelNumber, orxU32 _u32SampleRate)
orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_Delete (orxSOUNDSYSTEM_SOUND *_pstSound)
orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_DeleteBus (orxHANDLE _hBus)
orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_DeleteSample (orxSOUNDSYSTEM_SAMPLE *_pstSample)
orxDLLAPI void orxFASTCALL orxSoundSystem_EnableListener (orxU32 _u32ListenerIndex, orxBOOL _bEnable)
orxDLLAPI void orxFASTCALL orxSoundSystem_Exit ()
orxDLLAPI orxFLOAT orxFASTCALL orxSoundSystem_GetDuration (const orxSOUNDSYSTEM_SOUND *_pstSound)
orxDLLAPI orxFLOAT orxFASTCALL orxSoundSystem_GetGlobalVolume ()
orxDLLAPI orxU32 orxFASTCALL orxSoundSystem_GetListenerCount ()
orxDLLAPI orxVECTOR *orxFASTCALL orxSoundSystem_GetListenerPosition (orxU32 _u32Index, orxVECTOR *_pvPosition)
orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_GetPanning (const orxSOUNDSYSTEM_SOUND *_pstSound, orxFLOAT *_pfPanning, orxBOOL *_pbMix)
orxDLLAPI orxFLOAT orxFASTCALL orxSoundSystem_GetPitch (const orxSOUNDSYSTEM_SOUND *_pstSound)
orxDLLAPI orxVECTOR *orxFASTCALL orxSoundSystem_GetPosition (const orxSOUNDSYSTEM_SOUND *_pstSound, orxVECTOR *_pvPosition)
orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_GetSampleInfo (const orxSOUNDSYSTEM_SAMPLE *_pstSample, orxU32 *_pu32ChannelNumber, orxU32 *_pu32FrameNumber, orxU32 *_pu32SampleRate)
orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_GetSpatialization (const orxSOUNDSYSTEM_SOUND *_pstSound, orxFLOAT *_pfMinDistance, orxFLOAT *_pfMaxDistance, orxFLOAT *_pfMinGain, orxFLOAT *_pfMaxGain, orxFLOAT *_pfRollOff)
orxDLLAPI orxSOUNDSYSTEM_STATUS orxFASTCALL orxSoundSystem_GetStatus (const orxSOUNDSYSTEM_SOUND *_pstSound)
orxDLLAPI orxFLOAT orxFASTCALL orxSoundSystem_GetTime (const orxSOUNDSYSTEM_SOUND *_pstSound)
orxDLLAPI orxFLOAT orxFASTCALL orxSoundSystem_GetVolume (const orxSOUNDSYSTEM_SOUND *_pstSound)
orxDLLAPI orxBOOL orxFASTCALL orxSoundSystem_HasRecordingSupport ()
orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_Init ()
orxDLLAPI orxBOOL orxFASTCALL orxSoundSystem_IsListenerEnabled (orxU32 _u32ListenerIndex)
orxDLLAPI orxBOOL orxFASTCALL orxSoundSystem_IsLooping (const orxSOUNDSYSTEM_SOUND *_pstSound)
orxDLLAPI orxSOUNDSYSTEM_SAMPLE *orxFASTCALL orxSoundSystem_LoadSample (const orxSTRING _zFilename)
orxDLLAPI orxSOUNDSYSTEM_SOUND *orxFASTCALL orxSoundSystem_LoadStream (orxHANDLE _hUserData, const orxSTRING _zFilename)
orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_Loop (orxSOUNDSYSTEM_SOUND *_pstSound, orxBOOL _bLoop)
orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_Pause (orxSOUNDSYSTEM_SOUND *_pstSound)
orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_Play (orxSOUNDSYSTEM_SOUND *_pstSound)
orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_RemoveAllBusFilters (orxHANDLE _hBus)
orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_RemoveAllFilters (orxSOUNDSYSTEM_SOUND *_pstSound)
orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_RemoveLastBusFilter (orxHANDLE _hBus)
orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_RemoveLastFilter (orxSOUNDSYSTEM_SOUND *_pstSound)
orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_SetBus (orxSOUNDSYSTEM_SOUND *_pstSound, orxHANDLE _hBus)
orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_SetBusParent (orxHANDLE _hBus, orxHANDLE _hParentBus)
orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_SetGlobalVolume (orxFLOAT _fGlobalVolume)
orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_SetListenerPosition (orxU32 _u32Index, const orxVECTOR *_pvPosition)
orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_SetPanning (orxSOUNDSYSTEM_SOUND *_pstSound, orxFLOAT _fPanning, orxBOOL _bMix)
orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_SetPitch (orxSOUNDSYSTEM_SOUND *_pstSound, orxFLOAT _fPitch)
orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_SetPosition (orxSOUNDSYSTEM_SOUND *_pstSound, const orxVECTOR *_pvPosition)
orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_SetSampleData (orxSOUNDSYSTEM_SAMPLE *_pstSample, const orxFLOAT *_afData, orxU32 _u32SampleNumber)
orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_SetSpatialization (orxSOUNDSYSTEM_SOUND *_pstSound, orxFLOAT _fMinDistance, orxFLOAT _fMaxDistance, orxFLOAT _fMinGain, orxFLOAT _fMaxGain, orxFLOAT _fRollOff)
orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_SetTime (orxSOUNDSYSTEM_SOUND *_pstSound, orxFLOAT _fTime)
orxDLLAPI void orxFASTCALL orxSoundSystem_Setup ()
orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_SetVolume (orxSOUNDSYSTEM_SOUND *_pstSound, orxFLOAT _fVolume)
orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_StartRecording (const orxCHAR *_zName, orxBOOL _bWriteToFile, orxU32 _u32SampleRate, orxU32 _u32ChannelNumber)
orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_Stop (orxSOUNDSYSTEM_SOUND *_pstSound)
orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_StopRecording ()

Detailed Description

Sound system plugin module Plugin module that handles sound system

Macro Definition Documentation

◆ orxSOUNDSYSTEM_KZ_CONFIG_CHANNELS

#define orxSOUNDSYSTEM_KZ_CONFIG_CHANNELS   "Channels"

Definition at line 222 of file orxSoundSystem.h.

◆ orxSOUNDSYSTEM_KZ_CONFIG_LISTENERS

#define orxSOUNDSYSTEM_KZ_CONFIG_LISTENERS   "Listeners"

Definition at line 221 of file orxSoundSystem.h.

◆ orxSOUNDSYSTEM_KZ_CONFIG_MUTE_IN_BACKGROUND

#define orxSOUNDSYSTEM_KZ_CONFIG_MUTE_IN_BACKGROUND   "MuteInBackground"

Definition at line 220 of file orxSoundSystem.h.

◆ orxSOUNDSYSTEM_KZ_CONFIG_RATIO

#define orxSOUNDSYSTEM_KZ_CONFIG_RATIO   "DimensionRatio"

Definition at line 219 of file orxSoundSystem.h.

◆ orxSOUNDSYSTEM_KZ_CONFIG_SECTION

#define orxSOUNDSYSTEM_KZ_CONFIG_SECTION   "SoundSystem"

Config defines

Definition at line 218 of file orxSoundSystem.h.

Typedef Documentation

◆ orxSOUND_FILTER_FUNCTION

typedef void(orxFASTCALL * orxSOUND_FILTER_FUNCTION) (orxFLOAT *_afSampleListOut, const orxFLOAT *_afSampleListIn, orxU32 _u32SampleCount, orxU32 _u32ChannelCount, orxU32 _u32SampleRate, orxSTRINGID _stNameID, void *_pContext)

Filter callback function type to use with custom filters

Definition at line 124 of file orxSoundSystem.h.

◆ orxSOUNDSYSTEM_SAMPLE

typedef struct __orxSOUNDSYSTEM_SAMPLE_t orxSOUNDSYSTEM_SAMPLE

Definition at line 58 of file orxSoundSystem.h.

◆ orxSOUNDSYSTEM_SOUND

typedef struct __orxSOUNDSYSTEM_SOUND_t orxSOUNDSYSTEM_SOUND

Abstract sound structures

Definition at line 57 of file orxSoundSystem.h.

Enumeration Type Documentation

◆ orxSOUND_FILTER_TYPE

enum orxSOUND_FILTER_TYPE

Sound filter type enum

Enumerator
orxSOUND_FILTER_TYPE_BIQUAD 
orxSOUND_FILTER_TYPE_LOW_PASS 
orxSOUND_FILTER_TYPE_HIGH_PASS 
orxSOUND_FILTER_TYPE_BAND_PASS 
orxSOUND_FILTER_TYPE_LOW_SHELF 
orxSOUND_FILTER_TYPE_HIGH_SHELF 
orxSOUND_FILTER_TYPE_NOTCH 
orxSOUND_FILTER_TYPE_PEAKING 
orxSOUND_FILTER_TYPE_DELAY 
orxSOUND_FILTER_TYPE_CUSTOM 
orxSOUND_FILTER_TYPE_NUMBER 
orxSOUND_FILTER_TYPE_NONE 

Definition at line 103 of file orxSoundSystem.h.

◆ orxSOUNDSYSTEM_STATUS

enum orxSOUNDSYSTEM_STATUS

Sound system status enum

Enumerator
orxSOUNDSYSTEM_STATUS_PLAY 
orxSOUNDSYSTEM_STATUS_PAUSE 
orxSOUNDSYSTEM_STATUS_STOP 
orxSOUNDSYSTEM_STATUS_NUMBER 
orxSOUNDSYSTEM_STATUS_NONE 

Definition at line 89 of file orxSoundSystem.h.

◆ orxSOUNDSYSTEM_STREAM_TYPE

enum orxSOUNDSYSTEM_STREAM_TYPE

Sound system stream type enum

Enumerator
orxSOUNDSYSTEM_STREAM_TYPE_EMPTY 
orxSOUNDSYSTEM_STREAM_TYPE_WHITE 
orxSOUNDSYSTEM_STREAM_TYPE_PINK 
orxSOUNDSYSTEM_STREAM_TYPE_BROWNIAN 
orxSOUNDSYSTEM_STREAM_TYPE_SINE 
orxSOUNDSYSTEM_STREAM_TYPE_SQUARE 
orxSOUNDSYSTEM_STREAM_TYPE_TRIANGLE 
orxSOUNDSYSTEM_STREAM_TYPE_SAWTOOTH 
orxSOUNDSYSTEM_STREAM_TYPE_RESOURCE 
orxSOUNDSYSTEM_STREAM_TYPE_NUMBER 
orxSOUNDSYSTEM_STREAM_TYPE_NONE 

Definition at line 62 of file orxSoundSystem.h.

Function Documentation

◆ orxSoundSystem_AddBusFilter()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_AddBusFilter ( orxHANDLE _hBus,
const orxSOUND_FILTER_DATA * _pstFilterData,
orxBOOL _bUseCustomParam )
extern

Adds a filter to a bus (cascading)

Parameters
[in]_hBusConcerned bus
[in]_pstFilterDataConcerned filter data
[in]_bUseCustomParamFilter uses custom parameters
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundSystem_AddFilter()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_AddFilter ( orxSOUNDSYSTEM_SOUND * _pstSound,
const orxSOUND_FILTER_DATA * _pstFilterData,
orxBOOL _bUseCustomParam )
extern

Adds a filter to a sound (cascading)

Parameters
[in]_pstSoundConcerned sound
[in]_pstFilterDataConcerned filter data
[in]_bUseCustomParamFilter uses custom parameters
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundSystem_CreateBus()

orxDLLAPI orxHANDLE orxFASTCALL orxSoundSystem_CreateBus ( orxSTRINGID _stBusID)
extern

Creates a bus

Parameters
[in]_stBusIDConcerned bus ID
Returns
orxHANDLE / orxHANDLE_UNDEFINED

◆ orxSoundSystem_CreateFromSample()

orxDLLAPI orxSOUNDSYSTEM_SOUND *orxFASTCALL orxSoundSystem_CreateFromSample ( orxHANDLE _hUserData,
const orxSOUNDSYSTEM_SAMPLE * _pstSample )
extern

Creates a sound from preloaded sample (can be played directly)

Parameters
[in]_hUserDataUser data to associate with this sound
[in]_pstSampleConcerned sample
Returns
orxSOUNDSYSTEM_SOUND / orxNULL

◆ orxSoundSystem_CreateSample()

orxDLLAPI orxSOUNDSYSTEM_SAMPLE *orxFASTCALL orxSoundSystem_CreateSample ( orxU32 _u32ChannelNumber,
orxU32 _u32FrameNumber,
orxU32 _u32SampleRate )
extern

Creates an empty sample

Parameters
[in]_u32ChannelNumberNumber of channels of the sample
[in]_u32FrameNumberNumber of frame of the sample (number of "samples" = number of frames * number of channels)
[in]_u32SampleRateSampling rate of the sample (ie. number of frames per second)
Returns
orxSOUNDSYSTEM_SAMPLE / orxNULL

◆ orxSoundSystem_CreateStream()

orxDLLAPI orxSOUNDSYSTEM_SOUND *orxFASTCALL orxSoundSystem_CreateStream ( orxHANDLE _hUserData,
orxSOUNDSYSTEM_STREAM_TYPE _eType,
orxU32 _u32ChannelNumber,
orxU32 _u32SampleRate )
extern

Creates an empty/noise/wave stream

Parameters
[in]_hUserDataUser data to associate with this sound
[in]_eTypeStream type (empty, white/pink/brownian noise, A4 (440Hz) sine/square/triangle/sawtooth wave)
[in]_u32ChannelNumberNumber of channels for the stream
[in]_u32SampleRateSampling rate of the stream (ie. number of frames per second)
Returns
orxSOUNDSYSTEM_SOUND / orxNULL

◆ orxSoundSystem_Delete()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_Delete ( orxSOUNDSYSTEM_SOUND * _pstSound)
extern

Deletes a sound

Parameters
[in]_pstSoundConcerned sound
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundSystem_DeleteBus()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_DeleteBus ( orxHANDLE _hBus)
extern

Deletes a bus

Parameters
[in]_hBusConcerned bus
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundSystem_DeleteSample()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_DeleteSample ( orxSOUNDSYSTEM_SAMPLE * _pstSample)
extern

Deletes a sound sample

Parameters
[in]_pstSampleConcerned sample
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundSystem_EnableListener()

orxDLLAPI void orxFASTCALL orxSoundSystem_EnableListener ( orxU32 _u32ListenerIndex,
orxBOOL _bEnable )
extern

Enables/disables a listener

Parameters
[in]_u32ListenerIndexConcerned listener index
[in]_bEnableEnable / disable

◆ orxSoundSystem_Exit()

orxDLLAPI void orxFASTCALL orxSoundSystem_Exit ( )
extern

Exits from the sound system module

◆ orxSoundSystem_GetDuration()

orxDLLAPI orxFLOAT orxFASTCALL orxSoundSystem_GetDuration ( const orxSOUNDSYSTEM_SOUND * _pstSound)
extern

Gets a sound duration

Parameters
[in]_pstSoundConcerned sound
Returns
Sound's duration (seconds)

◆ orxSoundSystem_GetGlobalVolume()

orxDLLAPI orxFLOAT orxFASTCALL orxSoundSystem_GetGlobalVolume ( )
extern

Gets global volume

Returns
Gobal volume

◆ orxSoundSystem_GetListenerCount()

orxDLLAPI orxU32 orxFASTCALL orxSoundSystem_GetListenerCount ( )
extern

Gets listener count

Returns
Listener count

◆ orxSoundSystem_GetListenerPosition()

orxDLLAPI orxVECTOR *orxFASTCALL orxSoundSystem_GetListenerPosition ( orxU32 _u32Index,
orxVECTOR * _pvPosition )
extern

Gets listener position

Parameters
[in]_u32IndexListener index, 0-based
[out]_pvPositionListener's position
Returns
orxVECTOR / orxNULL

◆ orxSoundSystem_GetPanning()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_GetPanning ( const orxSOUNDSYSTEM_SOUND * _pstSound,
orxFLOAT * _pfPanning,
orxBOOL * _pbMix )
extern

Gets a sound panning

Parameters
[in]_pstSoundConcerned Sound
[out]_pfPanningSound panning, -1.0f for full left, 0.0f for center, 1.0f for full right
[out]_pbMixLeft/Right channels are be mixed if orxTRUE or act like a balance otherwise
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundSystem_GetPitch()

orxDLLAPI orxFLOAT orxFASTCALL orxSoundSystem_GetPitch ( const orxSOUNDSYSTEM_SOUND * _pstSound)
extern

Gets a sound pitch

Parameters
[in]_pstSoundConcerned sound
Returns
Sound's pitch

◆ orxSoundSystem_GetPosition()

orxDLLAPI orxVECTOR *orxFASTCALL orxSoundSystem_GetPosition ( const orxSOUNDSYSTEM_SOUND * _pstSound,
orxVECTOR * _pvPosition )
extern

Gets a sound position

Parameters
[in]_pstSoundConcerned sound
[out]_pvPositionPosition to get
Returns
Sound's position

◆ orxSoundSystem_GetSampleInfo()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_GetSampleInfo ( const orxSOUNDSYSTEM_SAMPLE * _pstSample,
orxU32 * _pu32ChannelNumber,
orxU32 * _pu32FrameNumber,
orxU32 * _pu32SampleRate )
extern

Gets sample info

Parameters
[in]_pstSampleConcerned sample
[in]_pu32ChannelNumberNumber of channels of the sample
[in]_pu32FrameNumberNumber of frame of the sample (number of "samples" = number of frames * number of channels)
[in]_pu32SampleRateSampling rate of the sample (ie. number of frames per second)
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundSystem_GetSpatialization()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_GetSpatialization ( const orxSOUNDSYSTEM_SOUND * _pstSound,
orxFLOAT * _pfMinDistance,
orxFLOAT * _pfMaxDistance,
orxFLOAT * _pfMinGain,
orxFLOAT * _pfMaxGain,
orxFLOAT * _pfRollOff )
extern

Gets a sound spatialization information

Parameters
[in]_pstSoundConcerned Sound
[out]_pfMinDistanceMin distance, inside which the max gain will be used, will be strictly negative if the sound isn't spatialized
[out]_pfMaxDistanceMax distance, outside which the gain will stop decreasing, will be strictly negative if the sound isn't spatialized
[out]_pfMinGainMin gain in [0.0f - 1.0f]
[out]_pfMaxGainMax gain in [0.0f - 1.0f]
[out]_pfRollOffRollOff factor applied when interpolating the gain between inner and outer distances, defaults to 1.0f
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundSystem_GetStatus()

orxDLLAPI orxSOUNDSYSTEM_STATUS orxFASTCALL orxSoundSystem_GetStatus ( const orxSOUNDSYSTEM_SOUND * _pstSound)
extern

Gets a sound status (play/pause/stop)

Parameters
[in]_pstSoundConcerned sound
Returns
orxSOUNDSYSTEM_STATUS

◆ orxSoundSystem_GetTime()

orxDLLAPI orxFLOAT orxFASTCALL orxSoundSystem_GetTime ( const orxSOUNDSYSTEM_SOUND * _pstSound)
extern

Gets a sound's time (ie. cursor/play position from beginning)

Parameters
[in]_pstSoundConcerned sound
Returns
Sound's time (cursor/play position), in seconds

◆ orxSoundSystem_GetVolume()

orxDLLAPI orxFLOAT orxFASTCALL orxSoundSystem_GetVolume ( const orxSOUNDSYSTEM_SOUND * _pstSound)
extern

Gets a sound volume

Parameters
[in]_pstSoundConcerned sound
Returns
Sound's volume

◆ orxSoundSystem_HasRecordingSupport()

orxDLLAPI orxBOOL orxFASTCALL orxSoundSystem_HasRecordingSupport ( )
extern

Is recording possible on the current system?

Returns
orxTRUE / orxFALSE

◆ orxSoundSystem_Init()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_Init ( )
extern

Inits the sound system module

Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundSystem_IsListenerEnabled()

orxDLLAPI orxBOOL orxFASTCALL orxSoundSystem_IsListenerEnabled ( orxU32 _u32ListenerIndex)
extern

Is listener enabled?

Parameters
[in]_u32ListenerIndexConcerned listener index
Returns
orxTRUE if enabled, orxFALSE otherwise

◆ orxSoundSystem_IsLooping()

orxDLLAPI orxBOOL orxFASTCALL orxSoundSystem_IsLooping ( const orxSOUNDSYSTEM_SOUND * _pstSound)
extern

Is sound looping?

Parameters
[in]_pstSoundConcerned sound
Returns
orxTRUE if looping, orxFALSE otherwise

◆ orxSoundSystem_LoadSample()

orxDLLAPI orxSOUNDSYSTEM_SAMPLE *orxFASTCALL orxSoundSystem_LoadSample ( const orxSTRING _zFilename)
extern

Loads a sound sample from file (cannot be played directly)

Parameters
[in]_zFilenameName of the file to load as a sample (completely loaded in memory, useful for sound effects)
Returns
orxSOUNDSYSTEM_SAMPLE / orxNULL

◆ orxSoundSystem_LoadStream()

orxDLLAPI orxSOUNDSYSTEM_SOUND *orxFASTCALL orxSoundSystem_LoadStream ( orxHANDLE _hUserData,
const orxSTRING _zFilename )
extern

Loads a streamed sound (can be played directly)

Parameters
[in]_hUserDataUser data to associate with this sound
[in]_zFilenameName of the file to load as a stream (won't be completely loaded in memory, useful for musics)
Returns
orxSOUNDSYSTEM_SOUND / orxNULL

◆ orxSoundSystem_Loop()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_Loop ( orxSOUNDSYSTEM_SOUND * _pstSound,
orxBOOL _bLoop )
extern

Loops a sound

Parameters
[in]_pstSoundConcerned sound
[in]_bLoopLoop / no loop
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundSystem_Pause()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_Pause ( orxSOUNDSYSTEM_SOUND * _pstSound)
extern

Pauses a sound

Parameters
[in]_pstSoundConcerned sound
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundSystem_Play()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_Play ( orxSOUNDSYSTEM_SOUND * _pstSound)
extern

Plays a sound

Parameters
[in]_pstSoundConcerned sound
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundSystem_RemoveAllBusFilters()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_RemoveAllBusFilters ( orxHANDLE _hBus)
extern

Removes all filters from a bus

Parameters
[in]_hBusConcerned bus
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundSystem_RemoveAllFilters()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_RemoveAllFilters ( orxSOUNDSYSTEM_SOUND * _pstSound)
extern

Removes all filters from a sound

Parameters
[in]_pstSoundConcerned sound
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundSystem_RemoveLastBusFilter()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_RemoveLastBusFilter ( orxHANDLE _hBus)
extern

Removes last added filter from a bus

Parameters
[in]_hBusConcerned bus
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundSystem_RemoveLastFilter()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_RemoveLastFilter ( orxSOUNDSYSTEM_SOUND * _pstSound)
extern

Removes last added filter from a sound

Parameters
[in]_pstSoundConcerned sound
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundSystem_SetBus()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_SetBus ( orxSOUNDSYSTEM_SOUND * _pstSound,
orxHANDLE _hBus )
extern

Sets a sound's bus

Parameters
[in]_pstSoundConcerned sound
[in]_hBusConcerned bus
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundSystem_SetBusParent()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_SetBusParent ( orxHANDLE _hBus,
orxHANDLE _hParentBus )
extern

Sets a bus's parent

Parameters
[in]_hBusConcerned bus
[in]_hParentBusHandle of the bus to use as parent
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundSystem_SetGlobalVolume()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_SetGlobalVolume ( orxFLOAT _fGlobalVolume)
extern

Sets global volume

Parameters
[in]_fGlobalVolumeGlobal volume to set
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundSystem_SetListenerPosition()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_SetListenerPosition ( orxU32 _u32Index,
const orxVECTOR * _pvPosition )
extern

Sets listener position

Parameters
[in]_u32IndexListener index, 0-based
[in]_pvPositionDesired position
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundSystem_SetPanning()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_SetPanning ( orxSOUNDSYSTEM_SOUND * _pstSound,
orxFLOAT _fPanning,
orxBOOL _bMix )
extern

Sets a sound panning

Parameters
[in]_pstSoundpanning
[in]_fPanningSound panning, -1.0f for full left, 0.0f for center, 1.0f for full right
[in]_bMixLeft/Right channels will be mixed if orxTRUE or act like a balance otherwise
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundSystem_SetPitch()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_SetPitch ( orxSOUNDSYSTEM_SOUND * _pstSound,
orxFLOAT _fPitch )
extern

Sets a sound pitch

Parameters
[in]_pstSoundConcerned sound
[in]_fPitchPitch to set
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundSystem_SetPosition()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_SetPosition ( orxSOUNDSYSTEM_SOUND * _pstSound,
const orxVECTOR * _pvPosition )
extern

Sets a sound position

Parameters
[in]_pstSoundConcerned sound
[in]_pvPositionPosition to set
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundSystem_SetSampleData()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_SetSampleData ( orxSOUNDSYSTEM_SAMPLE * _pstSample,
const orxFLOAT * _afData,
orxU32 _u32SampleNumber )
extern

Sets sample data

Parameters
[in]_pstSampleConcerned sample
[in]_afDataData to set (samples are expected to be signed/normalized)
[in]_u32SampleNumberNumber of samples in the data array
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundSystem_SetSpatialization()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_SetSpatialization ( orxSOUNDSYSTEM_SOUND * _pstSound,
orxFLOAT _fMinDistance,
orxFLOAT _fMaxDistance,
orxFLOAT _fMinGain,
orxFLOAT _fMaxGain,
orxFLOAT _fRollOff )
extern

Sets a sound spatialization, with gain decreasing between the minimum and maximum distances, when enabled

Parameters
[in]_pstSoundConcerned Sound
[in]_fMinDistanceMin distance, inside which the max gain will be used, strictly negative value to disable spatialization entirely
[in]_fMaxDistanceMax distance, outside which the gain will stop decreasing, strictly negative value to disable spatialization entirely
[in]_fMinGainMin gain in [0.0f - 1.0f]
[in]_fMaxGainMax gain in [0.0f - 1.0f]
[in]_fRollOffRollOff factor applied when interpolating the gain between inner and outer distances, defaults to 1.0f
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundSystem_SetTime()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_SetTime ( orxSOUNDSYSTEM_SOUND * _pstSound,
orxFLOAT _fTime )
extern

Sets a sound time (ie. cursor/play position from beginning)

Parameters
[in]_pstSoundConcerned sound
[in]_fTimeTime, in seconds
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundSystem_Setup()

orxDLLAPI void orxFASTCALL orxSoundSystem_Setup ( )
extern

Sound system module setup

◆ orxSoundSystem_SetVolume()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_SetVolume ( orxSOUNDSYSTEM_SOUND * _pstSound,
orxFLOAT _fVolume )
extern

Sets a sound volume

Parameters
[in]_pstSoundConcerned sound
[in]_fVolumeVolume to set [0, 1]
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundSystem_StartRecording()

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

Starts recording

Parameters
[in]_zNameName for the recorded sound/file
[in]_bWriteToFileShould write to file?
[in]_u32SampleRateSample rate, 0 for default rate (48000Hz)
[in]_u32ChannelNumberChannel number, 0 for default mono channel
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundSystem_Stop()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_Stop ( orxSOUNDSYSTEM_SOUND * _pstSound)
extern

Stops a sound

Parameters
[in]_pstSoundConcerned sound
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundSystem_StopRecording()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundSystem_StopRecording ( )
extern

Stops recording

Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
Generated for orx by doxygen 1.8.11