Performs a query, returns specified data for each object in query result. Refer to Querying the Wwise Project for more information.
(Required *)
Graphical User Interface, Command-Line Interface.
| Name | Type | Description |
|---|---|---|
| from * | The query starting point. | |
| transform | array | Sequential transformations on object list returned by "from". |
description : The query starting point.
Possibilities, one of the following :
1) type : object
| Name | Type | Description |
|---|---|---|
| id * | array |
argsSchema / from / ...
type : array
argsSchema / from / id / ...
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. |
2) type : object
| Name | Type | Description |
|---|---|---|
| search * | array |
argsSchema / from / ...
type : array
argsSchema / from / search / ...
type : string
minItems : 1
maxItems : 1
3) type : object
| Name | Type | Description |
|---|---|---|
| path * | array |
argsSchema / from / ...
type : array
argsSchema / from / path / ...
type : string
4) type : object
| Name | Type | Description |
|---|---|---|
| ofType * | array |
argsSchema / from / ...
type : array
argsSchema / from / ofType / ...
type : string
5) type : object
| Name | Type | Description |
|---|---|---|
| query * | array |
argsSchema / from / ...
type : array
argsSchema / from / query / ...
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
description : Sequential transformations on object list returned by "from".
type : array
argsSchema / transform / ...
Possibilities, one of the following :
1) type : object
| Name | Type | Description |
|---|---|---|
| select * | array |
argsSchema / transform / items / ...
type : array
argsSchema / transform / items / select / ...
type : string
Possible values : "parent", "children", "descendants", "ancestors"
minItems : 1
maxItems : 1
2) type : object
| Name | Type | Description |
|---|---|---|
| range * | array |
argsSchema / transform / items / ...
type : array
argsSchema / transform / items / range / ...
type : number
minItems : 2
maxItems : 2
3) type : object
| Name | Type | Description |
|---|---|---|
| where * | array |
argsSchema / transform / items / ...
type : array
argsSchema / transform / items / where / ...
Possibilities, one of the following :
1) type : string
2) type : number
3) type : boolean
minItems : 1
| 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 | string | The ID (GUID) of the platform. |
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 / ...
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", "category", "filePath", "workunit", "parent", "owner", "path", "isPlayable", "childrenCount", "sound:convertedWemFilePath", "sound:originalWavFilePath", "soundbank:bnkFilePath", "music:transitionRoot", "music:playlistRoot", "workunit:isDefault", "workunit:type", "workunit:isDirty"
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-Z][_a-zA-Z0-9]*$
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}$
| Name | Type | Description |
|---|---|---|
| return | array |
type : array
resultSchema / return / ...
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. |
| 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. |
| 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 the work unit is dirty. A Work Unit is dirty when it is being modified, and not saved. |
resultSchema / return / items / ...
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 / ...
type : string
description : The name of the object.
resultSchema / return / items / ...
type : string
description : The notes of the object.
resultSchema / return / items / ...
type : string
description : The type of the object. Refer to Wwise Objects Reference for more information on the types available.
resultSchema / return / items / ...
type : string
description : The path of the object from the project root. Ex: '\\Actor-Mixer Hierarchy\\Default Work Unit\\Sound1'
resultSchema / return / items / ...
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 / ...
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 / ...
type : boolean
description : True if the object can be played in Transport.
resultSchema / return / items / ...
type : integer
description : The short ID of the object.
resultSchema / return / items / ...
type : string
description : The category of the object. Ex: 'Actor-Mixer Hierarchy'
resultSchema / return / items / ...
type : string
description : The path to the file containing the object. The path can be a work-unit file, or a project file.
resultSchema / return / items / ...
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 / ...
type : number
description : The number of children for the object.
resultSchema / return / items / ...
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 / ...
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 / ...
type : string
description : Absolute path to the original wav file. Only valid for Sound and Audio Source objects.
resultSchema / return / items / ...
type : string
description : Absolute path to the converted wem file. Specify the platform in the options. Only valid for Sound and Audio Source objects.
resultSchema / return / items / ...
type : string
description : Absolute path to the generated SoundBank file associated with the SoundBank object. Only valid for SoundBank objects.
resultSchema / return / items / ...
type : boolean
description : True if the work unit is the default.
resultSchema / return / items / ...
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 / ...
type : boolean
description : True if the work unit is dirty. A Work Unit is dirty when it is being modified, and not saved.
resultSchema / return / items / ...
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. |
Retrieves the object's name property.
{
"from": {
"id": [
"{24979032-B170-43E3-A2E4-469E0193E2C3}"
]
}
}
{
"return": [
"name"
]
}
{
"return": [
{
"name": "MyObjectName"
}
]
}
Uses the property accessor @ to get the voice volume and the output bus of an object.
{
"from": {
"id": [
"{24979032-B170-43E3-A2E4-469E0193E2C3}"
]
}
}
{
"return": [
"@Volume",
"@OutputBus"
]
}
{
"return": [
{
"@Volume": 2.3,
"@OutputBus": {
"id": "{1514A4D8-1DA6-412A-A17E-75CA0C2149F3}",
"name": "Master Audio Bus"
}
}
]
}
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.
{
"from": {
"id": [
"{24979032-B170-43E3-A2E4-469E0193E2C3}"
]
}
}
{
"return": [
"@@OutputBus"
]
}
{
"return": [
{
"@@OutputBus": {
"id": "{1514A4D8-1DA6-412A-A17E-75CA0C2149F3}",
"name": "Master Audio Bus"
}
}
]
}
From all descendants in the actor-mixer hierarchy, return the objects whose name start with My. This uses the regular expression '^my'.
{
"from": {
"path": [
"\\Actor-Mixer Hierarchy"
]
},
"transform": [
{
"select": [
"descendants"
]
},
{
"where": [
"name:matches",
"^my"
]
}
]
}
{
"return": [
"name"
]
}
{
"return": [
{
"name": "MySound"
},
{
"name": "MyRandomContainer"
}
]
}
Retrieves the platform ids and names.
{
"from": {
"ofType": [
"Platform"
]
}
}
{
"return": [
"id",
"name"
]
}
{
"return": [
{
"id": "{8237B143-A4F0-4B01-8C7B-FFC53A888271}",
"name": "Windows"
},
{
"id": "{508A9810-5C76-4CF7-B9BB-D6AE396F973B}",
"name": "iOS"
}
]
}
Retrieves the project name and file path. Note that the project name is defined in the wproj xml, and may not match the file name.
{
"from": {
"ofType": [
"Project"
]
}
}
{
"return": [
"name",
"filePath"
]
}
{
"return": [
{
"filePath": "C:\\WwiseProjects\\MyProject\\MyProject.wproj",
"name": "MyProject"
}
]
}
Search objects with 'gun' in the name.
{
"from": {
"search": [
"gun"
]
}
}
{
"return": [
"id",
"name"
]
}
{
"return": [
{
"id": "{8237B143-A4F0-4B01-8C7B-FFC53A888271}",
"name": "Big Gun"
},
{
"id": "{508A9810-5C76-4CF7-B9BB-D6AE396F973B}",
"name": "Small Gun"
}
]
}
{
"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": {
"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"
]
},
"minItems": 1,
"maxItems": 1
}
},
"required": [
"select"
],
"additionalProperties": false
},
{
"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"
}
]
},
"minItems": 1
}
},
"required": [
"where"
],
"additionalProperties": false
}
]
}
}
},
"required": [
"from"
],
"additionalProperties": false
}
{
"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",
"category",
"filePath",
"workunit",
"parent",
"owner",
"path",
"isPlayable",
"childrenCount",
"sound:convertedWemFilePath",
"sound:originalWavFilePath",
"soundbank:bnkFilePath",
"music:transitionRoot",
"music:playlistRoot",
"workunit:isDefault",
"workunit:type",
"workunit:isDirty"
]
},
{
"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-Z][_a-zA-Z0-9]*$"
}
]
}
},
"platform": {
"description": "The ID (GUID) of the platform.",
"type": "string",
"pattern": *Must be a valid GUID*
}
},
"additionalProperties": false
}
{
"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."
},
"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."
},
"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 the work unit is dirty. A Work Unit is dirty when it is being modified, and not saved."
}
},
"patternProperties": {
"^@@?[_a-zA-Z][_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