Wwise SDK 2021.1.14

Generate a list of SoundBank with import definition defined in the WAAPI request. If you choose to not write the SoundBanks to disk, subscribe to ak.wwise.core.soundbank.generated to get SoundBank structure info and the bank data as base64.

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 in the form of type:name. Only object types that have globally-unique names are supported. Ex: Event:Play_Sound_01
	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 in the form of type:name. Only object types that have globally-unique names are supported. Ex: Event:Play_Sound_01
	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 [...]	any of:	The ID (GUID) or name of the language.
	string	The name of the object.
	string	An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
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

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.

Get started with Wwise