Wwise Help

To define SoundBank project settings:

1. Open the Project Settings dialog by doing one of the following:

   • From the Project menu, select Project Settings.

   • Press Shift+K.

2. Switch to the SoundBanks tab.

3. In the SoundBank Settings group, select any of the following options to define custom settings for your SoundBanks:

   • Allow SoundBanks to exceed maximum size to generate SoundBanks even if they exceed the maximum size specified.

   • Generate SoundBank content files to create files that list the contents of each SoundBank. The content files include information on Events, Busses, States, and Switches, as well as a complete list of streamed and in memory audio files.

   • Generate header file to create a header file that maps Event, State, Switch, and Game Parameter names to IDs.

   • Max attenuation to include maximum attenuation information in the SoundbanksInfo.xml file for each Event.

   • Estimated duration to include the estimated maximum and minimum duration for each Event, as well as whether a sound loops infinitely or is a one-shot sound, in the SoundbanksInfo.xml file for each Event.

   • Use SoundBank Names to use SoundBank names (checked) or IDs (unchecked) to name generated SoundBank files (BNK) and to reference one bank within another bank. For more information, refer to SoundBanks Tab.

4. If you chose to generate a header file, you must decide where it will be saved. To do so, do one of the following:

   • Click the text box and directly type a path into it.

   • Double-click the text box or click the browse button […] to prompt a browser to navigate to the location of your choice.

   	Note
   	You can use a full path or a relative path to specify the location where the header file will be saved. When using a relative path, use the project folder as the origin of the path.

5. If you chose to generate SoundBank content files, you can select the desired text file format with the SoundBank content file format option.

   	Tip
   	If you have file paths, object names or object notes that contain non-ANSI characters, you should use the Unicode format.

6. Click OK to apply the settings.

To specify a new location for your saved SoundBank:

1. Open the Project Settings dialog by doing one of the following:

   • From the Project menu, select Project Settings.

   • Press Shift+K.

2. Switch to the SoundBanks tab.

3. In the SoundBank Paths group, specify a path by doing one of the following:

   • Type a path directly in the text box.

   • Click Browse and use the browser to navigate to the location of your choice.

4. Click OK to apply any changes you made.

To define tasks to be performed before SoundBank generation:

1. Open the Project Settings dialog by doing one of the following:

   • From the Project menu, select Project Settings.

   • Press Shift+K.

2. Switch to the SoundBanks tab.

3. To create a global Pre-Generation Step, click the browse button […] to open the Global Opening Step Editor.

   The Pre-Generation Step Editor opens.

4. In the Description text box, type a name that clearly describes the step or task that will be performed.

5. Click in the Commands text box to begin creating your command line.

   	Note
   	The Commands text box works like most other text editors, which means you can add new lines of text by pressing Enter, delete text by selecting it and pressing Delete, and so on.

6. If you want to insert built-in macros and environment variables in your command, do the following:

   In the Macros group, select one of the following options:

   • Built-in Macros - To display a list of ­Wwise-specific variables that can be used within the Wwise command lines.

   • Environment Variables - To display a list of Windows-specific environment variables that can be used within the Wwise command lines.

   To add a variable to the command line, do one of the following:

   • Double-click a variable in list.

   • Select a variable from the list and then click Insert.

   Continue to add variables to your command line, as required.

7. If you need to perform a second global pre-generation step, simply go to the end of the first line, press Enter, and then start creating a new command line.

8. Click OK to save the command line and to close the Pre-Generation Step Editor.

   	Note
   	If you want to save the command line to file, click the Save As button in the editor. For more information on saving custom command lines, refer to Saving custom command lines to a file.

9. To create a platform-specific pre-generation step, repeat steps 3-8 for each platform.

   	Note
   	You can load factory and previously saved custom command lines into the editor by clicking the Load button. For more information on loading factory/custom commands, refer to Loading factory/custom command lines.

To define tasks to be performed after SoundBank generation:

1. Open the Project Settings dialog by doing one of the following:

   • From the Project menu, select Project Settings.

   • Press Shift+K.

2. Switch to the SoundBanks tab.

3. In the Post-Generation Step group, you will notice that the Copy Streamed Files command line is added by default. To modify this command line or to add an additional one, click one of the browse buttons [...].

   The Post-Generation Step Editor opens.

4. In the Description text box, type a name that clearly describes the step(s) or task(s) that will be performed.

5. In the Commands text box, click at the end of the current command line and press Enter. You can now begin to create a new command line.

   	Note
   	The Commands text box works like most other text editors, which means you can add new lines of text by pressing Enter, delete text by selecting it and pressing Delete, and so on.

6. If you want to insert built-in macros and environment variables in your command, do the following:

   In the Macros group, select one of the following options:

   • Built-in Macros - To display a list of ­Wwise-specific variables that can be used within the Wwise command lines.

   • Environment Variables - To display a list of Windows-specific environment variables that can be used within the Wwise command lines.

   To add a variable to the command line, do one of the following:

   • Double-click a variable in list.

   • Select a variable from the list and then click Insert.

   Continue to add variables to your command line, as required.

7. If you need to perform an additional pre-generation step, simply go to the end of the first line, press Enter, and then start creating a new command line.

8. Click OK to save the command line and to close the Post-Generation Step Editor.

   	Note
   	If you want to save the command line to file, click the Save As button in the editor. For more information on saving custom command lines, refer to Saving custom command lines to a file.

9. Repeat steps 3-8 for the global closing step and/or for each additional platform.

   	Note
   	You can load factory and previously saved custom command lines into the editor by clicking the Load button. For more information on loading factory/custom commands, refer to Loading factory/custom command lines.

To load a factory/custom command line:

1. From the Pre/Post Generation Step Editor, click Load.

2. From the shortcut menu, click one of the following:

   • From Factory Folder - To open the Explorer/Finder to the directory where the Wwise factory command lines are located.

   • From Last Location - To open the Explorer/Finder to the directory from which you last loaded a command line.

   The Open dialog opens.

3. Select the command line you want to load and click Open.

   The command line is loaded into the editor.

To save a command line to file:

1. In the Pre-Post Generation Step Editor, write your command line(s).

2. When you are finished, click Save As.

   The Save As dialog opens.

3. Navigate to the folder where you want to save your command line, name it, and then press Save.

   The command line is saved as a WCMDLINE file and can now be re-used at any time.