Version

menu_open
Wwise SDK 2023.1.2
ak.wwise.core.soundbank.generate

Generate a list of SoundBanks with the import definition specified in the WAAPI request. If you do not write the SoundBanks to disk, subscribe to ak.wwise.core.soundbank.generated to receive SoundBank structure info and the bank data as base64. Note: This is a synchronous operation.

Arguments

Name Type Description
soundbanks array List of SoundBank to generate.
soundbanks [...] object SoundBank Info.
soundbanks[...].name * string The name of the SoundBank to generate, a temporary SoundBank will be created if the SoundBank doesn't exists.
soundbanks[...].events array List of events to include in this SoundBank. Not required if the bank already exists.
soundbanks[...].events [...] any of: The ID (GUID), name, or path of the event to include in the SoundBank.
string The name of the object qualified by its type or Short ID in the form of type:name or Global:shortId. Only object types that have globally-unique names or Short Ids are supported. Ex: Event:Play_Sound_01, Global:245489792
string An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
string A project path to a Wwise object, including the category and the work-unit. For example: \Actor-Mixer Hierarchy\Default Work Unit\New Sound SFX.
soundbanks[...].auxBusses array List of AuxBus to include in this SoundBank.
soundbanks[...].auxBusses [...] any of: The ID (GUID), name, or path of the Auxiliary Bus to include in the SoundBank.
string The name of the object qualified by its type or Short ID in the form of type:name or Global:shortId. Only object types that have globally-unique names or Short Ids are supported. Ex: Event:Play_Sound_01, Global:245489792
string An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
string A project path to a Wwise object, including the category and the work-unit. For example: \Actor-Mixer Hierarchy\Default Work Unit\New Sound SFX.
soundbanks[...].inclusions array List of inclusion type to use for this SoundBank. Not required if the bank already exists.
soundbanks[...].inclusions [...] string Possible values:
  • event
  • structure
  • media
soundbanks[...].rebuild boolean Force rebuild of this particuliar SoundBank. Default value: false
platforms array List of platforms to generate. If you don't specify any platforms, all the platforms will be generated
platforms [...] string The ID (GUID) or the name of the platforms
languages array List of languages to generate. If you don't specify any languages, all the languages will be generated.
languages [...] string The ID (GUID) or name of the language.
skipLanguages boolean By default, if you don't specify any languages all languages will be generated. If you set this parameter to true, no localized SoundBank will be generated.
rebuildSoundBanks boolean Will rebuild all SoundBanks if true. If you want to clear the converted media as well, use clearAudioFileCache parameter. Default value: false
clearAudioFileCache boolean Deletes the content of the Wwise audio file cache folder prior to converting source files and generating SoundBanks, which ensures that all source files are reconverted. Note that the whole cache is cleared, for all platforms, regardless of the platforms arguments. Default value: false
writeToDisk boolean Use the normal SoundBank generation process and write the sound bank and info file to disk. Default value: false
rebuildInitBank boolean If you don't use rebuildSoundBanks, use this option to force a rebuild of the Init bank for each specified platform.

Arguments Schema

Result

Name Type Description
logs array The SoundBank generation log. The log is empty when used in WwiseConsole.
logs [...] object A log entry.
logs[...].severity * string
  • Message: Does not affect the integrity of the current operation.
  • Warning: Might affect the integrity of the current operation.
  • Error: Affects the integrity of the current operation.
  • Fatal Error: Prevents the completion of the current operation.

Possible values:

  • Message
  • Warning
  • Error
  • Fatal Error
