목차

Wwise SDK 2018.1.11
ak.wwise.ui.getSelectedObjects


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

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

(Required *)

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.
classId integer The class ID of the object.
category string The category of the object. Ex: 'Actor-Mixer Hierarchy'
filePath string The path to the file containing the object. The path can be a Work Unit file or a project file. For using WAAPI on Mac, please refer to Using WAAPI on Mac .
workunit object The parent workunit containing the object. The 'id' and the 'name' will be returned.
childrenCount number The number of children for the object.
music:transitionRoot object The music transition root containing all other music transitions recursively.
music:playlistRoot object The music playlist root containing all other music playlist items recursively. This applies to Music Playlist Containers only.
sound:originalWavFilePath string Absolute path to the original wav file. Only valid for Sound and Audio Source objects. For using WAAPI on Mac, please refer to Using WAAPI on Mac .
sound:convertedWemFilePath string Absolute path to the converted wem file. Specify the platform in the options. Only valid for Sound and Audio Source objects. For using WAAPI on Mac, please refer to Using WAAPI on Mac .
soundbank:bnkFilePath string Absolute path to the generated SoundBank file associated with the SoundBank object. Only valid for SoundBank objects. For using WAAPI on Mac, please refer to Using WAAPI on Mac .
audioSource:playbackDuration object The duration root that contains the min and max durations and duration type. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.
audioSource:maxDurationSource object Audio source with longest duration. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.
audioSource:trimValues object Range of time for which the audio source is trimmed.
audioSource:maxRadiusAttenuation object Attenuation with the largest radius. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.
audioSource:language object Language associated to the audio source. This only applies to Audio Source objects directly.
workunit:isDefault boolean True if the work unit is the default.
workunit:type string The type of the Work Unit. Please note that, like Work Units, physical folders have the type "WorkUnit". Physical folders will have the workunit:type "folder".
Possible values : "folder", "rootFile", "nestedFile"
workunit:isDirty boolean True if a Work Unit or a Project (wproj file) is dirty, meaning it is modified but not saved.
switchContainerChild:context object The context object associated with the child of a Switch Container. This object holds the properties associated with the child that are context-dependent for the Switch Container (for example: property for the 1st only checkbox).


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

classId

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

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

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

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

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

resultSchema / objects / 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 / objects / 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 / objects / 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 / objects / 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 / objects / 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 / 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 a Work Unit or a Project (wproj file) is dirty, meaning it is modified but not saved.

resultSchema / objects / 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 / objects / 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 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",
"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": {
"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."
},
"classId": {
"description": "The class ID of the object.",
"type": "integer",
"minimum": 0,
"maximum": 4294967295
},
"category": {
"type": "string",
"description": "The category of the object. Ex: 'Actor-Mixer Hierarchy'"
},
"filePath": {
"type": "string",
"description": "The path to the file containing the object. The path can be a Work Unit file or a project file."
},
"workunit": {
"type": "object",
"properties": {
"id": {
"description": "The ID (GUID) of the object.",
"type": "string",
"pattern": *Must be a valid GUID*
},
"name": {
"type": "string",
"description": "The name of the object."
}
},
"description": "The parent workunit containing the object. The 'id' and the 'name' will be returned."
},
"childrenCount": {
"type": "number",
"description": "The number of children for the object."
},
"music:transitionRoot": {
"type": "object",
"properties": {
"id": {
"description": "The ID (GUID) of the object.",
"type": "string",
"pattern": *Must be a valid GUID*
}
},
"description": "The music transition root containing all other music transitions recursively."
},
"music:playlistRoot": {
"type": "object",
"properties": {
"id": {
"description": "The ID (GUID) of the object.",
"type": "string",
"pattern": *Must be a valid GUID*
}
},
"description": "The music playlist root containing all other music playlist items recursively. This applies to Music Playlist Containers only."
},
"sound:originalWavFilePath": {
"type": "string",
"description": "Absolute path to the original wav file. Only valid for Sound and Audio Source objects."
},
"sound:convertedWemFilePath": {
"type": "string",
"description": "Absolute path to the converted wem file. Specify the platform in the options. Only valid for Sound and Audio Source objects."
},
"soundbank:bnkFilePath": {
"type": "string",
"description": "Absolute path to the generated SoundBank file associated with the SoundBank object. Only valid for SoundBank objects."
},
"audioSource:playbackDuration": {
"type": "object",
"description": "The duration root that contains the min and max durations and duration type. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.",
"properties": {
"playbackDurationMin": {
"type": "number",
"description": "The minimum possible time playback can take."
},
"playbackDurationMax": {
"type": "number",
"description": "The maximum possible time playback can take."
},
"playbackDurationType": {
"type": "string",
"description": "The type of duration."
}
}
},
"audioSource:maxDurationSource": {
"type": "object",
"description": "Audio source with longest duration. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.",
"properties": {
"id": {
"description": "The ID (GUID) of the audio source object with longest duration.",
"type": "string",
"pattern": *Must be a valid GUID*
},
"trimmedDuration": {
"type": "number",
"description": "The duration in seconds of the longest trimmed source."
}
}
},
"audioSource:trimValues": {
"type": "object",
"description": "Range of time for which the audio source is trimmed.",
"properties": {
"trimBegin": {
"type": "number",
"description": "The time value in seconds of the start trim."
},
"trimEnd": {
"type": "number",
"description": "The time value in seconds of the end trim."
}
}
},
"audioSource:maxRadiusAttenuation": {
"type": "object",
"description": "Attenuation with the largest radius. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.",
"properties": {
"id": {
"description": "The ID (GUID) of the attenuation object with the largest radius.",
"type": "string",
"pattern": *Must be a valid GUID*
},
"radius": {
"type": "number",
"description": "The radius of the attenuation object."
}
}
},
"audioSource:language": {
"type": "object",
"description": "Language associated to the audio source. This only applies to Audio Source objects directly.",
"properties": {
"id": {
"description": "The ID (GUID) of the Language object to which the Audio Source object is associated.",
"type": "string",
"pattern": *Must be a valid GUID*
},
"name": {
"type": "string",
"description": "The name of the Language object to which the Audio Source object is associated."
}
}
},
"workunit:isDefault": {
"type": "boolean",
"description": "True if the work unit is the default."
},
"workunit:type": {
"type": "string",
"description": "The type of the Work Unit. Please note that, like Work Units, physical folders have the type \"WorkUnit\". Physical folders will have the workunit:type \"folder\".",
"enum": [
"folder",
"rootFile",
"nestedFile"
]
},
"workunit:isDirty": {
"type": "boolean",
"description": "True if a Work Unit or a Project (wproj file) is dirty, meaning it is modified but not saved."
},
"switchContainerChild:context": {
"type": "object",
"properties": {
"id": {
"description": "The ID (GUID) of the object.",
"type": "string",
"pattern": *Must be a valid GUID*
}
},
"description": "The context object associated with the child of a Switch Container. This object holds the properties associated with the child that are context-dependent for the Switch Container (for example: property for the 1st only checkbox)."
}
},
"patternProperties": {
"^@@?[:_a-zA-Z0-9]+$": {
"description": "Specifies the property or reference value. A single @ specifies the value of the property for the associated object. A double @@ specifies the value of the property using the source of override.",
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"id": {
"description": "The ID (GUID) of the object.",
"type": "string",
"pattern": *Must be a valid GUID*
},
"name": {
"type": "string",
"description": "The name of the object."
}
}
}
]
}
},
"additionalProperties": false
}
}
},
"required": [
"objects"
],
"additionalProperties": false
}

Document version : 1