ak.wwise.core.object.get

Performs a query, returns specified data for each object in query result. Refer to Querying the Wwise Project for more information.

(Required *)

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

Arguments Details

from

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

1) type : object

Name	Type	Description
id *	array

argsSchema / from / ...

id

type : array

argsSchema / from / id / ...

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

Name	Type	Description
search *	array

search

type : array

argsSchema / from / search / ...

Name	Type	Description
path *	array

path

type : array

argsSchema / from / path / ...

Name	Type	Description
ofType *	array

ofType

type : array

argsSchema / from / ofType / ...

Name	Type	Description
query *	array

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

argsSchema / transform / items / ...

select

type : array

argsSchema / transform / items / select / ...

items

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

2) type : object

Name	Type	Description
range *	array

argsSchema / transform / items / ...

range

type : array

argsSchema / transform / items / range / ...

items

type : number
minItems : 2
maxItems : 2

3) type : object

Name	Type	Description
where *	array

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

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", "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]*$

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

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

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

filePath

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

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.

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.

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.

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 the work unit is dirty. A Work Unit is dirty when it is being modified, and not saved.

resultSchema / return / items / ...

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. 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 and path.

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.

Arguments:

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

Options:

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

Result:

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

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"
        }
    ]
}

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": {
                        "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
}

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", 
                            "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
}

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."
                    }, 
                    "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

이 페이지가 도움이 되었나요?

지원이 필요하신가요?

질문이 있으신가요? 문제를 겪고 계신가요? 더 많은 정보가 필요하신가요? 저희에게 문의해주시면 도와드리겠습니다!

지원 페이지를 방문해 주세요

작업하는 프로젝트에 대해 알려주세요. 언제든지 도와드릴 준비가 되어 있습니다.

프로젝트를 등록하세요. 아무런 조건이나 의무 사항 없이 빠른 시작을 도와드리겠습니다.

Wwise를 시작해 보세요

Wwise SDK 2017.1.9

Supported by

Arguments

Options

Result

Examples :

Get an object's name.

Arguments:

Options:

Result:

Get the properties and references of an object.

Arguments:

Options:

Result:

Get the output bus being used.

Arguments:

Options:

Result:

Get the descendants objects matching a filter.

Arguments:

Options:

Result:

Get all platforms.

Arguments:

Options:

Result:

Get the project name and path.

Arguments:

Options:

Result:

Search objects.

Arguments:

Options:

Result:

Detailed JSON Schema

Arguments :

Options :

Response :

이 페이지가 도움이 되었나요?

지원이 필요하신가요?

작업하는 프로젝트에 대해 알려주세요. 언제든지 도와드릴 준비가 되어 있습니다.