Warning: you were redirected to the latest documentation corresponding to your major release ( 2023.1.7.8574 ). 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.
link
Wwise SDK 2023.1.7
ak.wwise.cli.generateSoundbank Options Schema
Schema
{
"properties": {
"verbose": {
"type": "boolean",
"description": "Enables extra console text output.",
"synopsis": [
"--verbose"
]
},
"quiet": {
"type": "boolean",
"description": "Disables all non-error console text output.",
"synopsis": [
"--quiet"
]
},
"no-wwise-dat": {
"type": "boolean",
"description": "Disables writing to hidden 'wwise.dat' files when converting audio files. This is useful when calling from a build tool that already handles file dependencies, as it allows multiple instances of Wwise to convert to the same directory simultaneously, without conflicting. Note that this option does not prevent the reading of existing hidden 'wwise.dat' files.",
"synopsis": [
"--no-wwise-dat"
]
},
"license": {
"type": "string",
"description": "Sets the license to be used. The license is not saved in the project.",
"synopsis": [
"--license LICENSE"
]
},
"save": {
"type": "boolean",
"description": "Saves the project before generating SoundBanks. If a tab-delimited-import-file was provided, the imported content is saved as well. Saving the project implicitly migrates first, if required.",
"synopsis": [
"--save"
]
},
"platform": {
"oneOf": [
{
"type": "string",
"description": "A single value provided for the option."
},
{
"type": "array",
"description": "Several values provided for the option.",
"items": {
"type": "string",
"description": "A value for the option."
}
}
],
"description": "Specifies the platforms for which SoundBanks are generated. This option must be followed by the platform identifiers.",
"synopsis": [
"--platform PLATFORM",
"--platform PLATFORM1 PLATFORM2 ...",
"--platform PLATFORM1 --platform PLATFORM2 ..."
]
},
"abort-on-load-issues": {
"type": "boolean",
"description": "Aborts the operation if a project load issue is detected. All logged project load issues are printed to screen.",
"synopsis": [
"--abort-on-load-issues"
]
},
"bank": {
"oneOf": [
{
"type": "string",
"description": "A single value provided for the option."
},
{
"type": "array",
"description": "Several values provided for the option.",
"items": {
"type": "string",
"description": "A value for the option."
}
}
],
"description": "Specifies which SoundBanks are generated. This option must be followed by the name of the SoundBank to be generated. Multiple SoundBanks can be specified. If no SoundBank is specified, all SoundBanks are generated. Alternatively, a text file containing a list of SoundBank names can be specified, by specifying the full path to the text file, including the extension '.txt'.",
"synopsis": [
"--bank SOUNDBANK",
"--bank SOUNDBANK1 SOUNDBANK2 ...",
"--bank FILE"
]
},
"cache": {
"type": "string",
"description": "Overrides the project's cache directory path and instead uses the (relative) path specified in the command.",
"synopsis": [
"--cache PATH"
]
},
"clear-audio-file-cache": {
"type": "boolean",
"description": "Deletes the content of the Wwise audio file cache directory 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 --platform option.",
"synopsis": [
"--clear-audio-file-cache"
]
},
"continue-on-error": {
"type": "boolean",
"description": "Use this option if you want to continue even if an error occurred.",
"synopsis": [
"--continue-on-error"
]
},
"custom-global-closing-cmd": {
"type": "string",
"description": "Overrides the global closing step that was defined in Wwise. This option must be followed by the new command line (use quotes if there are spaces). An empty string (\"\") specified for the command-line means no global closing step is executed.",
"synopsis": [
"--custom-global-closing-cmd CMD"
]
},
"custom-global-opening-cmd": {
"type": "string",
"description": "Overrides the global opening step that was defined in Wwise. This option must be followed by the new command line (use quotes if there are spaces). An empty string (\"\") specified for the command-line means no global opening step is executed.",
"synopsis": [
"--custom-global-opening-cmd CMD"
]
},
"custom-post-gen-cmd": {
"oneOf": [
{
"type": "array",
"description": "Association between a platform and a value.",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "string",
"description": "Platform name for index 0, value for index 1."
}
},
{
"type": "array",
"description": "Array of associations between a platform name and a value.",
"items": {
"type": "array",
"description": "Association between a platform name and a value.",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "string",
"description": "Platform name for index 0, value for index 1."
}
}
}
],
"description": "Overrides the custom post-generation step command line that was defined for this platform in Wwise. This option must be followed by the platform identifier (listed above), followed again by the new command line (use quotes if there are spaces). To override the custom post-generation step command line of another platform, repeat the option --custom-post-gen-cmd followed by the other platform's identifier and its new command line. An empty string (\"\") specified for the command-line means no post-generation step is executed.",
"description": "Association between a platform and a value.",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "string",
"description": "Platform name for index 0, value for index 1."
}
},
{
"type": "array",
"description": "Array of associations between a platform name and a value.",
"items": {
"type": "array",
"description": "Association between a platform name and a value.",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "string",
"description": "Platform name for index 0, value for index 1."
}
}
}
],
"description": "Overrides the custom pre-generation step command line that was defined for this platform in Wwise. This option must be followed by the platform identifier (listed above), followed again by the new command line (use quotes if there are spaces). To override the custom pre-generation step command line of another platform, repeat the option --custom-pre-gen-cmd followed by the other platform's identifier and its new command line. An empty string (\"\") specified for the command-line means no pre-generation step is executed.",
"description": "Generates the header file Wwise_IDs.h, even if this option is not specified in the project settings.",
"synopsis": [
"--header-file"
]
},
"header-file-path": {
"type": "string",
"description": "(DEPRECATED) Use root-output-path instead. Overrides the header file path specified in the project settings. This option must be followed by the path (absolute or relative) in which the header file (Wwise_IDs.h) will be written. This is only effective if the header file's creation is required.",
"synopsis": [
"--header-file-path"
]
},
"root-output-path": {
"type": "string",
"description": "Overrides the root output path specified in the SoundBank settings. This option must be followed by the path (absolute or relative) in which the project level, platform agnostic files will be written. Examples of such files are Wwise_IDs.h and ProjectInfo.(xml|json).",
"synopsis": [
"--root-output-path"
]
},
"readable-soundbanks": {
"type": "boolean",
"description": "Generates readable SoundBanks (.rbnk), even if this option is not specified in the project settings.",
"synopsis": [
"--readable-soundbanks"
]
},
"import-definition-file": {
"oneOf": [
{
"type": "string",
"description": "A single value provided for the option."
},
{
"type": "array",
"description": "Several values provided for the option.",
"items": {
"type": "string",
"description": "A value for the option."
}
}
],
"description": "Imports a SoundBank definition file. This option must be followed by the full path of the bank definition file to be imported. Multiple files can be specified. If the option --save is not specified, the changes made to the project as a result of the imported definition file do not persist.",
"description": "A single value provided for the option."
},
{
"type": "array",
"description": "Several values provided for the option.",
"items": {
"type": "string",
"description": "A value for the option."
}
}
],
"description": "Specifies the languages for which the SoundBanks are generated. This option must be followed by a language identifier defined in the project. Each specified language must be prefixed with this option.",
"synopsis": [
"--language LANGUAGE",
"--language LANGUAGE1 --language LANGUAGE2 ..."
]
},
"skip-languages": {
"type": "boolean",
"description": "Will not generate any localized SoundBank in the project.",
"synopsis": [
"--skip-languages"
]
},
"use-stable-guid": {
"type": "boolean",
"description": "Give the SoundBank a stable GUID across multiple builds if you don't want to save the project.",
"synopsis": [
"--use-stable-guid"
]
},
"no-decode": {
"type": "boolean",
"description": "Avoids generating DECODED files in the .cache directory, which saves CPU and disk space for your Wwise project. It also reduces the SoundBank generation time. Warning: If you do not generate the DECODED files, playing back these sounds in Wwise Authoring could result in an outdated playback or no playback at all. Clearing the file cache is recommended after using this option.",
"synopsis": [
"--no-decode"
]
},
"no-source-control": {
"type": "boolean",
"description": "Skip the Source Control operations, even it is was enabled in the SoundBank Project Settings.",
"synopsis": [
"--no-source-control"
]
},
"use-user-overrides": {
"type": "boolean",
"description": "Use user overrides for Project Settings and SoundBank Settings.",
"synopsis": [
"--use-user-overrides"
]
},
"soundbank-path": {
"oneOf": [
{
"type": "array",
"description": "Association between a platform and a value.",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "string",
"description": "Platform name for index 0, value for index 1."
}
},
{
"type": "array",
"description": "Array of associations between a platform name and a value.",
"items": {
"type": "array",
"description": "Association between a platform name and a value.",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "string",
"description": "Platform name for index 0, value for index 1."
}
}
}
],
"description": "Overrides the SoundBank path specified for this platform. This option must be followed by the platform identifier (listed above), followed again by the new path (absolute or relative, use quotes if there are spaces). To override the path of another platform, repeat the option --soundbank-path followed by the other platform's specifier and its new path.",
"description": "It is possible that a project already contains some audio source files of the same name as the imported ones when doing a tab delimited import. By adding this option, the operation uses those instead of replacing them with those described by the tab-delimited file.",
"synopsis": [
"--audio-source-from-original"
]
},
"import-language": {
"type": "string",
"description": "With the tab-delimited import operation it is possible to import voices. This option is used to specify the language of the imported voices. This option must be followed by one of the language identifiers listed with the --language option. Note that only audio files are added for this operation; any attempt to concurrently perform other operations, such as volume adjustments, is ignored.",
"synopsis": [
"--import-language LANGUAGE"
]
},
"tab-delimited-operation": {
"type": "string",
"enum": [
"createNew",
"useExisting",
"replaceExisting"
],
"description": "Determines how import object creation is performed for each object created. \"createNew\": creates a new object; the object is given the desired name if possible, otherwise a new unique name is used. \"useExisting\": uses the object if it exists, updating the specified properties; otherwise it creates a new object. This is the default value. \"replaceExisting\": creates a new object; if an existing object has the same name then the existing object is destroyed.",
"synopsis": [
"--tab-delimited-operation createNew",
"--tab-delimited-operation useExisting",
"--tab-delimited-operation replaceExisting"
]
},
"tab-delimited-import-file": {
"oneOf": [
{
"type": "string",
"description": "A single value provided for the option."
},
{
"type": "array",
"description": "Several values provided for the option.",
"items": {
"type": "string",
"description": "A value for the option."
}
}
],
"description": "The tab delimited file to import. Multiple files to import can be specified after this option.",
"description": "A single value provided for the option."
},
{
"type": "array",
"description": "Several values provided for the option.",
"items": {
"type": "string",
"description": "A value for the option."
}
}
],
"description": "Specifies the WSOURCES files to use for external source conversion. Those WSOURCES files are used for all platforms.",
"synopsis": [
"--source-file FILE",
"--source-file FILE1 FILE2 ..."
]
},
"source-by-platform": {
"oneOf": [
{
"type": "array",
"description": "Association between a platform and a value.",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "string",
"description": "Platform name for index 0, value for index 1."
}
},
{
"type": "array",
"description": "Array of associations between a platform name and a value.",
"items": {
"type": "array",
"description": "Association between a platform name and a value.",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "string",
"description": "Platform name for index 0, value for index 1."
}
}
}
],
"description": "Specifies the WSOURCES files to use by platform for external source conversion. When specified for a specific platform, it overrides the WSOURCES files from the project settings for this platform. For platforms for which this is not specified, the project settings are used. Specify the platform first, then the WSOURCES files to use for this platform. Repeat the operation for each platform and WSOURCES file.",
"description": "Association between a platform and a value.",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "string",
"description": "Platform name for index 0, value for index 1."
}
},
{
"type": "array",
"description": "Array of associations between a platform name and a value.",
"items": {
"type": "array",
"description": "Association between a platform name and a value.",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "string",
"description": "Platform name for index 0, value for index 1."
}
}
}
]
},
{
"type": "string"
}
],
"description": "Allows you to follow this option with a platform and an output path to override the output path of this platform for external source conversion. Repeat this option for other platforms. If only a directory is specified, sources for all platforms are generated in that directory.",