Table of Contents

Wwise SDK 2018.1.11
ak.wwise.core.object.childAdded


Sent when an object is added as a child to another object.

Supported by

Graphical User Interface, Command-Line Interface.

Options

Name Type Description
return array Data to be returned for every child being added.
platform string The ID (GUID) of the platform.

Options Details


return

description : Data to be returned for every child being added.
type : array

optionsSchema / return / ...

items

Possibilities, one of the following :

1) type : string
description : Specifies one or many of the built-in accessors for Wwise objects.
Possible values : "id", "name", "notes", "type", "shortId", "classId", "category", "filePath", "workunit", "parent", "owner", "path", "isPlayable", "childrenCount", "sound:convertedWemFilePath", "sound:originalWavFilePath", "soundbank:bnkFilePath", "music:transitionRoot", "music:playlistRoot", "audioSource:playbackDuration", "audioSource:maxDurationSource", "audioSource:trimValues", "audioSource:maxRadiusAttenuation", "audioSource:language", "workunit:isDefault", "workunit:type", "workunit:isDirty", "switchContainerChild:context"

2) type : string
description : Specifies one or many property names for Wwise objects. Specifying a single @ returns the value of the property for the associated object. Specifying a double @@ returns the value of the property for the source of override. Refer to Wwise Objects Reference .
pattern : ^@@?[:_a-zA-Z0-9]+$

platform

description : The ID (GUID) of the platform.
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}\}$

Publications Format

Name Type Description
child * object The child object added.
parent * object The parent object where the object is added.

(Required *)

Publications Format Details


child

description : The child object added.
type : object

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. For using WAAPI on Mac, please refer to Using WAAPI on Mac .
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. For using WAAPI on Mac, please refer to Using WAAPI on Mac .
sound:convertedWemFilePath string Absolute path to the converted wem file. Specify the platform in the options. Only valid for Sound and Audio Source objects. For using WAAPI on Mac, please refer to Using WAAPI on Mac .
soundbank:bnkFilePath string Absolute path to the generated SoundBank file associated with the SoundBank object. Only valid for SoundBank objects. For using WAAPI on Mac, please refer to Using WAAPI on Mac .
audioSource:playbackDuration object The duration root that contains the min and max durations and duration type. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.
audioSource:maxDurationSource object Audio source with longest duration. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.
audioSource:trimValues object Range of time for which the audio source is trimmed.
audioSource:maxRadiusAttenuation object Attenuation with the largest radius. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.
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).


publishSchema / child / ...

id

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}\}$

publishSchema / child / ...

name

type : string
description : The name of the object.

publishSchema / child / ...

notes

type : string
description : The notes of the object.

publishSchema / child / ...

type

type : string
description : The type of the object. Refer to Wwise Objects Reference for more information on the types available.

publishSchema / child / ...

path

type : string
description : The path of the object from the project root. Ex: '\\Actor-Mixer Hierarchy\\Default Work Unit\\Sound1'

publishSchema / child / ...

parent

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.

publishSchema / child / ...

owner

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.

publishSchema / child / ...

isPlayable

type : boolean
description : True if the object can be played in Transport.

publishSchema / child / ...

shortId

type : integer
description : The short ID of the object.

publishSchema / child / ...

classId

description : The class ID of the object.
type : integer
minimum : 0
maximum : 4294967295

publishSchema / child / ...

category

type : string
description : The category of the object. Ex: 'Actor-Mixer Hierarchy'

publishSchema / child / ...

filePath

type : string
description : The path to the file containing the object. The path can be a Work Unit file or a project file. For using WAAPI on Mac, please refer to Using WAAPI on Mac .

publishSchema / child / ...

workunit

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.

publishSchema / child / ...

childrenCount

type : number
description : The number of children for the object.

publishSchema / child / ...

music:transitionRoot

type : object

Name Type Description
id string The ID (GUID) of the object.

description : The music transition root containing all other music transitions recursively.

publishSchema / child / ...

music:playlistRoot

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.

publishSchema / child / ...

sound:originalWavFilePath

type : string
description : Absolute path to the original wav file. Only valid for Sound and Audio Source objects. For using WAAPI on Mac, please refer to Using WAAPI on Mac .

publishSchema / child / ...

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. For using WAAPI on Mac, please refer to Using WAAPI on Mac .

publishSchema / child / ...

soundbank:bnkFilePath

