Version
menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2022.1.17.8543 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.
Wwise SDK 2022.1.17

◆ SetActorMixerEffect()

AKSOUNDENGINE_API AKRESULT AK::SoundEngine::SetActorMixerEffect ( AkUniqueID  in_audioNodeID,
AkUInt32  in_uFXIndex,
AkUniqueID  in_shareSetID 
)

Sets an Effect ShareSet at the specified audio node and Effect slot index.

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

The target node cannot be a Bus, to set effects on a bus, use SetBusEffect() instead.

Note: 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 SetActorMixerEffect will have no impact.
Returns
Always returns AK_Success
Parameters
in_audioNodeIDCan be a member of the Actor-Mixer or Interactive Music Hierarchy (not a bus).
in_uFXIndexEffect slot index (0-3)
in_shareSetIDShareSets 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