Warning: you were redirected to the latest documentation corresponding to your major release ( 2018.1.11.6987 ). 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.
|
◆ SetBusEffect() [1/2]
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: 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
- Always returns AK_Success
- Parameters
-
in_audioNodeID |
Bus Short ID. |
in_uFXIndex |
Effect slot index (0-3) |
in_shareSetID |
ShareSets ID; pass AK_INVALID_UNIQUE_ID to clear the Effect slot |
|
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