type : string
description : Absolute path to the generated SoundBank file associated with the SoundBank object. Only valid for SoundBank objects. For using WAAPI on Mac, please refer to Using WAAPI on Mac .

publishSchema / child / ...

audioSource:playbackDuration

type : object
description : The duration root that contains the min and max durations and duration type. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.

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.


publishSchema / child / ...

audioSource:maxDurationSource

type : object
description : Audio source with longest duration. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.

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.


publishSchema / child / ...

audioSource:trimValues

type : object
description : Range of time for which the audio source is trimmed.

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.


publishSchema / child / ...

audioSource:maxRadiusAttenuation

type : object
description : Attenuation with the largest radius. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.

Name Type Description
id string The ID (GUID) of the attenuation object with the largest radius.
radius number The radius of the attenuation object.


publishSchema / child / ...

audioSource:language

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.


publishSchema / child / ...

workunit:isDefault

type : boolean
description : True if the work unit is the default.

publishSchema / child / ...

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".
Possible values : "folder", "rootFile", "nestedFile"

publishSchema / child / ...

workunit:isDirty

type : boolean
description : True if a Work Unit or a Project (wproj file) is dirty, meaning it is modified but not saved.

publishSchema / child / ...

switchContainerChild:context

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).


publishSchema / child / ...

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. Refer to Wwise Objects Reference for more information on the properties and references for all types available.
Possibilities, one of the following :

1) type : string

2) type : number

3) type : boolean

4) type : object

Name Type Description
id string The ID (GUID) of the object.
name string The name of the object.


parent

description : The parent object where the object is added.
type : object

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. For using WAAPI on Mac, please refer to Using WAAPI on Mac .
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. For using WAAPI on Mac, please refer to Using WAAPI on Mac .
sound:convertedWemFilePath string Absolute path to the converted wem file. Specify the platform in the options. Only valid for Sound and Audio Source objects. For using WAAPI on Mac, please refer to Using WAAPI on Mac .
soundbank:bnkFilePath string Absolute path to the generated SoundBank file associated with the SoundBank object. Only valid for SoundBank objects. For using WAAPI on Mac, please refer to Using WAAPI on Mac .
audioSource:playbackDuration object The duration root that contains the min and max durations and duration type. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.
audioSource:maxDurationSource object Audio source with longest duration. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.
audioSource:trimValues object Range of time for which the audio source is trimmed.
audioSource:maxRadiusAttenuation object Attenuation with the largest radius. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.
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).


publishSchema / parent / ...

id

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}\}$

publishSchema / parent / ...

name

type : string
description : The name of the object.

publishSchema / parent / ...

notes

type : string
description : The notes of the object.

publishSchema / parent / ...

type

type : string
description : The type of the object. Refer to Wwise Objects Reference for more information on the types available.

publishSchema / parent / ...

path

type : string
description : The path of the object from the project root. Ex: '\\Actor-Mixer Hierarchy\\Default Work Unit\\Sound1'

publishSchema / parent / ...

parent

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.

publishSchema / parent / ...

owner

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.

publishSchema / parent / ...

isPlayable

type : boolean
description : True if the object can be played in Transport.

publishSchema / parent / ...

shortId

type : integer
description : The short ID of the object.

publishSchema / parent / ...

classId

description : The class ID of the object.
type : integer
minimum : 0
maximum : 4294967295

publishSchema / parent / ...

category

type : string
description : The category of the object. Ex: 'Actor-Mixer Hierarchy'

publishSchema / parent / ...

filePath

type : string
description : The path to the file containing the object. The path can be a Work Unit file or a project file. For using WAAPI on Mac, please refer to Using WAAPI on Mac .

publishSchema / parent / ...

workunit

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.

publishSchema / parent / ...

childrenCount

type : number
description : The number of children for the object.

publishSchema / parent / ...

music:transitionRoot

type : object

Name Type Description
id string The ID (GUID) of the object.

description : The music transition root containing all other music transitions recursively.

publishSchema / parent / ...

music:playlistRoot

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.

publishSchema / parent / ...

sound:originalWavFilePath

type : string
description : Absolute path to the original wav file. Only valid for Sound and Audio Source objects. For using WAAPI on Mac, please refer to Using WAAPI on Mac .

publishSchema / parent / ...

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. For using WAAPI on Mac, please refer to Using WAAPI on Mac .

publishSchema / parent / ...

soundbank:bnkFilePath

