Table of Contents

AKRESULT __cdecl 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. 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.gif
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.gif
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.
Returns:
AK_IDNotFound is name not resolved, returns AK_Success otherwise.
Parameters:
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