Wwise SDK 2022.1.17

Executes a command. Some commands can take a list of objects as parameters. Refer to Wwise Authoring Command Identifiers for the available commands.

Arguments

Name	Type	Description
command *	string	The ID of the command to execute. Refer to Wwise Authoring Command Identifiers for the lists of commands.
objects	array	An array of objects. Each object is an ID (GUID), name, or path of the object. Some commands can take objects as arguments. Refer to the commands for more information.
objects [...]	any of:
	string	The name of the object qualified by its type or Short ID in the form of type:name or Global:shortId. Only object types that have globally-unique names or Short Ids are supported. Ex: Event:Play_Sound_01, Global:245489792
	string	An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
	string	A project path to a Wwise object, including the category and the work-unit. For example: \Actor-Mixer Hierarchy\Default Work Unit\New Sound SFX.
platforms	array	An array of platform. Each platform is an ID (GUID) or a unique name. Some commands can take platforms as arguments. Refer to the commands for more information.
platforms [...]	any of:
	string	The name of the object.
	string	An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
value	any of:	A value to pass to the command. Some commands can take a value as an argument. Refer to the commands for more information. The value of a property.
	null	A null value. No reference to an object.
	string	A string value.
	number	A numerical value.
	boolean	A boolean value.

(Required *)

Examples

Refer to Using the Wwise Authoring API (WAAPI) for more information about Wwise Authoring API.

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Get started with Wwise