目次

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


Performs a query, returns specified data for each object in query result. Refer to Wwise Project のクエリ for more information.

Supported by

Graphical User Interface, Command-Line Interface.

Arguments

Name Type Description
from *   The query starting point.
transform array Sequential transformations on object list returned by "from".

(Required *)

Arguments Details


from

description : The query starting point.
Possibilities, one of the following :

1) type : object

Name Type Description
id * array  

(Required *)

argsSchema / from / ...

id

type : array

argsSchema / from / id / ...

items

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 : object

Name Type Description
shortId * integer The short ID of the object.
type * integer The type of the short ID. Use values from WObjectType.

(Required *)


2) type : object

Name Type Description
search * array  

(Required *)

argsSchema / from / ...

search

type : array

argsSchema / from / search / ...

items

type : string
minItems : 1
maxItems : 1


3) type : object

Name Type Description
name * array  

(Required *)

argsSchema / from / ...

name

type : array

argsSchema / from / name / ...

items

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.


4) type : object

Name Type Description
path * array  

(Required *)

argsSchema / from / ...

path

type : array

argsSchema / from / path / ...

items

type : string


5) type : object

Name Type Description
ofType * array  

(Required *)

argsSchema / from / ...

ofType

type : array

argsSchema / from / ofType / ...

items

type : string


6) type : object

Name Type Description
query * array  

(Required *)

argsSchema / from / ...

query

type : array

argsSchema / from / query / ...

items

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}\}$
minItems : 1
maxItems : 1


transform

description : Sequential transformations on object list returned by "from".
type : array

argsSchema / transform / ...

items

Possibilities, one of the following :

1) type : object

Name Type Description
select * array  

(Required *)

argsSchema / transform / items / ...

select

type : array

argsSchema / transform / items / select / ...

items

type : string
Possible values : "parent", "children", "descendants", "ancestors", "referencesTo"
minItems : 1
maxItems : 1


2) type : string
description : Unique object instances are returned, i.e. no duplicate object is returned.
Possible values : "distinct"

3) type : object

Name Type Description
range * array  

(Required *)

argsSchema / transform / items / ...

range

type : array

argsSchema / transform / items / range / ...

items

type : number
minItems : 2
maxItems : 2


4) type : object

Name Type Description
where * array  

(Required *)

argsSchema / transform / items / ...

where

type : array

argsSchema / transform / items / where / ...

items

Possibilities, one of the following :

1) type : string

2) type : number

3) type : boolean

4) type : array

argsSchema / transform / items / where / items / ...

items

type : string
minItems : 1

Options

Name Type Description
return array Specifies what is being returned for every object. Refer to Wwise Objects Reference for more information on the properties and references available.
platform   The ID (GUID) or name of the platform.
language   The ID (GUID) or name of the language.

Options Details


return

description : Specifies what is being returned for every object. Refer to Wwise Objects Reference for more information on the properties and references available.
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

Possibilities, one of the following :

1) type : string

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

language

Possibilities, one of the following :

1) type : string

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

Result

Name Type Description
return array  

Result Details


return

type : array

resultSchema / return / ...

items

description : One json object per object found, with properties matching what was supplied in options.
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 MacでWAAPIを使う .
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 MacでWAAPIを使う .
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 MacでWAAPIを使う .
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 MacでWAAPIを使う .
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).


resultSchema / return / items / ...

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

resultSchema / return / items / ...

name

type : string
description : The name of the object.

resultSchema / return / items / ...

notes

type : string
description : The notes of the object.

resultSchema / return / items / ...

type

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

resultSchema / return / items / ...

path

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

resultSchema / return / items / ...

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.

resultSchema / return / items / ...

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.

resultSchema / return / items / ...

isPlayable

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

resultSchema / return / items / ...

shortId

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

resultSchema / return / items / ...

classId

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

resultSchema / return / items / ...

category

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

resultSchema / return / items / ...

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 MacでWAAPIを使う .

resultSchema / return / items / ...

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.

resultSchema / return / items / ...

childrenCount

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

resultSchema / return / items / ...

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.

resultSchema / return / items / ...

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.

resultSchema / return / items / ...

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 MacでWAAPIを使う .

resultSchema / return / items / ...

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 MacでWAAPIを使う .

resultSchema / return / items / ...

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 MacでWAAPIを使う .

resultSchema / return / items / ...

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.


resultSchema / return / items / ...

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.