logs[...].time * integer Number of seconds elapsed since midnight (00:00:00), January 1, 1970, Coordinated Universal Time (UTC), according to the system clock.
logs[...].messageId * string The message ID for the log item.
logs[...].message * string The description message of the log item.
logs[...].platform object The platform ID and name for which the log item was reported.
logs[...].platform.id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
logs[...].platform.name string The name of the object.
logs[...].platform.notes string The notes of the object.
logs[...].platform.type string The type of the object. Refer to Wwise Objects Reference for more information on the types available.
logs[...].platform.pluginName string The name of the plug-in for Source, Effect, Mixer, Device and Metadata plug-in.
logs[...].platform.path string The path of the object from the project root. Ex: '\Actor-Mixer Hierarchy\Default Work Unit\Sound1'
logs[...].platform.parent object The parent of the object in the hierarchy.
logs[...].platform.parent.id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
logs[...].platform.parent.name string The name of the object.
logs[...].platform.owner object The owner of the object. This applies to objects being locally owned by other objects, such as custom effects, custom attenuations, etc.
logs[...].platform.owner.id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
logs[...].platform.owner.name string The name of the object.
logs[...].platform.isPlayable boolean True if the object can be played in Transport.
logs[...].platform.shortId integer The Short ID of the object.
logs[...].platform.classId integer The class ID of the object.
Unsigned Integer 32-bit. Range: [0,4294967295]
logs[...].platform.category string The category of the object. Ex: 'Actor-Mixer Hierarchy'
logs[...].platform.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 .
logs[...].platform.workunit object The parent Work Unit containing the object. The 'id' and the 'name' is returned.
logs[...].platform.workunit.id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
logs[...].platform.workunit.name string The name of the object.
logs[...].platform.childrenCount number The number of children for the object. Note, this is deprecated. The same result can be obtained with children.count().
logs[...].platform.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.
logs[...].platform.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.
logs[...].platform.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.
logs[...].platform.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.
logs[...].platform.musicTransitionRoot object (DEPRECATED) The music transition root containing all other music transitions recursively. Note, this is deprecated. The TransitionRoot reference should be used instead.
logs[...].platform.musicTransitionRoot.id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
logs[...].platform.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.
logs[...].platform.musicPlaylistRoot.id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
logs[...].platform.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 .
logs[...].platform.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 .
logs[...].platform.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 .
logs[...].platform.activeSource object The active source of the sound object.
logs[...].platform.activeSource.id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
logs[...].platform.activeSource.name string The name of the object.
logs[...].platform.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 .
logs[...].platform.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 .
logs[...].platform.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 .
logs[...].platform.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.
logs[...].platform.playbackDuration.playbackDurationMin number The minimum possible time playback can take.
logs[...].platform.playbackDuration.playbackDurationMax number The maximum possible time playback can take.
logs[...].platform.playbackDuration.playbackDurationType string The type of duration.
logs[...].platform.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.
logs[...].platform.duration.min number The minimum possible time playback can take.
logs[...].platform.duration.max number The maximum possible time playback can take.
logs[...].platform.duration.type string The type of duration.
logs[...].platform.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.
logs[...].platform.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}.
logs[...].platform.maxDurationSource.trimmedDuration number The duration in seconds of the longest trimmed source.
logs[...].platform.audioSourceTrimValues object Range of time for which the audio source is trimmed.
logs[...].platform.audioSourceTrimValues.trimBegin number The time value in seconds of the start trim.
logs[...].platform.audioSourceTrimValues.trimEnd number The time value in seconds of the end trim.
logs[...].platform.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.
logs[...].platform.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}.
logs[...].platform.maxRadiusAttenuation.radius number The radius of the attenuation object.
logs[...].platform.audioSourceLanguage object Language associated to the audio source. This only applies to Audio Source objects directly.
logs[...].platform.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}.
logs[...].platform.audioSourceLanguage.name string The name of the Language object to which the Audio Source object is associated.
logs[...].platform.workunitIsDefault boolean True if the work unit is the default.
logs[...].platform.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
logs[...].platform.workunitIsDirty boolean True if a Work Unit or a Project (wproj file) is dirty, meaning it was modified but not saved.
logs[...].platform.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).
logs[...].platform.switchContainerChildContext.id string The ID (GUID) of the object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
logs[...].platform.isExplicitMute boolean Whether or not the object has been muted explicitly. Explicitly muting an object implicitly mutes the descendant objects.
logs[...].platform.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.
logs[...].platform.isImplicitMute boolean Whether or not the object has been muted implicitly. Explicitly muting an object implicitly mutes the descendant objects.
logs[...].platform.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.
logs[...].platform.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.
logs[...].platform.points array This only applies to Curve objects.
An array of points defining a curve.
logs[...].platform.points [...] object A point in the curve.
logs[...].platform.points[...].x * number X coordinate of curve point.
logs[...].platform.points[...].y * number Y coordinate of curve point.
logs[...].platform.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
logs[...].platform.stateProperties array An array of state properties to set.
logs[...].platform.stateProperties [...] string The name of the property to set.
logs[...].platform.stateGroups array The State Group objects associated with this object.
logs[...].platform.stateGroups [...] object A State Group object.
logs[...].platform.stateGroups[...].id string The ID (GUID) of the State Group object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
logs[...].platform.stateGroups[...].name string The name of the State Group object.
logs[...].platform.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.
logs[...].platform.regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) [...] string A string value.
logs[...].platform.regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) [...] number A numeric value.
logs[...].platform.regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) [...] boolean A boolean value.
logs[...].platform.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}.
logs[...].platform.regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$).name string The name of the object.
logs[...].platform.regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) [...] object An object reference value.
logs[...].platform.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}.
logs[...].platform.regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$)[...].name string The name of the object.
logs[...].parameters array An array of parameters in the log item. Not present when no parameter.
logs[...].parameters [...] string A parameter of the log entry. Normally an object name.

Result Schema

See Also

Examples

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