Wwise Version
arrow_right Table of Contents
Wwise SDK 2021.1.6
ak.wwise.ui.commands.executed

Sent when a command is executed. The objects for which the command is executed are sent in the publication.

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.
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.
return [...] any of: A return expression.
string Specifies one or many of the built-in accessors for Wwise objects. Possible values:
  • 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
  • originalWavFilePath
  • soundbankBnkFilePath
  • musicTransitionRoot
  • musicPlaylistRoot
  • playbackDuration
  • maxDurationSource
  • audioSourceTrimValues
  • maxRadiusAttenuation
  • audioSourceLanguage
  • workunitIsDefault
  • workunitType
  • workunitIsDirty
  • switchContainerChildContext
string 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 Wwise Objects Reference .
platform any of: The ID (GUID) or name of the platform. This is an optional argument. When not specified, the current platform is used.
string The name of the platform.
string The id of the platform.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
language any of: The ID (GUID) or name of the language.
string The name of the language.
string The id of the language.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.

Options Schema

Publish

Name Type Description
command * string The command ID that was executed.
objects * array The objects for which the command was executed. The objects are usually the selected objects. They are returned in the format specified in the options. Can be empty if no object is used.
objects [...] object The objects. Use the options to specify which data to return. Default returns id and name.
A Wwise object. Use the return options to specify which property is required.
objects[...].id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
objects[...].name string The name of the object.
objects[...].notes string The notes of the object.
objects[...].type string The type of the object. Refer to Wwise Objects Reference for more information on the types available.
objects[...].pluginName string The name of the plug-in for Source, Effect, Mixer, Device and Metadata plug-in.
objects[...].path string The path of the object from the project root. Ex: '\Actor-Mixer Hierarchy\Default Work Unit\Sound1'
objects[...].parent object The parent of the object in the hierarchy.
objects[...].parent.id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
objects[...].parent.name string The name of the object.
objects[...].owner object The owner of the object. This applies to objects being locally owned by other objects, such as custom effects, custom attenuations, etc.
objects[...].owner.id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
objects[...].owner.name string The name of the object.
objects[...].isPlayable boolean True if the object can be played in Transport.
objects[...].shortId integer The Short ID of the object.
objects[...].classId integer The class ID of the object.
Unsigned Integer 32-bit. Range: [0,4294967295]
objects[...].category string The category of the object. Ex: 'Actor-Mixer Hierarchy'
objects[...].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 .
objects[...].workunit object The parent Work Unit containing the object. The 'id' and the 'name' is returned.
objects[...].workunit.id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
objects[...].workunit.name string The name of the object.
objects[...].childrenCount number The number of children for the object.
objects[...].totalSize integer The amount of space (in bytes) this object and all of its children take up in a SoundBank. This does not include the objectSize. Note that SoundBanks need to be generated for this value to be accurate.
objects[...].mediaSize integer The total converted size (in bytes) of the media files of this object and all of its children. Note that SoundBanks need to be generated for this value to be accurate.
objects[...].objectSize integer The amount of space (in bytes) the meta-data of the object takes up in a SoundBank. This does not include media files. Note that SoundBanks need to be generated for this value to be accurate.
objects[...].structureSize integer The amount of space (in bytes) the meta-data of the object and all of its children take up in a SoundBank. This does not include media files. Note that SoundBanks need to be generated for this value to be accurate.
objects[...].musicTransitionRoot object The music transition root containing all other music transitions recursively.
objects[...].musicTransitionRoot.id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
objects[...].musicPlaylistRoot object The music playlist root containing all other music playlist items recursively. This applies to Music Playlist Containers only.
objects[...].musicPlaylistRoot.id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
objects[...].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 .
objects[...].convertedWemFilePath string Absolute path to the converted wem file. Specify the platform in the options. Only valid for Sound and Audio Source objects. To use WAAPI on Mac, please refer to Using WAAPI on Mac .
objects[...].soundbankBnkFilePath string Absolute path to the generated SoundBank file associated with the SoundBank object. Only valid for SoundBank objects. To use WAAPI on Mac, please refer to Using WAAPI on Mac .
objects[...].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.
objects[...].playbackDuration.playbackDurationMin number The minimum possible time playback can take.
objects[...].playbackDuration.playbackDurationMax number The maximum possible time playback can take.
objects[...].playbackDuration.playbackDurationType string The type of duration.
objects[...].maxDurationSource object Audio source with the longest duration. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.
objects[...].maxDurationSource.id string The ID (GUID) of the audio source object with the longest duration.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
objects[...].maxDurationSource.trimmedDuration number The duration in seconds of the longest trimmed source.
objects[...].audioSourceTrimValues object Range of time for which the audio source is trimmed.
objects[...].audioSourceTrimValues.trimBegin number The time value in seconds of the start trim.
objects[...].audioSourceTrimValues.trimEnd number The time value in seconds of the end trim.
objects[...].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.
objects[...].maxRadiusAttenuation.id string The ID (GUID) of the attenuation object with the largest radius.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
objects[...].maxRadiusAttenuation.radius number The radius of the attenuation object.
objects[...].audioSourceLanguage object Language associated to the audio source. This only applies to Audio Source objects directly.
objects[...].audioSourceLanguage.id string The ID (GUID) of the Language object to which the Audio Source object is associated.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
objects[...].audioSourceLanguage.name string The name of the Language object to which the Audio Source object is associated.
objects[...].workunitIsDefault boolean True if the work unit is the default.
objects[...].workunitType string The type of the Work Unit. Please note that, like Work Units, physical folders have the type "WorkUnit". Physical folders have the workunitType "folder". Possible values:
  • folder
  • rootFile
  • nestedFile
