Version

menu_open

Using the CopyStreamedFiles Tool

The CopyStreamedFiles tool is a stand-alone utility that copies the streamed media files in your project to the location where your SoundBanks are saved (by default, SoundBanks are saved in the platform-specific folder in the GeneratedSoundBanks directory). When this tool is called from the command line, it scans the SoundBanksInfo.xml file to find out which files are streamed and then copies them from your project cache folder to the appropriate folder in the SoundBank directory. By default, every project includes a post-generation step command line that calls the CopyStreamedFiles tool to complete this task, but you can modify this step or create new steps to meet the particular needs of your project.

The CopyStreamedFiles tool is located in the Wwise executable directory. When calling this tool from the command line, you need to define certain parameters, including the location of the SoundBanksInfo.xml file, and the location where the streamed files will be copied. The following table lists the parameters that can be used within the command line.

Parameter

Description

-info <file path>

Specifies the location of the SoundBanksInfo.xml file. This option is set to “$(InfoFilePath)” (with quotes) when used in Wwise as a post-generation step.

-outputpath <folder path>

Specifies the base folder where streamed files will be copied, which should be the base folder where SoundBanks are generated. Set to "$(SoundBankPath)" (with quotes) when used in Wwise as a post-generation step.

-languages “language1 languageN“

Specifies the list of languages to copy.

[Note] Note

The list is space-separated. Use double-quotes to enclose the list in one single argument. Use the keyword “SFX“ in the language list to copy them as well.

This argument is optional. By default all languages are copied.

-banks “soundbank1 soundbankN“

Specifies the list of SoundBanks for which to copy streamed files. The names do not include the bnk extension. Alternatively, a text file containing a list of SoundBank names can be specified, by passing in the full path to the text file, including the extension “.txt“.

[Note] Note

The list is space-separated. Use double-quotes to enclose the list in one single argument.

This argument is optional. By default all streamed files are copied.

-verbose

Enable extra console text output. This argument is optional.


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