Warning: you were redirected to the latest documentation corresponding to your major release ( 2023.1.8.8601 ). 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.

Wwise SDK 2023.1.8

Creates an object of type 'type', as a child of 'parent'. Refer to Importing Audio Files and Creating Structures for more information about creating objects. Also refer to ak.wwise.core.audio.import to import audio files to Wwise. To create Effect or Source plug-ins, use ak.wwise.core.object.set, and refer to Wwise Objects Reference for the classId.

Arguments

Name	Type	Description
parent *	any of:	The ID (GUID), name, or path of the parent of the new object.
	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.
list	string	The name of the list in which to insert the object. If this argument is set, the object gets inserted in a list owned by the parent and not as a child.
onNameConflict	string	The action to take if "parent" already has a child with the same name. Default value is "fail". Refer to Understanding the name conflict modes for more information. Possible values: rename replace fail merge
platform	any of:	The ID (GUID) or unique name of the platform used when setting properties via this command. Not specifying a platform sets the value for all linked platforms.
	string	The name of the object.
	string	An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
autoAddToSourceControl	boolean	Determines if Wwise automatically performs an Add source control operation for affected work units. Defaults to true.
type *	string	The type of the new object. Refer to Wwise Objects Reference for possible object types.
name *	string	The name of the new object.
notes	string	The notes or comments of the new object.
children	array	An array of child objects to be created.
children [...]	object	A child objects to be created.
children[...].type *	string	The type of the new object. Refer to Wwise Objects Reference for possible object types or Wwise Nodes Reference for possible node types
children[...].name *	string	The name of the new object.
children[...].notes	string	The notes or comments of the new object.
children[...].children		An array of child objects to be created (Recursive).
children[...].regex(^@[:_a-zA-Z0-9]+$)	any of:	Sets the value of property @propertyName. Refer to Wwise Objects Reference for property names. 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.
regex(^@[:_a-zA-Z0-9]+$)	any of:	Sets the value of property @propertyName. Refer to Wwise Objects Reference for property names. 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 *)

Arguments Schema

Result

Name	Type	Description
id	string	The ID (GUID) of the newly created Object. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
name	string	The name of the newly created Object.
children	array	The children of objects created.
children [...]	object	An object created.
children[...].id	string	The ID (GUID) of the newly created Object. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
children[...].name	string	The name of the newly created Object.
children[...].children	array	The children of objects created.
children[...].children [...]		An object created.

Result Schema

Examples

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

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.

Get started with Wwise

Wwise SDK

ak.wwise.core.object.create