objects[...].workunitIsDirty boolean True if a Work Unit or a Project (wproj file) is dirty, meaning it was modified but not saved.
objects[...].switchContainerChildContext 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: the properties of the '1st only' checkbox).
objects[...].switchContainerChildContext.id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
objects[...].regex(^((@?@?[a-zA-Z0-9:_]+)|[a-zA-Z]+\(.+\))(.@?@?[a-zA-Z0-9:_]+|[a-zA-Z]+\(.+\))*$) any of: Specifies dot-separated accessors that form a query and yields a property value or an object reference. A single @ specifies the value of the property for the associated object. A double @ specifies the value of the property for the source of override. Refer to Wwise Objects Reference for more information on the properties and references for all types available.
string A string value.
number A numeric value.
boolean A boolean value.
object An object reference value.
array An object list reference value.
objects[...].regex(^((@?@?[a-zA-Z0-9:_]+)|[a-zA-Z]+\(.+\))(.@?@?[a-zA-Z0-9:_]+|[a-zA-Z]+\(.+\))*$).id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
objects[...].regex(^((@?@?[a-zA-Z0-9:_]+)|[a-zA-Z]+\(.+\))(.@?@?[a-zA-Z0-9:_]+|[a-zA-Z]+\(.+\))*$).name string The name of the object.
objects[...].regex(^((@?@?[a-zA-Z0-9:_]+)|[a-zA-Z]+\(.+\))(.@?@?[a-zA-Z0-9:_]+|[a-zA-Z]+\(.+\))*$) [...] object An object reference value.
objects[...].regex(^((@?@?[a-zA-Z0-9:_]+)|[a-zA-Z]+\(.+\))(.@?@?[a-zA-Z0-9:_]+|[a-zA-Z]+\(.+\))*$)[...].id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
objects[...].regex(^((@?@?[a-zA-Z0-9:_]+)|[a-zA-Z]+\(.+\))(.@?@?[a-zA-Z0-9:_]+|[a-zA-Z]+\(.+\))*$)[...].name string The name of the object.
platforms * array An array of platform for which the command is executed. Each platform is an ID (GUID).
platforms [...] any of:
string The name of the object.
string An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.

(Required *)

Publish Schema

See Also

Refer to Using the Wwise Authoring API (WAAPI) for more information about Wwise Authoring API.