Table of Contents

File Packager Window

In the File Packager window, you can assign the SoundBanks, loose media, and/or streamed media files for a Wwise project to one or more packages. Depending on the requirements of your game, you can create package files that include any combination of these.

All information about a Wwise project's SoundBanks and streamed media files can be retrieved by importing the SoundbanksInfo.xml file into the File Packager. By default, all files are added to the default.pck package file, which is created in the root of the SoundBank path directory for each platform. You can, however, create new packages, manually add files to different packages, and modify the location where the packages will be saved.

[Note] Generating the SoundbanksInfo.xml File

Within the Project Settings' or the SoundBanks Settings' SoundBanks tab, the Generate Metadata Files option should always be enabled. Additionally, you must enable the Generate XML Metadata option. With these set, Wwise generates the SoundbanksInfo.xml file whenever you successfully generate SoundBanks.

The File Packager window also contains file routing tools, which allow you to automatically assign SoundBanks and streamed media files to particular packages based on language and file type.

Each session created within the File Packager can also be saved as a project so that you can easily save your work mid-session and come back to it at any time.

For the command line options, refer to Using File Packager Arguments in the Command Line.

Menu

Description

Tools > Create and assign packages for all languages

Create one new package per language. For each package created, assign the streamed files, loose media, and SoundBanks to that package for the language. If a package already exists for this language, no package is created, and the existing package is not modified.

Tools > Freeze selected packages

Take the selected packages and ensure all content becomes explicit (directly in the manually added files) and that no implicit content remains. The process will ensure no assignation rule references the selected packages. The resulting content for those packages will not change.

This function can be used after a game release for which you are ready to prepare the downloadable content. It will ensure that dynamically created packages that were shipped are frozen.

Interface Element

Description

SoundBanks Info file

The path of the SoundbanksInfo.xml file that provides the list of SoundBanks, loose media, and streamed files within a Wwise project.

The contents of the SoundbanksInfo.xml file are displayed in the Files to package view.

This path can be absolute or relative. Relative paths are relative to the File Packager project file directory.

Opens the Windows Open File dialog box where you can select the SoundbanksInfo.xml file that creates a list of all SoundBanks and streamed media files that can be packaged.

Output directory

The location on the network where the packages will be saved.

This path can be absolute or relative. Relative paths are relative to the SoundbanksInfo.xml file directory. By default, the File Packager uses the SoundbanksInfo.xml file directory.

Opens the Browse for Folder dialog box where you can navigate to the location where you want the package files to be saved.

Files to package

Filename

The name of the SoundBank, streamed file, or loose media that can be added to one or more packages.

File type

The type of file: SoundBank, streamed file, or loose media.

Language/SFX

The language to which the file is associated. If the file is not associated with any language, it is considered an SFX.

File size

The size of the file.

Packages

The package(s) in which the file has been included.

 

Adds the selected files to the package selected in the Package Manager.

Packages

Name

The name of the package.

The name is a relative path to the output directory and can contain sub folders, for example, 'my_folder\package1.pck'.

Added

The number of files manually added to the package.

Resulting

The total number of files included in the package.

Missing

The number of files missing in the package.

Files can become missing if they are manually added to a package and then later removed from the original Wwise project.

Data size

The sum of all files listed in the resulting contents for the package.

Header size

The approximate header size for the package. It represents the approximate memory usage to load the package in the Sound Engine.

 

Creates a new package.

Deletes the currently selected package.

Opens the File Order Editor where you can arrange the files within the package in a particular order.

Ordering the files within your package may optimize your disk seeking times.

Block Size

The number of bytes upon which the data within your packages is aligned. The number you specify will depend on the requirements of the platform's I/O device. For more information about block size and the constraints of each platform's I/O device, refer to the Streaming > Low-Level I/O section of the SDK documentation.

The typical value for each platform is 1.

The default value of 1 means that there is no alignment.

Default file assignments

Assign Language/SFX files to:

The options within this section allow you to assign the SoundBanks, loose media, and streamed files associated with a specific language or SFX to a particular package.

Default assignments are only used if files are not manually assigned to a package.

Language

The list of languages/SFX for which SoundBanks and streamed files exist.

SoundBanks

The package to which the SoundBanks associated with the corresponding language/SFX are automatically assigned.

Default assignments are only used if files are not manually assigned to a package.

Streams

The package to which the streamed files associated with the corresponding language/SFX are automatically assigned.

Default assignments are only used if files are not manually assigned to a package.

LooseMedia

The package to which files that have no specific association with the corresponding language/SFX are automatically assigned.

Default assignments are only used if files are not manually assigned to a package.

 

Assign remaining files to:

The options within this section allow you to route all remaining SoundBanks, streamed files, external sources, and loose media to a particular package.

SoundBanks

The package to which any remaining SoundBanks are automatically assigned.

Streamed files

The package to which any remaining streamed files are automatically assigned.

External sources

The package to which any remaining external sources are automatically assigned.

Loose media

The package to which any other remaining files are automatically assigned.

Package contents

Manually added files

The SoundBanks, streamed file, external sources, or loose media that have been manually added to the package.

Filename

The name of the SoundBank, streamed file, loose media, or external source.

File type

The type of file: SoundBank, streamed file, external source, or loose files.

Language/SFX

The language to which the file is associated. If the file is not associated with any language, it is considered an SFX.

File size

The size of the file.

Inclusion Mode (available only in the Manually added files tab)

Determines whether the SoundBank, its associated streamed files, and/or all the loose media are included in the package. You can select one of the following options:

  • SoundBank only

  • Streamed files

  • SoundBank and streamed files

  • Loose media

  • SoundBank and loose media

  • Streamed files and loose media

  • All files

Removes the selected file from the package.

 

Resulting contents

The complete list of SoundBanks, streamed media files, and/or loose media that are included in the package.

The number displayed on the title bar of this tab represents the total number of files included in the package.

The number on this tab may differ from the one on the Manually added files tab because when SoundBanks are manually added they can include references to several streamed media files that are automatically added to the same package.

Filename

The name of the SoundBank, loose media, or streamed file that has been added to the package.

File type

The type of file: SoundBank, streamed file, loose media, or a mix.

Language/SFX

The language to which the corresponding file is associated. If the file is not associated with any language, it is considered an SFX.

File size

The size of the file.

Copies the information in the Resulting Contents pane to the Windows clipboard so that you can paste it into a new file.