Copies an object to the given parent.
Graphical User Interface, Command-Line Interface.
| Name | Type | Description |
|---|---|---|
| object * | The ID (GUID) or path of the object to be copied. | |
| parent * | The ID (GUID) or path of the object's new parent. | |
| onNameConflict | string | The action to take if "parent" already has a child with the same name. Default value is "fail". Possible values : "rename", "replace", "fail" |
(Required *)
description : The ID (GUID) or path of the object to be copied.
Possibilities, one of the following :
1) 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}\}$
2) type : string
pattern : ^\
description : The ID (GUID) or path of the object's new parent.
Possibilities, one of the following :
1) 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}\}$
2) type : string
pattern : ^\
type : string
description : The action to take if "parent" already has a child with the same name. Default value is "fail".
Possible values : "rename", "replace", "fail"
| Name | Type | Description |
|---|---|---|
| id | string | The ID (GUID) of the object. |
| name | string | The name of the object. |
| notes | string | The notes of the object. |
| type | string | The type of the object. Refer to Wwise Objects Reference for more information on the types available. |
| path | string | The path of the object from the project root. Ex: '\\Actor-Mixer Hierarchy\\Default Work Unit\\Sound1' |
| parent | object | The parent of the object in the hierarchy. |
| owner | object | The owner of the object. This applies to objects being locally owned by other objects, such as custom effects, custom attenuations, etc. |
| isPlayable | boolean | True if the object can be played in Transport. |
| shortId | integer | The short ID of the object. |
| classId | integer | The class ID of the object. |
| category | string | The category of the object. Ex: 'Actor-Mixer Hierarchy' |
| filePath | string | The path to the file containing the object. The path can be a work-unit file, or a project file. |
| workunit | object | The parent workunit containing the object. The 'id' and the 'name' will be returned. |
| childrenCount | number | The number of children for the object. |
| music:transitionRoot | object | The music transition root containing all other music transitions recursively. |
| music:playlistRoot | object | The music playlist root containing all other music playlist items recursively. This applies to Music Playlist Containers only. |
| sound:originalWavFilePath | string | Absolute path to the original wav file. Only valid for Sound and Audio Source objects. |
| sound:convertedWemFilePath | string | Absolute path to the converted wem file. Specify the platform in the options. Only valid for Sound and Audio Source objects. |
| soundbank:bnkFilePath | string | Absolute path to the generated SoundBank file associated with the SoundBank object. Only valid for SoundBank objects. |
| audioSource:playbackDuration | object | The duration root that contains the min and max durations and duration type |
| audioSource:maxDurationSource | object | |
| audioSource:trimValues | object | |
| audioSource:language | object | Language associated to the audio source. This only applies to Audio Source objects directly. |
| workunit:isDefault | boolean | True if the work unit is the default. |
| workunit:type | string | The type of the Work Unit. Please note that, like Work Units, physical folders have the type "WorkUnit". Physical folders will have the workunit:type "folder". Possible values : "folder", "rootFile", "nestedFile" |
| workunit:isDirty | boolean | True if a Work Unit or a Project (wproj file) is dirty, meaning it is modified but not saved. |
| switchContainerChild:context | object | The context object associated with the child of a Switch Container. This object holds the properties associated with the child that are context-dependent for the Switch Container (for example: property for the 1st only checkbox). |
description : The ID (GUID) of the 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}\}$
type : string
description : The name of the object.
type : string
description : The notes of the object.
type : string
description : The type of the object. Refer to Wwise Objects Reference for more information on the types available.
type : string
description : The path of the object from the project root. Ex: '\\Actor-Mixer Hierarchy\\Default Work Unit\\Sound1'
type : object
| Name | Type | Description |
|---|---|---|
| id | string | The ID (GUID) of the object. |
| name | string | The name of the object. |
description : The parent of the object in the hierarchy.
type : object
| Name | Type | Description |
|---|---|---|
| id | string | The ID (GUID) of the object. |
| name | string | The name of the object. |
description : The owner of the object. This applies to objects being locally owned by other objects, such as custom effects, custom attenuations, etc.
type : boolean
description : True if the object can be played in Transport.
type : integer
description : The short ID of the object.
description : The class ID of the object.
type : integer
minimum : 0
maximum : 4294967295
type : string
description : The category of the object. Ex: 'Actor-Mixer Hierarchy'
type : string
description : The path to the file containing the object. The path can be a work-unit file, or a project file.
type : object
| Name | Type | Description |
|---|---|---|
| id | string | The ID (GUID) of the object. |
| name | string | The name of the object. |
description : The parent workunit containing the object. The 'id' and the 'name' will be returned.
type : number
description : The number of children for the object.
type : object
| Name | Type | Description |
|---|---|---|
| id | string | The ID (GUID) of the object. |
description : The music transition root containing all other music transitions recursively.
type : object
| Name | Type | Description |
|---|---|---|
| id | string | The ID (GUID) of the object. |
description : The music playlist root containing all other music playlist items recursively. This applies to Music Playlist Containers only.
type : string
description : Absolute path to the original wav file. Only valid for Sound and Audio Source objects.
type : string
description : Absolute path to the converted wem file. Specify the platform in the options. Only valid for Sound and Audio Source objects.
type : string
description : Absolute path to the generated SoundBank file associated with the SoundBank object. Only valid for SoundBank objects.
type : object
| Name | Type | Description |
|---|---|---|
| playbackDurationMin | number | The minimum possible time playback can take |
| playbackDurationMax | number | The maximum possible time playback can take |
| playbackDurationType | string | The type of duration. |
description : The duration root that contains the min and max durations and duration type
type : object
| Name | Type | Description |
|---|---|---|
| id | string | The ID (GUID) of the audio source object with longest duration. |
| trimmedDuration | number | The duration in seconds of the longest trimmed source. |
type : object
| Name | Type | Description |
|---|---|---|
| trimBegin | number | The time value in seconds of the start trim |
| trimEnd | number | The time value in seconds of the end trim |
type : object
description : Language associated to the audio source. This only applies to Audio Source objects directly.
| Name | Type | Description |
|---|---|---|
| id | string | The ID (GUID) of the Language object to which the Audio Source object is associated. |
| name | string | The name of the Language object to which the Audio Source object is associated. |
type : boolean
description : True if the work unit is the default.
type : string
description : The type of the Work Unit. Please note that, like Work Units, physical folders have the type "WorkUnit". Physical folders will have the workunit:type "folder".
Possible values : "folder", "rootFile", "nestedFile"
type : boolean
description : True if a Work Unit or a Project (wproj file) is dirty, meaning it is modified but not saved.
type : object
| Name | Type | Description |
|---|---|---|
| id | string | The ID (GUID) of the object. |
description : The context object associated with the child of a Switch Container. This object holds the properties associated with the child that are context-dependent for the Switch Container (for example: property for the 1st only checkbox).
Copies object specified by the "object" ID and makes that copy a child of "parent". The object will be renamed if "parent" already contains a child with the same name.
{
"object": "{A076AA65-B71A-45BB-8841-5A20C52CE727}",
"parent": "{66666666-7777-8888-9999-AAAAAAAAAAAA}",
"onNameConflict": "rename"
}
{
"id": "{AAAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE}",
"name": "new_object_name",
"type": "Sound",
"path": "\\Actor-Mixer Hierarchy\\Default Work Unit\\Sound1",
"shortId": 1234
}
{
"type": "object",
"properties": {
"object": {
"description": "The ID (GUID) or path of the object to be copied.",
"anyOf": [
{
"type": "string",
"pattern": *Must be a valid GUID*
},
{
"type": "string",
"pattern": "^\\\\"
}
]
},
"parent": {
"description": "The ID (GUID) or path of the object's new parent.",
"anyOf": [
{
"type": "string",
"pattern": *Must be a valid GUID*
},
{
"type": "string",
"pattern": "^\\\\"
}
]
},
"onNameConflict": {
"type": "string",
"description": "The action to take if \"parent\" already has a child with the same name. Default value is \"fail\".",
"enum": [
"rename",
"replace",
"fail"
]
}
},
"required": [
"object",
"parent"
],
"additionalProperties": false
}
{
"type": "object",
"required": [],
"properties": {},
"additionalProperties": false
}
{
"description": "The copied object.",
"type": "object",
"properties": {
"id": {
"description": "The ID (GUID) of the object.",
"type": "string",
"pattern": *Must be a valid GUID*
},
"name": {
"type": "string",
"description": "The name of the object."
},
"notes": {
"type": "string",
"description": "The notes of the object."
},
"type": {
"type": "string",
"description": "The type of the object."
},
"path": {
"type": "string",
"description": "The path of the object from the project root. Ex: '\\Actor-Mixer Hierarchy\\Default Work Unit\\Sound1'"
},
"parent": {
"type": "object",
"properties": {
"id": {
"description": "The ID (GUID) of the object.",
"type": "string",
"pattern": *Must be a valid GUID*
},
"name": {
"type": "string",
"description": "The name of the object."
}
},
"description": "The parent of the object in the hierarchy."
},
"owner": {
"type": "object",
"properties": {
"id": {
"description": "The ID (GUID) of the object.",
"type": "string",
"pattern": *Must be a valid GUID*
},
"name": {
"type": "string",
"description": "The name of the object."
}
},
"description": "The owner of the object. This applies to objects being locally owned by other objects, such as custom effects, custom attenuations, etc."
},
"isPlayable": {
"type": "boolean",
"description": "True if the object can be played in Transport."
},
"shortId": {
"type": "integer",
"description": "The short ID of the object."
},
"classId": {
"description": "The class ID of the object.",
"type": "integer",
"minimum": 0,
"maximum": 4294967295
},
"category": {
"type": "string",
"description": "The category of the object. Ex: 'Actor-Mixer Hierarchy'"
},
"filePath": {
"type": "string",
"description": "The path to the file containing the object. The path can be a work-unit file, or a project file."
},
"workunit": {
"type": "object",
"properties": {
"id": {
"description": "The ID (GUID) of the object.",
"type": "string",
"pattern": *Must be a valid GUID*
},
"name": {
"type": "string",
"description": "The name of the object."
}
},
"description": "The parent workunit containing the object. The 'id' and the 'name' will be returned."
},
"childrenCount": {
"type": "number",
"description": "The number of children for the object."
},
"music:transitionRoot": {
"type": "object",
"properties": {
"id": {
"description": "The ID (GUID) of the object.",
"type": "string",
"pattern": *Must be a valid GUID*
}
},
"description": "The music transition root containing all other music transitions recursively."
},
"music:playlistRoot": {
"type": "object",
"properties": {
"id": {
"description": "The ID (GUID) of the object.",
"type": "string",
"pattern": *Must be a valid GUID*
}
},
"description": "The music playlist root containing all other music playlist items recursively. This applies to Music Playlist Containers only."
},
"sound:originalWavFilePath": {
"type": "string",
"description": "Absolute path to the original wav file. Only valid for Sound and Audio Source objects."
},
"sound:convertedWemFilePath": {
"type": "string",
"description": "Absolute path to the converted wem file. Specify the platform in the options. Only valid for Sound and Audio Source objects."
},
"soundbank:bnkFilePath": {
"type": "string",
"description": "Absolute path to the generated SoundBank file associated with the SoundBank object. Only valid for SoundBank objects."
},
"audioSource:playbackDuration": {
"type": "object",
"properties": {
"playbackDurationMin": {
"type": "number",
"description": "The minimum possible time playback can take"
},
"playbackDurationMax": {
"type": "number",
"description": "The maximum possible time playback can take"
},
"playbackDurationType": {
"type": "string",
"description": "The type of duration."
}
},
"description": "The duration root that contains the min and max durations and duration type"
},
"audioSource:maxDurationSource": {
"type": "object",
"properties": {
"id": {
"description": "The ID (GUID) of the audio source object with longest duration.",
"type": "string",
"pattern": *Must be a valid GUID*
},
"trimmedDuration": {
"type": "number",
"description": "The duration in seconds of the longest trimmed source."
}
}
},
"audioSource:trimValues": {
"type": "object",
"properties": {
"trimBegin": {
"type": "number",
"description": "The time value in seconds of the start trim"
},
"trimEnd": {
"type": "number",
"description": "The time value in seconds of the end trim"
}
}
},
"audioSource:language": {
"type": "object",
"description": "Language associated to the audio source. This only applies to Audio Source objects directly.",
"properties": {
"id": {
"description": "The ID (GUID) of the Language object to which the Audio Source object is associated.",
"type": "string",
"pattern": *Must be a valid GUID*
},
"name": {
"type": "string",
"description": "The name of the Language object to which the Audio Source object is associated."
}
}
},
"workunit:isDefault": {
"type": "boolean",
"description": "True if the work unit is the default."
},
"workunit:type": {
"type": "string",
"description": "The type of the Work Unit. Please note that, like Work Units, physical folders have the type \"WorkUnit\". Physical folders will have the workunit:type \"folder\".",
"enum": [
"folder",
"rootFile",
"nestedFile"
]
},
"workunit:isDirty": {
"type": "boolean",
"description": "True if a Work Unit or a Project (wproj file) is dirty, meaning it is modified but not saved."
},
"switchContainerChild:context": {
"type": "object",
"properties": {
"id": {
"description": "The ID (GUID) of the object.",
"type": "string",
"pattern": *Must be a valid GUID*
}
},
"description": "The context object associated with the child of a Switch Container. This object holds the properties associated with the child that are context-dependent for the Switch Container (for example: property for the 1st only checkbox)."
}
},
"patternProperties": {
"^@@?[_a-zA-Z0-9]+$": {
"description": "Specifies the property or reference value. A single @ specifies the value of the property for the associated object. A double @@ specifies the value of the property using the source of override.",
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"id": {
"description": "The ID (GUID) of the object.",
"type": "string",
"pattern": *Must be a valid GUID*
},
"name": {
"type": "string",
"description": "The name of the object."
}
}
}
]
}
},
"additionalProperties": false
}
Document version : 1
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