Version

menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2023.1.9.8628 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.

Managing loose media files in the output folder

A project's generated SoundBanks do not necessarily contain all media files required for your game. Media files not contained in the generated SoundBanks are:

  • Media files configured as streaming.

  • Media files explicitly excluded from a SoundBank.

For your game to have access to the media files not contained in the generated SoundBanks, the media files must be copied from the project's .cache folder and renamed using the assigned media IDs. There are two methods for copying said media files.

Copy media during SoundBank generation

Wwise can be configured to automatically copy the required media files by selecting the SoundBank Settings option Copy Loose/Streamed Media. Refer to SoundBanks Tab for more details.

The Wwise project has a configured output folder for each of its platforms. The default folder is <project-directory>/GeneratedSoundBanks/<platform-name>. Wwise creates a child folder called Media and copies the media files there.

[Note]Note

It is strongly recommended that this method is used to copy the loose/streamed media files. Wwise organizes the files correctly so that the runtime's default file I/O implementation can locate the files.

Manually copying loose/streamed media files

The missing media files can be copied and renamed manually. The lists of streamed and loose media files are contained in the metadata files created during SoundBank generation. Wwise can be configured to generate one metadata file for the entire project, and/or one metadata file per SoundBank. Refer to SoundBanks Tab for details on generating metadata files.

The metadata sections used to determine which media files are missing from the generated SoundBanks are:

  • StreamedMedia: The list of streamed media files. This section is available in both the all-SoundBank and per-SoundBank metadata files.

  • LooseMedia: The list of media files explicitly excluded from the generated SoundBanks. This section is available in both the all-SoundBank and per-SoundBank metadata files.

  • MediaInOtherBanks: The list of media files explicitly excluded from the associated SoundBank but contained in another. This section is only contained in the per-SoundBank metadata.

Each of the file list entries contains the path to the converted media file (in the project's .cache folder), and the media ID assigned to it. The copied file must be renamed with the same file extension and using the assigned ID, in decimal format, as the file name.

[Note]Note

Manual copying the loose/streamed media files might be more suitable for projects where the game will implement its own file I/O for the Wwise runtime.


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