Version
menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2023.1.8.8601 ). 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.
Wwise SDK 2023.1.8
ak.wwise.core.soundbank.generated

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.

Options

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:
  • 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
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 .

Options Schema

Publish

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.pluginName string The name of the plug-in for Source, Effect, Mixer, Device and Metadata plug-in.
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 Using WAAPI on Mac .
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. Note, this is deprecated. The same result can be obtained with children.count().
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.musicTransitionRoot object (DEPRECATED) The music transition root containing all other music transitions recursively. Note, this is deprecated. The TransitionRoot reference should be used instead.
soundbank.musicTransitionRoot.id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
soundbank.musicPlaylistRoot object (DEPRECATED) The music playlist root containing all other music playlist items recursively. This applies to Music Playlist Containers only. Note, this is deprecated. The PlaylistRoot reference should be used instead.
soundbank.musicPlaylistRoot.id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
soundbank.originalWavFilePath string (DEPRECATED) 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 .
soundbank.originalFilePath string Absolute path to the original file. Only valid for Sound and Audio Source objects. For using WAAPI on Mac, please refer to Using WAAPI on Mac .
soundbank.originalRelativeFilePath string Relative (from project's Originals Folder) path to the original file. Only valid for Sound and Audio Source objects. For using WAAPI on Mac, please refer to Using WAAPI on Mac .
soundbank.activeSource object The active source of the sound object.
soundbank.activeSource.id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
soundbank.activeSource.name string The name of the object.
soundbank.convertedWemFilePath string (DEPRECATED) 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 .
soundbank.convertedFilePath string Absolute path to the converted 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 .
soundbank.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 .
soundbank.playbackDuration object The duration root that contains the min and max durations and duration type. Note, this is deprecated. The duration should be used instead. This applies to all objects that can contain Audio Source objects, either directly as a source or indirectly through descendants.
soundbank.playbackDuration.playbackDurationMin number The minimum possible time playback can take.
soundbank.playbackDuration.playbackDurationMax number The maximum possible time playback can take.
soundbank.playbackDuration.playbackDurationType string The type of duration.
soundbank.duration 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.duration.min number The minimum possible time playback can take.
soundbank.duration.max number The maximum possible time playback can take.
soundbank.duration.type string The type of duration.
soundbank.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.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.maxDurationSource.trimmedDuration number The duration in seconds of the longest trimmed source.
soundbank.audioSourceTrimValues object Range of time for which the audio source is trimmed.
soundbank.audioSourceTrimValues.trimBegin number The time value in seconds of the start trim.
soundbank.audioSourceTrimValues.trimEnd number The time value in seconds of the end trim.
soundbank.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.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.maxRadiusAttenuation.radius number The radius of the attenuation object.
soundbank.audioSourceLanguage object Language associated to the audio source. This only applies to Audio Source objects directly.
soundbank.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}.
soundbank.audioSourceLanguage.name string The name of the Language object to which the Audio Source object is associated.
soundbank.workunitIsDefault boolean True if the work unit is the default.
soundbank.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
soundbank.workunitIsDirty boolean True if a Work Unit or a Project (wproj file) is dirty, meaning it was modified but not saved.
soundbank.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).
soundbank.switchContainerChildContext.id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
soundbank.isExplicitMute boolean Whether or not the object has been muted explicitly. Explicitly muting an object implicitly mutes the descendant objects.
soundbank.isExplicitSolo boolean Whether or not the object has been soloed explicitly. Soloing an object silences all the other objects in the project except this one.
soundbank.isImplicitMute boolean Whether or not the object has been muted implicitly. Explicitly muting an object implicitly mutes the descendant objects.
soundbank.isImplicitSolo boolean Whether or not the object has been soloed implicitly. Soloing an object silences all the other objects in the project except this one.
soundbank.isIncluded boolean Whether or not the object is Included. Specify the platform in the options. This takes into consideration the Inclusion status of the object's ancestors.
soundbank.points array This only applies to Curve objects.
An array of points defining a curve.
soundbank.points [...] object A point in the curve.
soundbank.points[...].x * number X coordinate of curve point.
soundbank.points[...].y * number Y coordinate of curve point.
soundbank.points[...].shape * string Shape of the curve segment between this point and the next. Possible values:
  • Constant
  • Linear
  • Log3
  • Log2
  • Log1
  • InvertedSCurve
  • SCurve
  • Exp1
  • Exp2
  • Exp3
