Version
menu

Wwise SDK 2025.1.0
AkCmd_ReplaceOutput Struct Reference

#include <AkCommandTypes.h>

Public Attributes

AkOutputDeviceID outputDeviceID
 ID of output device to replace. This can be obtained from AK_SoundEngine_GetOutputID. Set to 0 to replace the primary output. More...
 
struct AkOutputSettings settings
 Creation parameters for the new output. AkOutputSettings. More...
 

Detailed Description

Replaces an output device previously created during engine initialization or from AkCmd_AddOutput, with a new output device. In addition to simply removing one output device and adding a new one, the new output device will also be used on all of the master buses that the old output device was associated with, and preserve all listeners that were attached to the old output device.

This command can fail for the following reasons:

  • AK_InvalidParameter: Out of range parameters or unsupported parameter combinations.
  • AK_IDNotFound: The audioDeviceShareset on 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.
See also

Definition at line 893 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