Other Documentation

Wwise SDK 2022.1.8

◆ 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: Replacing effects is preferably done through a Set Effect Event Action.
Note: Make sure the new effect shareset is included in a soundbank, and that sound bank is loaded. Otherwise you will see errors in the Capture Log.
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: Errors are reported in the Wwise Capture Log if the effect cannot be set on the output device.
Always returns AK_Success
in_outputDeviceID Output ID, as returned from AddOutput or GetOutputID. Most of the time this should be 0 to designate the main (default) output
in_uFXIndex Effect slot index (0-3)
in_FXShareSetID Effect ShareSet ID

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