API Reference

Functions

void iplFMODGetVersion(unsigned int *major, unsigned int *minor, unsigned int *patch)

Returns the version of the FMOD Studio integration being used.

Parameters

• major – Major version number. For example, “1” in “1.2.3”.

• minor – Minor version number. For example, “2” in “1.2.3”.

• patch – Patch version number. For example, “3” in “1.2.3”.

void iplFMODInitialize(IPLContext context)

Initializes the FMOD Studio integration.

This function must be called before creating any Steam Audio DSP effects.

Parameters

context – The Steam Audio context created by the game engine when initializing Steam Audio.

void iplFMODTerminate()

Shuts down the FMOD Studio integration.

This function must be called after all Steam Audio DSP effects have been destroyed.

void iplFMODSetHRTF(IPLHRTF hrtf)

Specifies the HRTF to use for spatialization in subsequent audio frames.

This function must be called once during initialization, after iplFMODInitialize. It should also be called whenever the game engine needs to change the HRTF.

Parameters

hrtf – The HRTF to use for spatialization.

void iplFMODSetSimulationSettings(IPLSimulationSettings simulationSettings)

Specifies the simulation settings used by the game engine for simulating direct and/or indirect sound propagation.

This function must be called once during initialization, after iplFMODInitialize.

Parameters

simulationSettings – The simulation settings used by the game engine.

void iplFMODSetReverbSource(IPLSource reverbSource)

Specifies the IPLSource object used by the game engine for simulating reverb.

Typically, listener-centric reverb is simulated by creating an IPLSource object with the same position as the listener, and simulating reflections. To render this simulated reverb, call this function and pass it the IPLSource object used.

Parameters

reverbSource – The source object used by the game engine for simulating reverb.

DSP Parameters

Warning

doxygenenum: Cannot find enum “SpatializeEffect::Params” in doxygen xml output for project “SteamAudioFMOD” from directory: C:/buildslave/phonon_rel_win64/build/fmod/build/windows-vs2019-x64/doc/xml

Warning

doxygenenum: Cannot find enum “ReverbEffect::Params” in doxygen xml output for project “SteamAudioFMOD” from directory: C:/buildslave/phonon_rel_win64/build/fmod/build/windows-vs2019-x64/doc/xml

Warning

doxygenenum: Cannot find enum “MixerReturnEffect::Params” in doxygen xml output for project “SteamAudioFMOD” from directory: C:/buildslave/phonon_rel_win64/build/fmod/build/windows-vs2019-x64/doc/xml