バージョン

menu_open

ak.wwise.ui.getSelectedObjects


Retrieves the list of objects currently selected by the user in the active view.

(Required *)

Supported by

Graphical User Interface.

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.


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", "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
objects * array The selected objects, in the format specified in the options. Can be empty if no object is selected.


Result Details


objects

type : array
description : The selected objects, in the format specified in the options. Can be empty if no object is selected.

resultSchema / objects / ...

items

description : The selected objects. Use the options to specify which data to return. Default will return id and name.
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 / objects / 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 / objects / items / ...

name

type : string
description : The name of the object.

resultSchema / objects / items / ...

notes

type : string
description : The notes of the object.

resultSchema / objects / items / ...

type

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

resultSchema / objects / items / ...

path

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

resultSchema / objects / 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 / objects / 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 / objects / items / ...

isPlayable

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

resultSchema / objects / items / ...

shortId

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

resultSchema / objects / items / ...

category

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

resultSchema / objects / 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 / objects / 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 / objects / items / ...

childrenCount

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

resultSchema / objects / 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 / objects / 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 / objects / items / ...

sound_originalWavFilePath

type : string
description : Absolute path to the original wav file. Only valid for Sound and Audio Source objects.

resultSchema / objects / 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 / objects / items / ...

soundbank_bnkFilePath

type : string
description : Absolute path to the generated SoundBank file associated with the SoundBank object. Only valid for SoundBank objects.

resultSchema / objects / items / ...

workunit_isDefault

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

resultSchema / objects / 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 / objects / 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 / objects / 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 a single selected object

Retrieves the GUID of the selected object

Arguments:

{}

Result:

{
    "objects": [
        {
            "id": "{A076AA65-B71A-45BB-8841-5A20C52CE727}", 
            "name": "MySound"
        }
    ]
}


Detailed JSON Schema


Arguments :

{
    "type": "object", 
    "properties": {}, 
    "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": {
        "objects": {
            "type": "array", 
            "description": "The selected objects, in the format specified in the options. Can be empty if no object is selected.", 
            "items": {
                "description": "The selected objects. Use the options to specify which data to return. Default will return id and name.", 
                "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
            }
        }
    }, 
    "required": [
        "objects"
    ], 
    "additionalProperties": false
}

Document version : 1


このページはお役に立ちましたか?

サポートは必要ですか?

ご質問や問題、ご不明点はございますか?お気軽にお問い合わせください。

サポートページをご確認ください

あなたのプロジェクトについて教えてください。ご不明な点はありませんか。

プロジェクトを登録していただくことで、ご利用開始のサポートをいたします。

Wwiseからはじめよう