Creates an object of type 'type', as a child of 'parent'. Refer to 导入音频文件和创建架构 for more information about creating objects. Also refer to ak.wwise.core.audio.import to import audio files to Wwise.

Supported by

Graphical User Interface, Command-Line Interface.

Arguments

(Required *)

Arguments Details

parent

description : The ID (GUID), name, or path of the parent of the new object.
Possibilities, one of the following :

1) type : string
pattern : ^(StateGroup|SwitchGroup|SoundBank|GameParameter|Event|Effect|AudioDevice|Trigger|Attenuation|DialogueEvent|Bus|AuxBus|Conversion|ModulatorLfo|ModulatorEnvelope|ModulatorTime|Platform|Language|AcousticTexture):[a-zA-Z_]+[a-zA-Z0-9_]*$
description : The name of the object qualified by its type in the form of type:name. Only object types that have globally-unique names are supported.

2) type : string
pattern : ^\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\}$

3) type : string
pattern : ^\

type

type : string
description : The type of the new object. Refer to Wwise Objects Reference for possible object types.

name

type : string
description : The name of the new object.

onNameConflict

type : string
description : The action to take if "parent" already has a child with the same name. Default value is "fail". Refer to 理解名称冲突模式 for more information.
Possible values : "rename", "replace", "fail", "merge"

platform

description : The ID (GUID) of the platform used when setting properties via this command. Not specifying a platform sets the value for all linked platforms.
type : string
pattern : ^\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\}$

notes

type : string

autoAddToSourceControl

type : boolean
description : Determines if Wwise will automatically perform an Add or Checkout operation on the imported files with the source control. Defaults to false.

children

type : array
description : A list of child objects to be created.

argsSchema / children / ...

items

type : object

(Required *)

argsSchema / children / items / ...

patternProperties

^@[:_a-zA-Z0-9]+$

description : Sets the value of property @propertyName. Refer to Wwise Objects Reference for property names.
Possibilities, one of the following :

1) type : null

2) type : string

3) type : number

4) type : boolean

Result

Result Details

id

description : The ID (GUID) of the newly created Object.
type : string
pattern : ^\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\}$

name

type : string
description : The name of the newly created Object.

children

type : array
Possible types : or object

resultSchema / children / ...

id

type : string
pattern : ^\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\}$

resultSchema / children / ...

name

type : string

resultSchema / children / ...

children

Reference : : See Arguments "children"

Examples :

Create a Sound object.

Create a new Sound object called 'Boom' under the specified parent.

Arguments:

Result:

Create a virtual folder.

Create a new virtual folder called 'Guns' under the default work unit. If a folder with the same name already exists, it will automatically find a unique name.

Arguments:

Result:

Create a Play Event on a Sound

Create an event called 'Play_SFX' under the virtual folder 'WAAPI', with Play action on the SFX sound object.

Arguments:

Result:

Create a Random Container with 2 sound objects.

Create a Random Container called 'Boom' under the specified parent, with two Sound objects 'A' and 'B'.

Arguments:

Result:

Detailed JSON Schema

Arguments :

Options :

Response :

Document version : 1