|
Wwise SDK 2025.1.0
|
#include <AkCommandTypes.h>
Public Attributes | |
| struct AkOutputSettings | settings |
| Creation parameters for this output. AkOutputSettings. More... | |
| AkUInt32 | numListenerIDs |
| The number of listener IDs that follow the command. More... | |
Adds an output to the sound engine. Use this to add controller-attached headphones, controller speakers, DVR output, etc.
The settings parameter contains an Audio Device shareset to specify the output plugin to use and a device ID to specify the instance, if necessary (e.g. which game controller).
The Sound Engine can accept an array of AkGameObjectID objects after the command. These objects correspond to listener IDs attached to the output device. When specified, only the sounds routed to game objects linked to those listeners will play in this device. It is necessary to have separate listeners if multiple devices of the same type can coexist (e.g. controller speakers).
To attach listener IDs to the device being added:
auto cmd = (AkCmd_AddOutput*)AK_CommandBuffer_Add(buffer, AkCommand_AddOutput); // Fill out the command... cmd->numListenerIDs = mylistenerArray.size(); AK_CommandBuffer_AddArray(buffer, sizeof(AkGameObjectID), mylistenerArray.size(), mylistenerArray.data());
When numListenerIDs is 0, sound routing simply obey the associations between Master Busses and Audio Devices setup in the Wwise Project.
This command can fail for the following reasons:
AK_InvalidParameter: Out of range parameters or unsupported parameter combinations.AK_IDNotFound: The audioDeviceShareset in settings doesn't exist. Possibly, the Init bank isn't loaded yet or was not updated with latest changes.AK_InsufficientMemory: Not enough memory to complete the operation.AK_DeviceNotCompatible: Request output settings are incompatible with current system. A dummy output was created instead.Definition at line 859 of file AkCommandTypes.h.
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageRegister your project and we'll help you get started with no strings attached!
Get started with Wwise