Version

    Other Documentation

menu_open
Wwise SDK 2021.1.14

◆ SetOutputDeviceEffect()

AKSOUNDENGINE_API AKRESULT AK::SoundEngine::SetOutputDeviceEffect ( AkOutputDeviceID  in_outputDeviceID,
AkUInt32  in_uFXIndex,
AkUniqueID  in_FXShareSetID 
)

Sets an audio device effect shareset on the specified output device and effect slot index.

Note: This function will replace existing effects of the audio device shareset.
Note: Audio device effects support is limited to one shareset per plug-in type at any time.
Note: Monitor errors are reported in the Wwise Capture Log if the effect cannot be set on the output device.
Returns
Always returns AK_Success.
Parameters
in_outputDeviceID Output ID, as returned from AddOutput or GetOutputID. You can pass 0 for the main (default) output
in_uFXIndex Effect slot index (0-3)
in_FXShareSetID Effect ShareSet ID; pass AK_INVALID_UNIQUE_ID to use the effect from the Audio Device ShareSet.

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise