Warning: you were redirected to the latest documentation corresponding to your major release ( 2023.1.9.8628 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.
link
Wwise SDK 2023.1.9
ak.wwise.ui.getSelectedObjects Options Schema
Schema
{
"type": "object",
"description": "Specifies the return options for every object returned.\\n Object specifying the options for the results.",
"properties": {
"return": {
"type": "array",
"description": "Specifies what is being returned for every object. Refer to \\ref wobjects_index for more information on the properties and references available.\\n The array of return expressions defines which elements of the Wwise object is returned. This can include built-in accessors, such as the name or id, or object properties, such as the Volume or the Pitch.",
"items": {
"description": "A return expression.",
"anyOf": [
{
"type": "string",
"description": "Specifies one or many of the built-in accessors for Wwise objects.",
"enum": [
"id",
"name",
"notes",
"type",
"pluginName",
"shortId",
"classId",
"category",
"filePath",
"workunit",
"parent",
"owner",
"path",
"isPlayable",
"childrenCount",
"totalSize",
"mediaSize",
"objectSize",
"structureSize",
"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",
"convertedWemFilePath",
"originalFilePath",
"originalRelativeFilePath",
"convertedFilePath",
"originalWavFilePath",
"soundbankBnkFilePath",
"musicTransitionRoot",
"musicPlaylistRoot",
"playbackDuration",
"duration",
"maxDurationSource",
"audioSourceTrimValues",
"maxRadiusAttenuation",
"audioSourceLanguage",
"workunitIsDefault",
"workunitType",
"workunitIsDirty",
"switchContainerChildContext",
"isExplicitMute",
"isExplicitSolo",
"isImplicitMute",
"isImplicitSolo",
"isIncluded",
"points",
"stateProperties",
"stateGroups"
]
},
{
"type": "string",
"description": "Specifies one or many dot-separated accessors that form a query and yields a value or an object reference. 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 \\ref wobjects_index ."