Version

menu_open
Wwise SDK 2022.1.12
ak.wwise.core.soundbank.generate Arguments Schema

Schema

{
"type": "object",
"properties": {
"soundbanks": {
"type": "array",
"description": "List of SoundBank to generate.",
"items": {
"type": "object",
"description": "SoundBank Info.",
"properties": {
"name": {
"type": "string",
"description": "The name of the SoundBank to generate, a temporary SoundBank will be created if the SoundBank doesn't exists."
},
"events": {
"type": "array",
"description": "List of events to include in this SoundBank. Not required if the bank already exists.",
"items": {
"anyOf": [
{
"type": "string",
"pattern": "^(StateGroup|SwitchGroup|SoundBank|GameParameter|Event|Effect|AudioDevice|Trigger|Attenuation|DialogueEvent|Bus|AuxBus|Conversion|ModulatorLfo|ModulatorEnvelope|ModulatorTime|Platform|Language|AcousticTexture|Global):[a-zA-Z0-9_]+$",
"description": "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"
},
{
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
{
"type": "string",
"pattern": "^\\\\",
"description": "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."
}
],
"description": "The ID (GUID), name, or path of the event to include in the SoundBank."
}
},
"auxBusses": {
"type": "array",
"description": "List of AuxBus to include in this SoundBank.",
"items": {
"anyOf": [
{
"type": "string",
"pattern": "^(StateGroup|SwitchGroup|SoundBank|GameParameter|Event|Effect|AudioDevice|Trigger|Attenuation|DialogueEvent|Bus|AuxBus|Conversion|ModulatorLfo|ModulatorEnvelope|ModulatorTime|Platform|Language|AcousticTexture|Global):[a-zA-Z0-9_]+$",
"description": "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"
},
{
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
{
"type": "string",
"pattern": "^\\\\",
"description": "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."
}
],
"description": "The ID (GUID), name, or path of the Auxiliary Bus to include in the SoundBank."
}
},
"inclusions": {
"type": "array",
"description": "List of inclusion type to use for this SoundBank. Not required if the bank already exists.",
"items": {
"type": "string",
"enum": [
"event",
"structure",
"media"
],
"maxItems": 3
}
},
"rebuild": {
"type": "boolean",
"description": "Force rebuild of this particuliar SoundBank. Default value: false"
}
},
"required": [
"name"
]
}
},
"platforms": {
"type": "array",
"description": "List of platforms to generate. If you don't specify any platforms, all the platforms will be generated",
"items": {
"type": "string",
"description": "The ID (GUID) or the name of the platforms"
}
},
"languages": {
"type": "array",
"description": "List of languages to generate. If you don't specify any languages, all the languages will be generated.",
"items": {
"type": "string",
"description": "The ID (GUID) or name of the language."
}
},
"skipLanguages": {
"type": "boolean",
"description": "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": {
"type": "boolean",
"description": "Will rebuild all SoundBanks if true. If you want to clear the converted media as well, use clearAudioFileCache parameter. Default value: false"
},
"clearAudioFileCache": {
"type": "boolean",
"description": "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": {
"type": "boolean",
"description": "Use the normal SoundBank generation process and write the sound bank and info file to disk. Default value: false"
},
"rebuildInitBank": {
"type": "boolean",
"description": "If you don't use rebuildSoundBanks, use this option to force a rebuild of the Init bank for each specified platform."
}
},
"additionalProperties": false
}

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