Version
menu
Wwise SDK 2025.1.4
List of all members | Public Attributes
AkCmd_SetGameObjectAuxSendValues Struct Reference

#include AkCommandTypes.h>

Public Attributes

AkGameObjectID gameObjectID
 Game Object ID. More...
 
AkUInt32 numValues
 Number of values. More...
 

Detailed Description

Sets the Auxiliary Busses to route the specified game object. To clear the game object's auxiliary sends, numValues must be 0.

The Sound Engine expects an array of AkAuxSendValue objects after the command. The number of items must correspond to the number of channels in channelConfig. For example: 

AkAuxSendValue values[2]; // Initialize array as required
auto cmd = (AkCmd_SetGameObjectAuxSendValues*)AK_CommandBuffer_Add(buffer, AkCommand_SetGameObjectAuxSendValues);
cmd->numValues = 2;
AK_CommandBuffer_AddArray(buffer, sizeof(AkAuxSendValue), cmd->numValues, values);

This command can fail for the following reasons:

  • AK_InvalidParameter: gameObjectID is outside the valid range, or incomplete array after the command.
  • AK_IDNotFound: gameObjectID is not a registered game object ID.
See also

Definition at line 444 of file AkCommandTypes.h.

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