soundbank.stateProperties array An array of state properties to set.
soundbank.stateProperties [...] string The name of the property to set.
soundbank.stateGroups array The State Group objects associated with this object.
soundbank.stateGroups [...] object A State Group object.
soundbank.stateGroups[...].id string The ID (GUID) of the State Group object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
soundbank.stateGroups[...].name string The name of the State Group object.
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.
array An array of string values.
number A numeric value.
array An array of numeric values.
boolean A boolean value.
array An array of boolean values.
object An object reference value.
array An object list reference value.
soundbank.regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) [...] string A string value.
soundbank.regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) [...] number A numeric value.
soundbank.regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) [...] boolean A boolean 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.
soundbank.regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) [...] 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[...].Type string SoundBank type. If the SoundBank is defined by the user, then the type is 'User'. Otherwise, the bank was auto defined by Wwise. Possible values:
  • User
  • Event
  • Bus
bankInfo[...].Hash string Hash value (128-bit) written to the associated SoundBank .bnk file. Used during SoundBank generation to check existing .bnk files for changes.
bankInfo[...].Align string Required alignment for media file. If not specified then the alignment is 16 bytes.
bankInfo[...].DeviceMemory string Does the media requires device memory or not. Possible values:
  • true
  • false
bankInfo[...].Media array All media files referenced by this SoundBank with their information.
bankInfo[...].Media [...] object Media file descriptor
bankInfo[...].Media[...].Id * string Short ID of the media.
bankInfo[...].Media[...].Language string Language name used for this media.
bankInfo[...].Media[...].ShortName * string File name of the original file.
bankInfo[...].Media[...].CachePath * string Path of the converted media relative to the cache folder.
bankInfo[...].Media[...].Path string Path of the copied media file (if copied) relative to the output folder.
bankInfo[...].Media[...].PrefetchSize string Prefetch size in bytes.
bankInfo[...].Media[...].Align string Required alignment for media file in bytes. If not specified then the alignment is 16 bytes.
bankInfo[...].Media[...].DeviceMemory string Does the media requires device memory or not. If not specified then the value is false. Possible values:
  • true
  • false
bankInfo[...].Media[...].Streaming * string Is the file streamed. If not specified then the value is false. Possible values:
  • true
  • false
bankInfo[...].Media[...].Location * string Where is file located. In the case of a streamed file with prefetch, this will indicate where to find the prefetched portion. Possible values:
  • Memory
  • Loose
  • OtherBank
bankInfo[...].Media[...].UsingReferenceLanguage string Is the media using the reference language. If not specified then the value is false. Possible values:
  • true
  • false
