◆ SetBusEffect() [1/2]

AKSOUNDENGINE_API AKRESULT AK::SoundEngine::SetBusEffect	(	AkUniqueID	in_audioNodeID,
		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: 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_Success when successfully posted.
AK_IDNotFound if the Bus isn't found by in_audioNodeID
AK_InvalidParameter if in_uFXIndex isn't in range

Parameters

in_audioNodeID	Bus Short ID.
in_uFXIndex	Effect slot index (0-254)
in_shareSetID	ShareSets ID; pass AK_INVALID_UNIQUE_ID to clear the Effect slot

Wwise SDK

SetBusEffect

◆ SetBusEffect() [1/2]

Was this page helpful?

Need Support?

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