type : string
description : Absolute path to the generated SoundBank file associated with the SoundBank object. Only valid for SoundBank objects. For using WAAPI on Mac, please refer to Using WAAPI on Mac .

publishSchema / parent / ...

audioSource:playbackDuration

type : object
description : The duration root that contains the min and max durations and duration type. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.

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.


publishSchema / parent / ...

audioSource:maxDurationSource

type : object
description : Audio source with longest duration. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.

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.


publishSchema / parent / ...

audioSource:trimValues

type : object
description : Range of time for which the audio source is trimmed.

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.


publishSchema / parent / ...

audioSource:maxRadiusAttenuation

type : object
description : Attenuation with the largest radius. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.

Name Type Description
id string The ID (GUID) of the attenuation object with the largest radius.
radius number The radius of the attenuation object.


publishSchema / parent / ...

audioSource:language

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.


publishSchema / parent / ...

workunit:isDefault

type : boolean
description : True if the work unit is the default.

publishSchema / parent / ...

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".
Possible values : "folder", "rootFile", "nestedFile"

publishSchema / parent / ...

workunit:isDirty

type : boolean
description : True if a Work Unit or a Project (wproj file) is dirty, meaning it is modified but not saved.

publishSchema / parent / ...

switchContainerChild:context

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).


publishSchema / parent / ...

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. Refer to Wwise Objects Reference for more information on the properties and references for all types available.
Possibilities, one of the following :

1) type : string

2) type : number

3) type : boolean

4) type : object

Name Type Description
id string The ID (GUID) of the object.
name string The name of the object.


Detailed JSON Schema


Options :

{
"type": "object",
"properties": {
"return": {
"description": "Data to be returned for every child being added.",
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"description": "Specifies one or many of the built-in accessors for Wwise objects.",
"enum": [
"id",
"name",
"notes",
"type",
"shortId",
"classId",
"category",
"filePath",
"workunit",
"parent",
"owner",
"path",
"isPlayable",
"childrenCount",
"sound:convertedWemFilePath",
"sound:originalWavFilePath",
"soundbank:bnkFilePath",
"music:transitionRoot",
"music:playlistRoot",
"audioSource:playbackDuration",
"audioSource:maxDurationSource",
"audioSource:trimValues",
"audioSource:maxRadiusAttenuation",
"audioSource:language",
"workunit:isDefault",
"workunit:type",
"workunit:isDirty",
"switchContainerChild:context"
]
},
{
"type": "string",
"description": "Specifies one or many property names for Wwise objects. Specifying a single @ returns the value of the property for the associated object. Specifying a double @@ returns the value of the property for the source of override.",
"pattern": "^@@?[:_a-zA-Z0-9]+$"
}
]
}
},
"platform": {
"description": "The ID (GUID) of the platform.",
"type": "string",
"pattern": *Must be a valid GUID*
}
},
"additionalProperties": false
}


Publication schema :

{
"type": "object",
"properties": {
"child": {
"description": "The child object added.",
"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",
"description": "The duration root that contains the min and max durations and duration type. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.",
"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."
}
}
},
"audioSource:maxDurationSource": {
"type": "object",
"description": "Audio source with longest duration. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.",
"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",
"description": "Range of time for which the audio source is trimmed.",
"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:maxRadiusAttenuation": {
"type": "object",
"description": "Attenuation with the largest radius. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.",
"properties": {
"id": {
"description": "The ID (GUID) of the attenuation object with the largest radius.",
"type": "string",
"pattern": *Must be a valid GUID*
},
"radius": {
"type": "number",
"description": "The radius of the attenuation object."
}
}
},
"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
},
"parent": {
"description": "The parent object where the object is added.",
"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",
"description": "The duration root that contains the min and max durations and duration type. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.",
"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."
}
}
},
"audioSource:maxDurationSource": {
"type": "object",
"description": "Audio source with longest duration. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.",
"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",
"description": "Range of time for which the audio source is trimmed.",
"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:maxRadiusAttenuation": {
"type": "object",
"description": "Attenuation with the largest radius. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.",
"properties": {
"id": {
"description": "The ID (GUID) of the attenuation object with the largest radius.",
"type": "string",
"pattern": *Must be a valid GUID*
},
"radius": {
"type": "number",
"description": "The radius of the attenuation object."
}
}
},
"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
}
},
"required": [
"child",
"parent"
],
"additionalProperties": false
}

Document version : 1