bankInfo[...].ExternalSources array All external sources referenced by this SoundBank with their information.
bankInfo[...].ExternalSources [...] External source descriptor.
bankInfo[...].Plugins Plug-in descriptors.
bankInfo[...].Events array All the events included in this SoundBank with their information.
bankInfo[...].Events [...] object Event information
bankInfo[...].Events[...].Id * string Short ID of the event.
bankInfo[...].Events[...].Name * string Name of the event.
bankInfo[...].Events[...].ObjectPath string Object path in the project.
bankInfo[...].Events[...].GUID string GUID of the event.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
bankInfo[...].Events[...].MaxAttenuation string The max distance for the attenuation of the event as a floating point value.
bankInfo[...].Events[...].DurationType string The kind of duration, possible values: OneShot, Unknown, Infinite, Mixed.
bankInfo[...].Events[...].DurationMin string The minimum value for the duration as a floating point value.
bankInfo[...].Events[...].DurationMax string The maximum value for the duration as a floating point value.
bankInfo[...].Events[...].MediaRefs array List of all media files used by this event.
bankInfo[...].Events[...].MediaRefs [...] object Referenced media file entry
Media file descriptor reference
bankInfo[...].Events[...].MediaRefs[...].Id * string Short ID of the media.
bankInfo[...].Events[...].ExternalSourceRefs array List of all external sources used by this event.
bankInfo[...].Events[...].ExternalSourceRefs [...] object Referenced external source entry
External Source descriptor reference.
bankInfo[...].Events[...].ExternalSourceRefs[...].Cookie * string Cookie assigned to external source.
bankInfo[...].Events[...].PluginRefs object List of all plug-ins used by this event.
Plug-in descriptor reference.
bankInfo[...].Events[...].PluginRefs.Custom array Array of references to custom plug-in instances.
bankInfo[...].Events[...].PluginRefs.Custom [...] object Plug-in descriptor reference.
bankInfo[...].Events[...].PluginRefs.Custom[...].Id * string Short ID of plug-in instance.
bankInfo[...].Events[...].PluginRefs.ShareSets array Array of references to plug-in sharesets.
bankInfo[...].Events[...].PluginRefs.ShareSets [...] object Plug-in descriptor reference.
bankInfo[...].Events[...].PluginRefs.ShareSets[...].Id * string Short ID of plug-in instance.
bankInfo[...].Events[...].PluginRefs.AudioDevices array Array of references to audio device plug-ins.
bankInfo[...].Events[...].PluginRefs.AudioDevices [...] object Plug-in descriptor reference.
bankInfo[...].Events[...].PluginRefs.AudioDevices[...].Id * string Short ID of plug-in instance.
bankInfo[...].Events[...].AuxBusRefs array List of all Aux Busses referenced by this event.
bankInfo[...].Events[...].AuxBusRefs [...] object Reference to Aux Bus.
Aux Bus reference.
bankInfo[...].Events[...].AuxBusRefs[...].Id * string Short ID of Aux Bus.
bankInfo[...].Events[...].AuxBusRefs[...].Name * string Name of the Aux Bus.
bankInfo[...].Events[...].AuxBusRefs[...].ObjectPath string Object path in the project.
bankInfo[...].Events[...].AuxBusRefs[...].GUID string GUID of the Aux Bus.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
bankInfo[...].Events[...].ActionSetState array List of set State actions in Event.
bankInfo[...].Events[...].ActionSetState [...] object Set State Action information.
bankInfo[...].Events[...].ActionSetState[...].GroupId * string Short ID of the State Group.
bankInfo[...].Events[...].ActionSetState[...].Id * string Short ID of the State.
bankInfo[...].Events[...].ActionSetState[...].Name * string Name of the State.
bankInfo[...].Events[...].ActionSetState[...].ObjectPath string Object path in the project.
bankInfo[...].Events[...].ActionSetState[...].GUID string GUID of the State.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
bankInfo[...].Events[...].ActionSetSwitch array List of set Switch actions in Event.
bankInfo[...].Events[...].ActionSetSwitch [...] object Set Switch Action information.
bankInfo[...].Events[...].ActionSetSwitch[...].GroupId * string Short ID of the Switch Group.
bankInfo[...].Events[...].ActionSetSwitch[...].Id * string Short ID of the Switch.
bankInfo[...].Events[...].ActionSetSwitch[...].Name * string Name of the Switch.
bankInfo[...].Events[...].ActionSetSwitch[...].ObjectPath string Object path in the project.
bankInfo[...].Events[...].ActionSetSwitch[...].GUID string GUID of the Switch.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
bankInfo[...].Events[...].ActionTrigger array List of Trigger actions in Event.
bankInfo[...].Events[...].ActionTrigger [...] object Trigger Action information.
bankInfo[...].Events[...].ActionTrigger[...].Id * string Short ID of the Trigger.
bankInfo[...].Events[...].ActionTrigger[...].Name * string Name of the Trigger.
bankInfo[...].Events[...].ActionTrigger[...].ObjectPath string Object path in the project.
bankInfo[...].Events[...].ActionTrigger[...].GUID string GUID of the Trigger.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
bankInfo[...].Events[...].ActionSetFX array List of Set Effect actions in Event.
bankInfo[...].Events[...].ActionSetFX [...] object Set Effect Action information.
bankInfo[...].Events[...].ActionSetFX[...].Id * string Short ID of the Effect.
bankInfo[...].Events[...].ActionSetFX[...].Name * string Name of the Effect.
bankInfo[...].Events[...].ActionSetFX[...].ObjectPath string Object path in the project.
bankInfo[...].Events[...].ActionSetFX[...].GUID string GUID of the Effect.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
bankInfo[...].Events[...].SwitchContainers array List of association of switch container value to its used media.
bankInfo[...].Events[...].SwitchContainers [...] object SwitchContainer entry
Association of switch container value to its used resources.
bankInfo[...].Events[...].SwitchContainers[...].SwitchValue * object Group id and value used for switch container.
bankInfo[...].Events[...].SwitchContainers[...].SwitchValue.GroupType * string Group type. Possible values:
  • Switch
  • State