resultSchema / return / items / ...

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.


resultSchema / return / items / ...

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.


resultSchema / return / items / ...

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.


resultSchema / return / items / ...

workunit:isDefault

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

resultSchema / return / items / ...

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"

resultSchema / return / items / ...

workunit:isDirty

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

resultSchema / return / items / ...

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


resultSchema / return / items / ...

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.

Examples :

Get an object's name.

Retrieves the object's name property.

Arguments:

{
"from": {
"id": [
"{24979032-B170-43E3-A2E4-469E0193E2C3}"
]
}
}

Options:

{
"return": [
"name"
]
}

Result:

{
"return": [
{
"name": "MyObjectName"
}
]
}

Get the properties and references of an object.

Uses the property accessor @ to get the voice volume and the output bus of an object.

Arguments:

{
"from": {
"id": [
"{24979032-B170-43E3-A2E4-469E0193E2C3}"
]
}
}

Options:

{
"return": [
"@Volume",
"@OutputBus"
]
}

Result:

{
"return": [
{
"@Volume": 2.3,
"@OutputBus": {
"id": "{1514A4D8-1DA6-412A-A17E-75CA0C2149F3}",
"name": "Master Audio Bus"
}
}
]
}

Get the output bus being used.

Uses the double @ to access the output bus reference using the source of override. It will use the override parent values to determine the source of override.

Arguments:

{
"from": {
"id": [
"{24979032-B170-43E3-A2E4-469E0193E2C3}"
]
}
}

Options:

{
"return": [
"@@OutputBus"
]
}

Result:

{
"return": [
{
"@@OutputBus": {
"id": "{1514A4D8-1DA6-412A-A17E-75CA0C2149F3}",
"name": "Master Audio Bus"
}
}
]
}

Get the descendants objects matching a filter.

From all descendants in the actor-mixer hierarchy, return the objects whose name start with My. This uses the regular expression '^my'.

Arguments:

{
"from": {
"path": [
"\\Actor-Mixer Hierarchy"
]
},
"transform": [
{
"select": [
"descendants"
]
},
{
"where": [
"name:matches",
"^my"
]
}
]
}

Options:

{
"return": [
"name"
]
}

Result:

{
"return": [
{
"name": "MySound"
},
{
"name": "MyRandomContainer"
}
]
}

Get all platforms.

Retrieves the platform ids and names.

Arguments:

{
"from": {
"ofType": [
"Platform"
]
}
}

Options:

{
"return": [
"id",
"name"
]
}

Result:

{
"return": [
{
"id": "{8237B143-A4F0-4B01-8C7B-FFC53A888271}",
"name": "Windows"
},
{
"id": "{508A9810-5C76-4CF7-B9BB-D6AE396F973B}",
"name": "iOS"
}
]
}

Get the project name, path and dirty state.

Retrieves the project name, file path and dirty state. Note that the project name is defined in the wproj xml, and may not match the file name. For using WAAPI on Mac, please refer to MacでWAAPIを使う.

Arguments:

{
"from": {
"ofType": [
"Project"
]
}
}

Options:

{
"return": [
"name",
"filePath",
"workunit:isDirty"
]
}

Result:

{
"return": [
{
"filePath": "C:\\WwiseProjects\\MyProject\\MyProject.wproj",
"name": "MyProject",
"workunit:isDirty": true
}
]
}

Search objects.

Search objects with 'gun' in the name.

Arguments:

{
"from": {
"search": [
"gun"
]
}
}

Options:

{
"return": [
"id",
"name"
]
}

Result:

{
"return": [
{
"id": "{8237B143-A4F0-4B01-8C7B-FFC53A888271}",
"name": "Big Gun"
},
{
"id": "{508A9810-5C76-4CF7-B9BB-D6AE396F973B}",
"name": "Small Gun"
}
]
}

Get all objects containing a sound object.

Retrieves the id of objects with at least one child being a sound object. Duplicates are filtered out using the "distinct" transform.

Arguments:

{
"from": {
"ofType": [
"Sound"
]
},
"transform": [
{
"select": [
"parent"
]
},
"distinct"
]
}

Options:

{
"return": [
"id",
"name"
]
}

Result:

{
"return": [
{
"id": "{01181963-13CA-4946-B4C2-7A04BF727596}",
"name": "Folder0"
},
{
"id": "{F9912AA4-7835-4828-99E6-C327840EFE3D}",
"name": "Folder1"
}
]
}

Search objects of a certain type.

Retrieves the id, name and notes of objects with "Tone" in their text properties and filters the result to retrieve only those of type "Sound". Refer to Wwise Objects Reference for the types available.

Arguments:

{
"from": {
"search": [
"Tone"
]
},
"transform": [
{
"where": [
"type:isIn",
[
"Sound"
]
]
}
]
}

Options:

{
"return": [
"id",
"name",
"notes"
]
}

Result:

{
"return": [
{
"id": "{24979032-B170-43E3-A2E4-469E0193E2C3}",
"name": "Tone SFX",
"notes": "MyNotes"
},
{
"id": "{A076AA65-B71A-45BB-8841-5A20C52CE727}",
"name": "MyTone",
"notes": ""
},
{
"id": "{72CB44BE-C699-4032-B615-EEFD0E707FFC}",
"name": "MyToneToMove",
"notes": ""
}
]
}

Search objects of a certain category.

Retrieves the id and name of objects with "Tone" in their text properties and filters the result to retrieve only those within the category "AudioObjects".

Arguments:

{
"from": {
"search": [
"Tone"
]
},
"transform": [
{
"where": [
"category:isIn",
[
"AudioObjects"
]
]
}
]
}

Options:

{
"return": [
"id",
"name",
"notes"
]
}

Result:

{
"return": [
{
"id": "{24979032-B170-43E3-A2E4-469E0193E2C3}",
"name": "Tone SFX"
},
{
"id": "{A076AA65-B71A-45BB-8841-5A20C52CE727}",
"name": "MyTone"
},
{
"id": "{72CB44BE-C699-4032-B615-EEFD0E707FFC}",
"name": "MyToneToMove"
}
]
}


Detailed JSON Schema


Arguments :

{
"type": "object",
"properties": {
"from": {
"description": "The query starting point.",
"oneOf": [
{
"type": "object",
"properties": {
"id": {
"type": "array",
"items": {
"oneOf": [
{
"type": "string",
"pattern": *Must be a valid GUID*
},
{
"type": "object",
"properties": {
"shortId": {
"description": "The short ID of the object.",
"type": "integer",
"minimum": 0,
"maximum": 4294967295
},
"type": {
"type": "integer",
"minimum": 1,
"maximum": 71,
"description": "The type of the short ID. Use values from WObjectType."
}
},
"required": [
"shortId",
"type"
],
"additionalProperties": false
}
]
}
}
},
"required": [
"id"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"search": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"maxItems": 1
}
},
"required": [
"search"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"name": {
"type": "array",
"items": {
"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."
}
}
},
"required": [
"name"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"path": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"path"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"ofType": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"ofType"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"query": {
"type": "array",
"items": {
"type": "string",
"pattern": *Must be a valid GUID*
},
"minItems": 1,
"maxItems": 1
}
},
"required": [
"query"
],
"additionalProperties": false
}
]
},
"transform": {
"description": "Sequential transformations on object list returned by \"from\".",
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"select": {
"type": "array",
"items": {
"type": "string",
"enum": [
"parent",
"children",
"descendants",
"ancestors",
"referencesTo"
]
},
"minItems": 1,
"maxItems": 1
}
},
"required": [
"select"
],
"additionalProperties": false
},
{
"type": "string",
"description": "Unique object instances are returned, i.e. no duplicate object is returned.",
"enum": [
"distinct"
]
},
{
"type": "object",
"properties": {
"range": {
"type": "array",
"items": {
"type": "number"
},
"minItems": 2,
"maxItems": 2
}
},
"required": [
"range"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"where": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"minItems": 1
}
},
"required": [
"where"
],
"additionalProperties": false
}
]
}
}
},
"required": [
"from"
],
"additionalProperties": false
}


Options :

{
"description": "Specifies the return options for every object returned.",
"type": "object",
"properties": {
"return": {
"description": "Specifies what is being returned for every object.",
"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": {
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"pattern": *Must be a valid GUID*
}
],
"description": "The ID (GUID) or name of the platform."
},
"language": {
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"pattern": *Must be a valid GUID*
}
],
"description": "The ID (GUID) or name of the language."
}
},
"additionalProperties": false
}


Response :

{
"type": "object",
"properties": {
"return": {
"type": "array",
"items": {
"description": "One json object per object found, with properties matching what was supplied in options.",
"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
}
}
}
}

Document version : 1