A subsystem that manages SoundSource, SoundBuffer, AudioFilter and AudioEffect used in your application. The interface below gives you access to the current settings, configuration current capabilities of the audio device running on the system.

The interface also below provides the necessary API to control and manage the AudioEffect slots used in your application.

Static Variables

Name	Description
`soundconfig`	Current SfxConfig of the subsystem.
Declaration SfxConfig soundconfig
`soundsettings`	Active SfxSettings of the subsystem.
Declaration SfxSettings soundsettings
`buffer_count`	Total amount of SoundBuffer currently maintained by the subsystem.
Declaration unsigned int buffer_count
`source_count`	Total of unique SoundSource actively maintained by the subsytem.
Declaration unsigned int source_count
`mono_count`	Current amount of mono SoundSource.
Declaration unsigned short mono_count
`stereo_count`	Current amount of stereo SoundSource.
Declaration unsigned char stereo_count
`playlist_count`	Active number of entries in the playlist queue.
Declaration unsigned short playlist_count
`device_specifier`	Internal name of the sound device.
Declaration char *device_specifier
`capture_device_specifier`	Internal name of the capture device.
Declaration char *capture_device_specifier

Variables

Name Description

effectslot_mask Bit mask of EffectSlot that determine which slot are active.

Declaration

int effectslot_mask

Functions

Name	Description
`SetAudioEffect`	Assign an existing AudioEffect to a specific slot.
Declaration bool SetAudioEffect( unsigned char slot, AudioEffect audioeffect ) Parameters* `slot`: Slot index (from 0 to 3). `audioeffect`: Reference to a valid AudioEffect; set `nil` to disconnect the Asset. Return Value `true` on success; `false` if the slot index provided is invalid.
`ClearAudioEffects`	Clear all AudioEffect slots.
Declaration void ClearAudioEffects( void )
`GetAudioEffect`	Retrieve the AudioEffect reference that is connected to a specific slot.
Declaration AudioEffect GetAudioEffect( unsigned char slot ) Parameters* `slot`: Index of the AudioEffect slot. Return Value `nil` if no AudioEffect is connected to the slot or if the slot index is invalid; else return the reference of the AudioEffect connected to the slot.
`SetAudioEffectGain`	Modify the gain of an existing AudioEffect slot.
Declaration bool SetAudioEffectGain( unsigned char slot, float gain ) Parameters `slot`: Index of the AudioEffect slot. `gain`: The new gain value to apply to the slot. Return Value `false` if the slot index is invalid; else return `true` if the gain have been successfully changed.
`GetEffectSlotGain`	Helper to retrieve the gain set for a specific AudioEffect slot.
Declaration float GetEffectSlotGain( unsigned char slot ) Parameters `slot`: Index of the AudioEffect slot. Return Value The amount of gain set for the slot; else return `0.0` if the index is invalid.