Other Documentation

Wwise SDK 2022.1.8

◆ SetBusEffect() [2/2]

AKSOUNDENGINE_API AKRESULT AK::SoundEngine::SetBusEffect ( const char *  in_pszBusName,
AkUInt32  in_uFXIndex,
AkUniqueID  in_shareSetID 

Sets an Effect ShareSet at the specified Bus and Effect slot index.

Note: Replacing effects is preferably done through a Set Effect Event Action.

The Bus can either be an Audio Bus or an Auxiliary Bus. This adds a reference on the audio node to an existing ShareSet.

Note: This function has unspecified behavior when adding an Effect to a currently playing Bus which does not have any effects, or removing the last Effect on a currently playing bus.
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 on the node. If the target node is not at the top of the hierarchy and is in the Actor-Mixer Hierarchy, the option "Override Parent" in the Effect section in Wwise must be enabled for this node, otherwise the parent's Effect will still be the one in use and the call to SetBusEffect will have no impact.
  • AK_Success when successfully posted.
  • AK_IDNotFound if the Bus name doesn't point to a valid bus.
  • AK_InvalidParameter if in_uFXIndex isn't in range
  • AK_InvalidID if in_pszBusName is null
in_pszBusName Bus name
in_uFXIndex Effect slot index (0-3)
in_shareSetID ShareSets ID; pass AK_INVALID_UNIQUE_ID to clear the effect slot

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