Sfx

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.

See Also

Static Variables


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

Variables


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

Functions


Name Description
SetAudioEffect Assign an existing AudioEffect to a specific slot.
ClearAudioEffects Clear all AudioEffect slots.
GetAudioEffect Retrieve the AudioEffect reference that is connected to a specific slot.
SetAudioEffectGain Modify the gain of an existing AudioEffect slot.
GetEffectSlotGain Helper to retrieve the gain set for a specific AudioEffect slot.




NRG - API 2022.4.384543 - Fri Nov 4 2022
Copyright © 2022 nrgcore.com. All Rights Reserved. Terms of Service - Privacy Policy - EULA