|
Wwise SDK 2024.1.0
|
SoundBank generation. SoundBank generation is performed according to the settings stored in the project. User SoundBanks Settings are normally ignored when SoundBank generation is launched from the command line. However, when using the Source Control for generated SoundBanks, the User Project Settings are loaded for the Source Control settings. Also, some of these settings can be overridden from the command line.
WwiseConsole generate-soundbank "C:\MyProject\MyProject.wproj" --platform "Windows" "Linux" --language "English(US)"
Generates all the SoundBanks for MyProject.wproj, for the Windows and Linux platforms, using the English(US) language.
PROJECT
The path to the project file (.wproj).
--abort-on-load-issues
Aborts the operation if a project load issue is detected. All logged project load issues are printed to screen.
--audio-source-from-original
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.
--bank SOUNDBANK
--bank SOUNDBANK1 SOUNDBANK2 ...
--bank FILE
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'.
--cache PATH
Overrides the project's cache directory path and instead uses the (relative) path specified in the command.
--clear-audio-file-cache
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.
--continue-on-error
Use this option if you want to continue even if an error occurred.
--custom-global-closing-cmd CMD
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.
--custom-global-opening-cmd CMD
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.
--custom-post-gen-cmd PLATFORM CMD
--custom-post-gen-cmd PLATFORM1 CMD1 --custom-post-gen-cmd PLATFORM2 CMD2 ...
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.
--custom-pre-gen-cmd PLATFORM CMD
--custom-pre-gen-cmd PLATFORM1 CMD1 --custom-pre-gen-cmd PLATFORM2 CMD2 ...
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.
--header-file
Generates the header file Wwise_IDs.h, even if this option is not specified in the project settings.
--header-file-path
(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.
--import-definition-file FILE
--import-definition-file FILE1 FILE2 ...
--import-definition-file FILE1 --import-definition-file FILE2 ...
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.
--import-language LANGUAGE
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.
--language LANGUAGE
--language LANGUAGE1 --language LANGUAGE2 ...
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.
--license LICENSE
Sets the license to be used. The license is not saved in the project.
--no-decode
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.
--no-source-control
Skip the Source Control operations, even it is was enabled in the SoundBank Project Settings.
--output PLATFORM PATH
--output PLATFORM1 PATH1 --output PLATFORM2 PATH2 ...
--output PATH
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.
--platform PLATFORM
--platform PLATFORM1 PLATFORM2 ...
--platform PLATFORM1 --platform PLATFORM2 ...
Specifies the platforms for which SoundBanks are generated. This option must be followed by the platform identifiers.
--quiet
Disables all non-error console text output.
--readable-soundbanks
Generates readable SoundBanks (.rbnk), even if this option is not specified in the project settings.
--root-output-path
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).
--save
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.
--skip-languages
Will not generate any localized SoundBank in the project.
--soundbank-path PLATFORM PATH
--soundbank-path PLATFORM1 PATH1 --soundbank-path PLATFORM2 PATH2 ...
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.
--source-by-platform PLATFORM FILE
--source-by-platform PLATFORM1 FILE1 --source-by-platform PLATFORM2 FILE2 ...
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.
--source-file FILE
--source-file FILE1 FILE2 ...
Specifies the WSOURCES files to use for external source conversion. Those WSOURCES files are used for all platforms.
--tab-delimited-import-file FILE
--tab-delimited-import-file FILE1 FILE2 ...
--tab-delimited-import-file FILE1 --tab-delimited-import-file FILE2 ...
The tab delimited file to import. Multiple files to import can be specified after this option.
--tab-delimited-operation createNew
--tab-delimited-operation useExisting
--tab-delimited-operation replaceExisting
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.
Possible values:
--use-stable-guid
Give the SoundBank a stable GUID across multiple builds if you don't want to save the project.
--use-user-overrides
Use user overrides for Project Settings and SoundBank Settings.
--verbose
Enables extra console text output.
The process exit code of SoundBank generation. Although your SoundBanks might generate properly with warnings, it is strongly recommended that you consider these warnings as errors. For example, WwiseConsole.exe returns an error code when a source file is missing. Although a missing source file does not prevent your SoundBanks from being generated, the resulting SoundBanks might potentially be incomplete. You can change the severity of most messages encountered during the SoundBank Generation by going to Project Settings > Logs, in Wwise. Changing the severity of the messages impacts the return codes.
A WwiseConsole.exe exit code of 0 means success, 1 means at least one error (and potentially warnings) occurred, and 2 means that only warnings occurred.
Refer to Using the Command Line for more information about Wwise Console.
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageRegister your project and we'll help you get started with no strings attached!
Get started with Wwise