bankInfo[...].Events[...].SwitchContainers[...].SwitchValue.GroupId * string Switch/State group short Id.
bankInfo[...].Events[...].SwitchContainers[...].SwitchValue.Id * string Switch/State short Id.
bankInfo[...].Events[...].SwitchContainers[...].SwitchValue.GUID string GUID of the switch container value used.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
bankInfo[...].Events[...].SwitchContainers[...].SwitchValue.Default string Whether the Switch/State value is the switch container's default. If not specified then the value is false. Possible values:
  • true
  • false
bankInfo[...].Events[...].SwitchContainers[...].MediaRefs array List of all media files used by this event.
bankInfo[...].Events[...].SwitchContainers[...].MediaRefs [...] object Referenced media file entry
Media file descriptor reference
bankInfo[...].Events[...].SwitchContainers[...].MediaRefs[...].Id * string Short ID of the media.
bankInfo[...].Events[...].SwitchContainers[...].ExternalSourceRefs array List of all external sources used by this event.
bankInfo[...].Events[...].SwitchContainers[...].ExternalSourceRefs [...] object Referenced external source entry
External Source descriptor reference.
bankInfo[...].Events[...].SwitchContainers[...].ExternalSourceRefs[...].Cookie * string Cookie assigned to external source.
bankInfo[...].Events[...].SwitchContainers[...].PluginRefs object List of all plug-ins used by this event.
Plug-in descriptor reference.
bankInfo[...].Events[...].SwitchContainers[...].PluginRefs.Custom array Array of references to custom plug-in instances.
bankInfo[...].Events[...].SwitchContainers[...].PluginRefs.Custom [...] object Plug-in descriptor reference.
bankInfo[...].Events[...].SwitchContainers[...].PluginRefs.Custom[...].Id * string Short ID of plug-in instance.
bankInfo[...].Events[...].SwitchContainers[...].PluginRefs.ShareSets array Array of references to plug-in sharesets.
bankInfo[...].Events[...].SwitchContainers[...].PluginRefs.ShareSets [...] object Plug-in descriptor reference.
bankInfo[...].Events[...].SwitchContainers[...].PluginRefs.ShareSets[...].Id * string Short ID of plug-in instance.
bankInfo[...].Events[...].SwitchContainers[...].PluginRefs.AudioDevices array Array of references to audio device plug-ins.
bankInfo[...].Events[...].SwitchContainers[...].PluginRefs.AudioDevices [...] object Plug-in descriptor reference.
bankInfo[...].Events[...].SwitchContainers[...].PluginRefs.AudioDevices[...].Id * string Short ID of plug-in instance.
bankInfo[...].Events[...].SwitchContainers[...].Children array Children of this switch container value.
bankInfo[...].Events[...].SwitchContainers[...].Children [...] Child entry of the switch container
bankInfo[...].DialogueEvents array All the dialogue events included in this SoundBank with their information.
bankInfo[...].DialogueEvents [...] object Dialogue Event information
bankInfo[...].DialogueEvents[...].Id * string Short ID of the dialogue event.
bankInfo[...].DialogueEvents[...].Name * string Name of the dialogue event.
bankInfo[...].DialogueEvents[...].ObjectPath string Object path in the project.
bankInfo[...].DialogueEvents[...].GUID string GUID of the dialogue event.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
bankInfo[...].DialogueEvents[...].Arguments array List of dialogue event's arguments.
bankInfo[...].DialogueEvents[...].Arguments [...] object Argument information
bankInfo[...].DialogueEvents[...].Arguments[...].Id * string Short ID of the dialogue event.
bankInfo[...].DialogueEvents[...].Arguments[...].Name * string Name of the dialogue event.
bankInfo[...].DialogueEvents[...].Arguments[...].ObjectPath string Object path in the project.
bankInfo[...].DialogueEvents[...].Arguments[...].GUID string GUID of the dialogue event.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
bankInfo[...].Busses array List of all AuxBus used in this SoundBank.
bankInfo[...].Busses [...] object Bus information.
bankInfo[...].Busses[...].Id * string Short ID of the Bus.
bankInfo[...].Busses[...].Name * string Name of the Bus.
bankInfo[...].Busses[...].MaxAttenuation string The max distance for the attenuation of the bus as a floating point value.
bankInfo[...].Busses[...].ObjectPath string Object path in the project.
bankInfo[...].Busses[...].GUID string GUID of the Bus.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
bankInfo[...].Busses[...].PluginRefs object Array of plug-in references.
Plug-in descriptor reference.
bankInfo[...].Busses[...].PluginRefs.Custom array Array of references to custom plug-in instances.
bankInfo[...].Busses[...].PluginRefs.Custom [...] object Plug-in descriptor reference.
bankInfo[...].Busses[...].PluginRefs.Custom[...].Id * string Short ID of plug-in instance.
bankInfo[...].Busses[...].PluginRefs.ShareSets array Array of references to plug-in sharesets.
bankInfo[...].Busses[...].PluginRefs.ShareSets [...] object Plug-in descriptor reference.
bankInfo[...].Busses[...].PluginRefs.ShareSets[...].Id * string Short ID of plug-in instance.
bankInfo[...].Busses[...].PluginRefs.AudioDevices array Array of references to audio device plug-ins.
bankInfo[...].Busses[...].PluginRefs.AudioDevices [...] object Plug-in descriptor reference.
bankInfo[...].Busses[...].PluginRefs.AudioDevices[...].Id * string Short ID of plug-in instance.
bankInfo[...].Busses[...].AuxBusRefs array List of Aux Busses referenced by this event.
bankInfo[...].Busses[...].AuxBusRefs [...] object Reference to Aux Bus.
Aux Bus reference.
bankInfo[...].Busses[...].AuxBusRefs[...].Id * string Short ID of Aux Bus.
bankInfo[...].Busses[...].AuxBusRefs[...].Name * string Name of the Aux Bus.
bankInfo[...].Busses[...].AuxBusRefs[...].ObjectPath string Object path in the project.
bankInfo[...].Busses[...].AuxBusRefs[...].GUID string GUID of the Aux Bus.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
bankInfo[...].AuxBusses array List of all AuxBus used in this SoundBank.
bankInfo[...].AuxBusses [...] object AuxBus information.
bankInfo[...].AuxBusses[...].Id * string Short ID of the AuxBus.
bankInfo[...].AuxBusses[...].Name * string Name of the AuxBus.
bankInfo[...].AuxBusses[...].MaxAttenuation string The max distance for the attenuation of the aux bus as a floating point value.
bankInfo[...].AuxBusses[...].ObjectPath string Object path in the project.
bankInfo[...].AuxBusses[...].GUID string GUID of the AuxBus.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
bankInfo[...].AuxBusses[...].PluginRefs object Array of plug-in references.
Plug-in descriptor reference.
bankInfo[...].AuxBusses[...].PluginRefs.Custom array Array of references to custom plug-in instances.
bankInfo[...].AuxBusses[...].PluginRefs.Custom [...] object Plug-in descriptor reference.
bankInfo[...].AuxBusses[...].PluginRefs.Custom[...].Id * string Short ID of plug-in instance.
bankInfo[...].AuxBusses[...].PluginRefs.ShareSets array Array of references to plug-in sharesets.
bankInfo[...].AuxBusses[...].PluginRefs.ShareSets [...] object Plug-in descriptor reference.
bankInfo[...].AuxBusses[...].PluginRefs.ShareSets[...].Id * string Short ID of plug-in instance.
bankInfo[...].AuxBusses[...].PluginRefs.AudioDevices array Array of references to audio device plug-ins.
bankInfo[...].AuxBusses[...].PluginRefs.AudioDevices [...] object Plug-in descriptor reference.
bankInfo[...].AuxBusses[...].PluginRefs.AudioDevices[...].Id * string Short ID of plug-in instance.
bankInfo[...].AuxBusses[...].AuxBusRefs array List of all Aux Busses referenced by this event.
bankInfo[...].AuxBusses[...].AuxBusRefs [...] object Reference to Aux Bus.
Aux Bus reference.
bankInfo[...].AuxBusses[...].AuxBusRefs[...].Id * string Short ID of Aux Bus.
bankInfo[...].AuxBusses[...].AuxBusRefs[...].Name * string Name of the Aux Bus.
bankInfo[...].AuxBusses[...].AuxBusRefs[...].ObjectPath string Object path in the project.
bankInfo[...].AuxBusses[...].AuxBusRefs[...].GUID string GUID of the Aux Bus.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
bankInfo[...].GameParameters array List of all the Game Parameters/RTPC used in this SoundBank.
bankInfo[...].GameParameters [...] object GameParameter information
bankInfo[...].GameParameters[...].Id * string Short ID of the Game Parameter.
bankInfo[...].GameParameters[...].Name * string Name of the Game Parameter.
bankInfo[...].GameParameters[...].ObjectPath string Object path in the project.
bankInfo[...].GameParameters[...].GUID string GUID of the Game Parameter.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
bankInfo[...].Triggers array List of all Triggers used in this SoundBank.
bankInfo[...].Triggers [...] object Trigger information.
bankInfo[...].Triggers[...].Id * string Short ID of the Trigger.
bankInfo[...].Triggers[...].Name * string Name of the Trigger.
bankInfo[...].Triggers[...].ObjectPath string Object path in the project.
bankInfo[...].Triggers[...].GUID string GUID of the Trigger.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
bankInfo[...].StateGroups array List of State Group included in this SoundBank.
bankInfo[...].StateGroups [...] object State Group information.
bankInfo[...].StateGroups[...].Id * string Short ID of the State Group.
bankInfo[...].StateGroups[...].Name * string Name of the State Group.
bankInfo[...].StateGroups[...].ObjectPath string Object path in the project.
bankInfo[...].StateGroups[...].GUID string GUID of the State Group.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
bankInfo[...].StateGroups[...].States array List of State included in this StateGroup.
bankInfo[...].StateGroups[...].States [...] object State information
bankInfo[...].StateGroups[...].States[...].Id * string Short ID of the State.
bankInfo[...].StateGroups[...].States[...].Name * string Name of the State.
bankInfo[...].StateGroups[...].States[...].ObjectPath string Object path in the project.
bankInfo[...].StateGroups[...].States[...].GUID string GUID of the State.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
bankInfo[...].SwitchGroups array List of SwitchGroup included in this SoundBank.
bankInfo[...].SwitchGroups [...] object SwitchGroup information
bankInfo[...].SwitchGroups[...].Id * string Short ID of the SwitchGroup.
bankInfo[...].SwitchGroups[...].Name * string Name of the SwitchGroup.
bankInfo[...].SwitchGroups[...].ObjectPath string Object path in the project.
bankInfo[...].SwitchGroups[...].GUID string GUID of the SwitchGroup.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
bankInfo[...].SwitchGroups[...].GameParameterRef object Game Parameter used to control the Switch Group.
bankInfo[...].SwitchGroups[...].GameParameterRef.Id * string Short ID of the Game Parameter.
bankInfo[...].SwitchGroups[...].Switches array List of the Switch contained in this SwitchGroup.
bankInfo[...].SwitchGroups[...].Switches [...] object Switch information.
bankInfo[...].SwitchGroups[...].Switches[...].Id * string Short ID of the Switch.
bankInfo[...].SwitchGroups[...].Switches[...].Name * string Name of the Switch.
bankInfo[...].SwitchGroups[...].Switches[...].ObjectPath string Object path in the project.
bankInfo[...].SwitchGroups[...].Switches[...].GUID string GUID of the Switch.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
bankInfo[...].AcousticTextures array List of all Acoustic Textures used in this SoundBank.
bankInfo[...].AcousticTextures [...] object Acoustic texture information.
bankInfo[...].AcousticTextures[...].Id * string Short ID of the Acoustic Texture.
bankInfo[...].AcousticTextures[...].Name * string Name of the Acoustic Texture.
bankInfo[...].AcousticTextures[...].ObjectPath string Object path in the project.
bankInfo[...].AcousticTextures[...].GUID string GUID of the Acoustic Texture.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
bankInfo[...].AcousticTextures[...].Properties array List of Acoustic Texture properties.
bankInfo[...].AcousticTextures[...].Properties [...] object Acoustic Texture property information.
bankInfo[...].AcousticTextures[...].Properties[...].Name string Acoustic Texture property name.
bankInfo[...].AcousticTextures[...].Properties[...].Type string Acoustic Texture property type.
bankInfo[...].AcousticTextures[...].Properties[...].Value string Acoustic Texture property value.
pluginInfo object PluginInfo file info
pluginInfo.Platform * string Name of the platform.
pluginInfo.BasePlatform * string The base platform the current platform is based off.
pluginInfo.PluginLibs array List of the plugins
pluginInfo.PluginLibs [...] object Plugin information.
pluginInfo.PluginLibs[...].LibName * string Display Name of the plugin.
pluginInfo.PluginLibs[...].LibId * string Short ID of the plugin.
pluginInfo.PluginLibs[...].Type * string Type of the plugin.
pluginInfo.PluginLibs[...].DLL string Name of the DLL for the plugin.
pluginInfo.PluginLibs[...].StaticLib string Name of the static lib for the plugin.

(Required *)

Publish Schema

See Also

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

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise