Table des matières

Wwise SDK 2019.2.2
Using the Command Line
Note
This new system called Wwise Console has replaced the legacy Wwise CLI, which still works, but is now deprecated. See Using the legacy Command Line (deprecated).

A number of Wwise operations are available from its command-line interface, including SoundBank generation. This can prove useful when integrating Wwise as part of an automated process, such as a daily game build with audio assets.

Wwise Command Line

There are two distinct ways to call WwiseConsole.exe, the Wwise command line executable, depending on whether you run it on Windows or Mac.

On Windows
For Windows, WwiseConsole.exe is called directly under "%WWISEROOT%\Authoring\x64\Release\bin". Command-line parameters should follow this basic structure, where operation and arguments are mandatory:
WwiseConsole.exe operation [arguments] [--option1 [parameters]] [--option2 [parameters]] ...
On Mac
For Mac, WwiseConsole.exe is called indirectly via the WwiseConsole.sh shell script. To be able to successfully run the WwiseConsole.sh shell script on a Mac, each user who wants to run the WwiseConsole.sh shell script must:
  1. Launch Wwise.app and install the MS VC++ redistributable.
  2. Quit Wwise.app.
It is then possible to invoke the WwiseConsole.sh shell script from the Terminal passing the same command line arguments as its Windows counterpart using either Unix or Windows style paths.
MAC:~ username$ /Path/to/Authoring/Wwise.app/Contents/Tools/WwiseConsole.sh operation [arguments] [--option1 [parameters]] [--option2 [parameters]]

Any string parameter containing spaces should be wrapped in quotation marks. All path parameters must be specified using only backslashes, with no trailing backslashes.

Operations

Please refer to the Wwise Console Reference.

Example

An example of SoundBank generation from the command line is shown below. It generates the English (US) language SoundBanks for the Windows and Linux platforms.

"%WWISEROOT%\Authoring\x64\Release\bin\WwiseConsole.exe" generate-soundbank "C:\MyProject\MyProject.wproj" --platform "Windows" "Linux" --language "English(US)"

For more examples, please refer to the Wwise Console Examples Index.