|
Wwise SDK 2019.1.11
|
Sent when a command is executed. The objects for which the command is executed are sent in the publication.
| Name | Type | Description |
|---|---|---|
| platform | any of: | The ID (GUID) or name of the platform. |
| string | The name of the platform. |
|
| string | The id of the platform. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
|
| 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 will be returned. This can include built-in accessors, such as the name or id, or object properties, such as the Volume or Pitch. |
| return [...] | any of: | A return expression. |
| string | Specifies one or many of the built-in accessors for Wwise objects. Possible values:
|
|
| 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 . |
|
| 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}. |
| Name | Type | Description |
|---|---|---|
| platforms * | array | An array of platform for which the command is executed. Each platform is an ID (GUID). |
| platforms [...] | string | An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
| 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 used. |
| objects [...] | object | The objects. Use the options to specify which data to return. Default will return id and name. A Wwise object. Use the return options to specify which property is required. |
| objects[...].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 MacでWAAPIを使う . |
| objects[...].objectSize | integer | The amount of space (in bytes) the meta-data of the object will 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[...].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. |
| objects[...].audioSource:maxDurationSource.id | string | The ID (GUID) of the audio source object with longest duration. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
| objects[...].audioSource:maxDurationSource.trimmedDuration | number | The duration in seconds of the longest trimmed source. |
| objects[...].music:transitionRoot | object | The music transition root containing all other music transitions recursively. |
| objects[...].music:transitionRoot.id | string | The ID (GUID) of the object. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
| objects[...].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:
|
| 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[...].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[...].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 MacでWAAPIを使う . |
| objects[...].structureSize | integer | The amount of space (in bytes) the meta-data of the object and all of its children will 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[...].id | string | The ID (GUID) of the object. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
| objects[...].category | string | The category of the object. Ex: 'Actor-Mixer Hierarchy' |
| objects[...].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). |
| objects[...].switchContainerChild:context.id | string | The ID (GUID) of the object. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
| objects[...].totalSize | integer | The amount of space (in bytes) this object and all of its children will 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[...].type | string | The type of the object. Refer to Wwise Objects Reference for more information on the types available. |
| objects[...].workunit:isDefault | boolean | True if the work unit is the default. |
| objects[...].isPlayable | boolean | True if the object can be played in Transport. |
| objects[...].audioSource:trimValues | object | Range of time for which the audio source is trimmed. |
| objects[...].audioSource:trimValues.trimBegin | number | The time value in seconds of the start trim. |
| objects[...].audioSource:trimValues.trimEnd | number | The time value in seconds of the end trim. |
| objects[...].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. |
| objects[...].audioSource:maxRadiusAttenuation.radius | number | The radius of the attenuation object. |
| objects[...].audioSource: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[...].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[...].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 MacでWAAPIを使う . |
| objects[...].workunit:isDirty | boolean | True if a Work Unit or a Project (wproj file) is dirty, meaning it is modified but not saved. |
| objects[...].workunit | object | The parent Work Unit containing the object. The 'id' and the 'name' will be 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[...].shortId | integer | The short ID of the object. |
| 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. For using WAAPI on Mac, please refer to MacでWAAPIを使う . |
| objects[...].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. |
| objects[...].audioSource:playbackDuration.playbackDurationMin | number | The minimum possible time playback can take. |
| objects[...].audioSource:playbackDuration.playbackDurationMax | number | The maximum possible time playback can take. |
| objects[...].audioSource:playbackDuration.playbackDurationType | string | The type of duration. |
| objects[...].path | string | The path of the object from the project root. Ex: '\Actor-Mixer Hierarchy\Default Work Unit\Sound1' |
| objects[...].music:playlistRoot | object | The music playlist root containing all other music playlist items recursively. This applies to Music Playlist Containers only. |
| objects[...].music:playlistRoot.id | string | The ID (GUID) of the object. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
| objects[...].classId | integer | The class ID of the object. Unsigned Integer 32-bit. Range: [0,4294967295] |
| objects[...].name | string | The name of the object. |
| objects[...].audioSource:language | object | Language associated to the audio source. This only applies to Audio Source objects directly. |
| objects[...].audioSource:language.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[...].audioSource:language.name | string | The name of the Language object to which the Audio Source object is associated. |
| objects[...].notes | string | The notes of the object. |
| objects[...].childrenCount | number | The number of children for the object. |
| 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 using 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. |
|
| 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. |
| command * | string | The command ID that was executed. |
(Required *)
Refer to Wwise Authoring API (WAAPI)を使用する for more information about WAAPI.