|
Wwise SDK 2019.2.15
|
Sent when a single SoundBank is generated. This could be sent multiple times during SoundBank generation, for every SoundBank generated and for every platform. To generate SoundBanks, refer to ak.wwise.core.soundbank.generate or ak.wwise.ui.commands.execute with one of the SoundBank generation commands. Refer to Wwise Authoring Command Identifiers for the list of commands.
| Name | Type | Description |
|---|---|---|
| infoFile | boolean | Embed the JSON SoundBank info file in the response. |
| bankData | boolean | Embed the base64 SoundBank data in the response. |
| pluginInfo | boolean | Embed the JSON PluginInfo file in the response. |
| return | array | Data to be returned for the SoundBank generated. Refer to Wwise Objects Reference for more information on the properties 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:
|
|
| 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 . |
| Name | Type | Description |
|---|---|---|
| soundbank | object | The generated SoundBank. Use the return options to obtain specific details. A Wwise object. Use the return options to specify which property is required. |
| soundbank.id | string | The ID (GUID) of the object. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
| soundbank.name | string | The name of the object. |
| soundbank.notes | string | The notes of the object. |
| soundbank.type | string | The type of the object. Refer to Wwise Objects Reference for more information on the types available. |
| soundbank.path | string | The path of the object from the project root. Ex: '\Actor-Mixer Hierarchy\Default Work Unit\Sound1' |
| soundbank.parent | object | The parent of the object in the hierarchy. |
| soundbank.parent.id | string | The ID (GUID) of the object. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
| soundbank.parent.name | string | The name of the object. |
| soundbank.owner | object | The owner of the object. This applies to objects being locally owned by other objects, such as custom effects, custom attenuations, etc. |
| soundbank.owner.id | string | The ID (GUID) of the object. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
| soundbank.owner.name | string | The name of the object. |
| soundbank.isPlayable | boolean | True if the object can be played in Transport. |
| soundbank.shortId | integer | The Short ID of the object. |
| soundbank.classId | integer | The class ID of the object. Unsigned Integer 32-bit. Range: [0,4294967295] |
| soundbank.category | string | The category of the object. Ex: 'Actor-Mixer Hierarchy' |
| soundbank.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 . |
| soundbank.workunit | object | The parent Work Unit containing the object. The 'id' and the 'name' is returned. |
| soundbank.workunit.id | string | The ID (GUID) of the object. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
| soundbank.workunit.name | string | The name of the object. |
| soundbank.childrenCount | number | The number of children for the object. |
| soundbank.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. |
| soundbank.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. |
| soundbank.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. |
| soundbank.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. |
| soundbank.music:transitionRoot | object | The music transition root containing all other music transitions recursively. |
| soundbank.music:transitionRoot.id | string | The ID (GUID) of the object. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
| soundbank.music:playlistRoot | object | The music playlist root containing all other music playlist items recursively. This applies to Music Playlist Containers only. |
| soundbank.music:playlistRoot.id | string | The ID (GUID) of the object. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
| soundbank.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 . |
| soundbank.sound: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 在 Mac 上使用 WAAPI . |
| soundbank.soundbank:bnkFilePath | 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 在 Mac 上使用 WAAPI . |
| soundbank.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. |
| soundbank.audioSource:playbackDuration.playbackDurationMin | number | The minimum possible time playback can take. |
| soundbank.audioSource:playbackDuration.playbackDurationMax | number | The maximum possible time playback can take. |
| soundbank.audioSource:playbackDuration.playbackDurationType | string | The type of duration. |
| soundbank.audioSource: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. |
| soundbank.audioSource: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}. |
| soundbank.audioSource:maxDurationSource.trimmedDuration | number | The duration in seconds of the longest trimmed source. |
| soundbank.audioSource:trimValues | object | Range of time for which the audio source is trimmed. |
| soundbank.audioSource:trimValues.trimBegin | number | The time value in seconds of the start trim. |
| soundbank.audioSource:trimValues.trimEnd | number | The time value in seconds of the end trim. |
| soundbank.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. |
| soundbank.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}. |
| soundbank.audioSource:maxRadiusAttenuation.radius | number | The radius of the attenuation object. |
| soundbank.audioSource:language | object | Language associated to the audio source. This only applies to Audio Source objects directly. |
| soundbank.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}. |
| soundbank.audioSource:language.name | string | The name of the Language object to which the Audio Source object is associated. |
| soundbank.workunit:isDefault | boolean | True if the work unit is the default. |
| soundbank.workunit:type | string | The type of the Work Unit. Please note that, like Work Units, physical folders have the type "WorkUnit". Physical folders have the workunit:type "folder". Possible values:
|
| soundbank.workunit:isDirty | boolean | True if a Work Unit or a Project (wproj file) is dirty, meaning it was modified but not saved. |
| soundbank.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: the properties of the '1st only' checkbox). |
| soundbank.switchContainerChild:context.id | string | The ID (GUID) of the object. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
| soundbank.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. |
|
| soundbank.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}. |
| soundbank.regex(^((@?@?[a-zA-Z0-9:_]+)|[a-zA-Z]+(.+))(.@?@?[a-zA-Z0-9:_]+|[a-zA-Z]+(.+))*$).name | string | The name of the object. |
| platform | object | The platform for which the SoundBank was generated. |
| language | object | The language for which the SoundBank was generated. Only present when generating a SoundBank for a specific language. |
| error | string | The error message, if an error occurred. Only present if an error occurred. |
| bankData | object | SoundBank data object containg the actual data encoded in base64 and the size. |
| bankData.data | string | Data of the SoundBank encoded in base64. |
| bankData.size | integer | Size of the SoundBank data when decoded. |
| bankInfo | array | All the informations for SoundBank. |
| bankInfo [...] | object | SoundBank information. |
| bankInfo[...].Id | string | Short ID of the resulting bank encoded in a string. |
| bankInfo[...].GUID | string | GUID of the resulting SoundBank. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
| bankInfo[...].ObjectPath | string | Object path in the project. |
| bankInfo[...].Language | string | The name of the language being used in this soundbank. |
| bankInfo[...].ShortName | string | The name of the SoundBank. |
| bankInfo[...].Path | string | The file name of the SoundBank. |
| bankInfo[...].IncludedEvents | array | All the events included in this SoundBank with their information. |
| bankInfo[...].IncludedEvents [...] | object | Event information |
| bankInfo[...].IncludedEvents[...].Id | string | Short ID of the event. |
| bankInfo[...].IncludedEvents[...].Name | string | Name of the event. |
| bankInfo[...].IncludedEvents[...].GUID | string | GUID of the event. An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}. |
| bankInfo[...].IncludedEvents[...].MaxAttenuation | string | The max attenuation of the event as a floating point value. |
| bankInfo[...].IncludedEvents[...].DurationType | string | The kind of duration, possible values: OneShot, Unknown, Infinite, Mixed. |
| bankInfo[...].IncludedEvents[...].DurationMin | string | The minimum value for the duration as a floating point value. |
| bankInfo[...].IncludedEvents[...].DurationMax | string | The maximum value for the duration as a floating point value. |
| bankInfo[...].IncludedEvents[...].ReferencedStreamedFiles | array | List of all streamed files used by this SoundBank or event. |
| bankInfo[...].IncludedEvents[...].ReferencedStreamedFiles [...] | object | Referenced Streamed File entry Media File reference |
| bankInfo[...].IncludedEvents[...].ReferencedStreamedFiles[...].Id | string | Short ID of the media. |
| bankInfo[...].IncludedEvents[...].ReferencedStreamedFiles[...].Language | string | Language name used for this media. |
| bankInfo[...].IncludedEvents[...].ReferencedStreamedFiles[...].ShortName | string | File name of the original file. |
| bankInfo[...].IncludedEvents[...].ReferencedStreamedFiles[...].Path | string | Path of the converted media relative to the cache folder. |
| bankInfo[...].IncludedEvents[...].ReferencedStreamedFiles[...].PrefetchSize | string | Size of bytes of the prefetch size |
| bankInfo[...].IncludedEvents[...].ReferencedStreamedFiles[...].UseDeviceMemory | string | Does the media requires device memory or not. Possible values:
|
| bankInfo[...].IncludedEvents[...].ExcludedMemoryFiles | array | List of excluded media in the SoundBank or event. If you are using prefetch on a streamed file, the prefetch size will be listed here. |
| bankInfo[...].IncludedEvents[...].ExcludedMemoryFiles [...] | object | Excluded Memory File entry Media File reference |
| bankInfo[...].IncludedEvents[...].ExcludedMemoryFiles[...].Id | string | Short ID of the media. |
| bankInfo[...].IncludedEvents[...].ExcludedMemoryFiles[...].Language | string | Language name used for this media. |
| bankInfo[...].IncludedEvents[...].ExcludedMemoryFiles[...].ShortName | string | File name of the original file. |
| bankInfo[...].IncludedEvents[...].ExcludedMemoryFiles[...].Path | string | Path of the converted media relative to the cache folder. |
| bankInfo[...].IncludedEvents[...].ExcludedMemoryFiles[...].PrefetchSize | string | Size of bytes of the prefetch size |
| bankInfo[...].IncludedEvents[...].ExcludedMemoryFiles[...].UseDeviceMemory | string | Does the media requires device memory or not. Possible values:
|
| PluginInfo | object | PluginInfo file info |
| PluginInfo.Project | string | Name of the Wwise project. |
| PluginInfo.Platform | string | Name of the platform. |
| PluginInfo.BasePlatform | string | The base platform the current platform is based off. |
| PluginInfo.Plugins | array | List of the plugins |
| PluginInfo.Plugins [...] | object | Plugin information. |
| PluginInfo.Plugins[...].Name | string | Display Name of the plugin. |
| PluginInfo.Plugins[...].ID | string | Short ID of the plugin. |
| PluginInfo.Plugins[...].DLL | string | Name of the DLL for the plugin. |
Refer to 使用 Wwise Authoring API（WAAPI） for more information about Wwise Authoring API.