Version

menu_open
Wwise SDK 2022.1.12
convert-external-source

External Sources conversion. Converts the external sources files for the specified project. Optionally, additional WSOURCES can be specified. External Sources are a special type of source that you can put in a Sound object in Wwise. It indicates that the real sound data will be provided at run time. While External Source conversion is also triggered by SoundBank generation, this operation can be used to process sources not contained in the Wwise Project. Please refer to Integrating External Sources.

Examples

WwiseConsole convert-external-source "C:\MyProject\MyProject.wproj"

Converts external sources of MyProject.wproj for all platforms using the current project settings.

Arguments

PROJECT

The path to the project file (.wproj).

Arguments Schema

Options

--no-wwise-dat

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.

--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. Repeat this option for other platforms. If only a folder is specified, sources for all platforms is generated in that folder.

--platform PLATFORM
--platform PLATFORM1 PLATFORM2 ...
--platform PLATFORM1 --platform PLATFORM2 ...

Specifies for which platform(s) the source(s) are converted using the project settings. This option must be followed by the platform identifiers.

--quiet

Disables all non-error console text output.

--source-by-platform PLATFORM FILE
--source-by-platform PLATFORM1 FILE1 --source-by-platform PLATFORM2 FILE2 ...

Specifies the WSOURCES file(s) to use by platform. 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 file(s) to use for this platform. Repeat the operation for each platform and WSOURCES file.

--source-file FILE
--source-file FILE1 FILE2 ...

Specifies the WSOURCES file(s) to use. Those WSOURCES files are used for all platforms.

--verbose

Enables extra console text output.

Options Schema

Result

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.

Result Schema

Refer to Using the Command Line for more information about Wwise Console.


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