Version
Wwise has two primary ways to discover problems within your project:
You can quickly see messages, warnings, and errors that appear in your project from the Wwise toolbar's logs indicator. Hover over the indicator to get more details.
To fully view the listed log entries, click the indicator to open the Logs view. Its five tabs cover all the places you could encounter an issue with your Wwise project.
Each tab with log entries will have an icon corresponding to their highest severity level. Errors must be addressed because they impact the integrity of the operation and, for fatal errors, will even impact the completion of the operation. Warnings may impact the integrity of the operation, but not necessarily, so they should be evaluated. Messages should not be problematic, but they can provide invaluable information for understanding what's going on in your Wwise project. If there are no entries in a log, then the tab will have no severity icon.
Tip | |
---|---|
All the Logs view tabs' column headers can be clicked to organize the entries in a logical way. The Severity column, for example, can be ordered by highest severity level (fatal error, error, warning, general message) or lowest severity level (general message, warning, error, fatal error). |
You can check the status of your project by generating an integrity report that displays information about platform, audio file, SoundBank and plug-in issues. By examining this report, you can deal with project issues such as:
Missing media files
Missing sources, such as missing language versions
Plug-in problems
Missing objects in SoundBanks
Rendering and bypass effect issues for SoundBanks
Rendering and RTPCs for SoundBanks
In addition to displaying the project issues, the integrity report also provides information about the issue including the following:
Platform: The platform on which the issue occurs.
Type: The type of object that is affected.
Object name: The name of the object or element that is affected.
Status: The description of the issue.
Comments/Suggestions: Information and suggestions about how to deal with the issue.
Hierarchy: The location of the affected object in the hierarchy.
At any time during the development of your Wwise project, you can generate an integrity report. It is a good idea to generate the report prior to generating SoundBanks, or, if you are working with source control, before checking in major changes to a Work Unit.
To simplify looking for a specific type of issue, you can also filter the report by specifying the type of information that you want to generate. You can limit the report to display any or all of the following:
Audio files and sources
Hierarchies
References
Optimizations
After the report is generated, you can review each of the issues in the report and then double-click each one to carry out the suggested fix. For example, double-clicking a status message that states “No group assigned to the Switch Container” opens the Property Editor where you can assign a Switch or State Group to the Switch Container.
To generate an integrity report:
From the Wwise menu bar, click Views > Integrity Report.
The Integrity Report opens.
To define which platform issues to include in the Integrity Report, select one or more of your project's platforms, as defined in the Platform Manager, from the Platforms group.
To define which project language issues to include in the Integrity Report, in the Languages group, select the Languages option and choose the appropriate languages.
To filter for project issue types, select one or more of the following:
Audio files and sources
Hierarchies
Broken References
Optimizations
Click Generate.
A progress bar displays the status of the generation process.
When Wwise is finished generating the integrity report, click Close.
The Integrity Report- Completed dialog closes and the Integrity Report is displayed.
Note | |
---|---|
When you close the Integrity Report dialog, the information is not saved. Make sure to save the report if you plan to view the information at another time. For information about how to save an integrity report, refer to Saving an integrity report. |
Double-click the issue to open the corresponding dialog where you can fix or modify its issue status.
The following table lists the possible issues detected, and how you can correct these project issues.
Issue |
Information/Suggestion |
---|---|
Original audio file not found. |
Do one of the following:
|
Audio source is missing. |
Double-click the message to view the missing source in the Audio tab of the Project Explorer for SFX and in the Contents Editor for voice. |
Source Plug-in not supported on platform. |
Double-click the message to open the Contents Editor where you can select a source plug-in that is supported by the current platform. |
Source Plug-in not installed. |
Install the source plug-in. |
Missing language sources. |
Import the missing language source using the Audio File Importer. |
Selected codec does not support this source's channel configuration. |
Wwise will automatically downmix the source before conversion. Double-click the message and change the codec (audio format) or channels settings. |
Audio FX plug-in not supported on platform. |
Double-click the message to open the Property Editor where you can select an Effect plug-in that is supported by the current platform. |
Audio FX Plug-in not installed. |
Install the missing audio effects plug-in. |
Render effect has been applied to an “In use” source that is not an audio file. |
Render effects are not supported for source plug-ins. Double-click the message to do one of the following: In the Property Editor, remove the render effect option. In the Contents Editor, select an audio source that references an audio file to be “In Use”. |
The selected effect must be rendered. |
Double-click to open the Property Editor and do one of the following: Render the Effect. Change the Effect used. |
The effect could be rendered to save CPU, since no parameters will change in game. |
Double-click to open the Property Editor and select the Render check box. |
The effect on this object has been bypassed. The render effect will be ignored. |
Since both of these operations cannot be supported, verify the importance to your project of the render effect. If you want to apply the render effect option, remove the Bypass Effect. |
A bypass effect property has been assigned to the RTPC for this object. The render effect will be ignored. |
Since both of these operations cannot be supported, verify the importance to your project of the Render effect operation or the RTPC-driven bypass effect. If you want to apply the render effect option, remove the RTPC bypass effect on the object. |
An RTPC has been applied to the Effect for this object. The render effect will be ignored. |
Since both of these operations cannot be supported, verify the importance to your project of the RTPC that has been applied, or the render effect. If you want to apply the render effect, remove the RTPC. |
Seek table required for this virtual voice behavior. |
Double-click the message to open the Conversion Settings dialog and do one of the following:
|
Seek table not required for this virtual voice behavior. |
To reduce the memory usage, you can disable the seek table. Double-click the message to open the Conversion Settings dialog to disable the seek table in the Vorbis Encoder Parameters dialog. |
Seek table required for music objects in Vorbis format. |
Double-click the message to open the Conversion Settings dialog and do one of the following: Enable the seek table in the Vorbis Encoder Parameters dialog. Change the file format. |
Child object in this container is not assigned to a Switch. |
Double-click the message to open the Project Explorer and the associated Property Editor where you can do one of the following: Remove the unassigned object. Assign the object to a Switch. |
No group assigned to the Switch Container. |
Double-click to open the Property Editor and assign a Switch or State Group to the Switch Container. |
No objects assigned to a Switch in Switch Container. |
Double click to open the Contents Editor and assign an object to a Switch in the Switch Container. |
No group is assigned to the Music Switch Container. |
Double-click to open the Property Editor and assign a Switch or State Group to the Music Switch Container. |
No music objects assigned to a Switch in this container. |
Double-click to open the Music Switch Association Editor where you can assign music objects to the Switch. |
The playlist of the Sequence Container has no assigned objects. |
Double-click to open the Contents Editor where you can assign objects to the playlist. |
The playlist of the Music Playlist Container has no assigned objects. |
Double-click to open the Music Playlist Editor and assign music objects to the playlist. |
A blend track in the Blend Container has no assigned objects. |
Double-click to open the Blend Track Editor where you can do one of the following: Add objects to the blend track. Remove the blend track. |
A music track in the Music Segment contains no audio files. |
Double-click to open the Music Segment Editor where you can do one of the following: Add clips to the music track. Delete the music track. |
The SoundBank refers to objects that no longer exist. |
Delete the Events or objects from the SoundBank. |
No object assigned to Event Action. |
Double-click and open the Event Editor to do one of the following: Assign objects to these Actions. Remove the Event Action. |
No object assigned to path in Dialogue Event. |
Double-click to open the Dialogue Event Editor and do one of the following: Assign an object to the path. Remove the path. |
Some child objects in this sample accurate container are not using the same output properties as the parent container. |
The parent container may no longer be sample accurate. Double-click to open the Schematic View where you can remove any output overrides for the child objects of the sample accurate container. |
Some child objects in this sample accurate container are not using the same effect properties as the parent container. |
The parent container may no longer be sample accurate. Double-click to open the Schematic View where you can remove any effect overrides for the child objects of the sample accurate container. |
Some child objects in this sample accurate container are not using the same advanced settings properties as the parent container. |
The parent container may no longer be sample accurate. Double-click to open the Schematic View where you can remove any advanced settings overrides for the child objects of the sample accurate container. |
Some containers in this sample accurate container are not sample accurate. |
The parent container may no longer be sample accurate. Double-click to open the Project Explorer and change the non-sample accurate child containers of the sample accurate container to sample accurate. |
This sample accurate container has a child Switch Container. |
The parent container may no longer be sample accurate. Double-click to open the Project Explorer to remove the Switch Container. |
An audio source in this sample accurate container does not have the same number of channels as other audio sources in the container. |
The parent container may no longer be sample accurate. Verify that all audio sources for this container have the same number of channels. |
Some audio files are shorter than 0.05 seconds. These cannot be used for crossfade transitions. |
Double-click to open the Project Explorer to locate the sound object associated with the audio file whose duration is too short for a crossfade transition and do one of the following. Drag and drop another audio file with a longer duration onto the sound object. In the Property Editor for the parent object, select another transition type. |
Switch Containers with more than one object assigned to a Switch do not crossfade correctly. |
Double-click to open the Project Explorer and in the associated Property Editor ensure that only one object is assigned to a Switch for crossfade transitions. |
A container with a Trigger rate duration of less than 0.021 seconds may not play as expected. |
Double-click to open the Property Editor and in the associated Property Editor, change the Trigger rate duration to more than 0.021 seconds. |
This source only contains an LFE channel. | |
This source contains an LFE channel. |
It is a good idea to save the integrity report so that you can consult the report to resolve issues, or to keep a record of the issues in your project.
To save an integrity report:
In the Integrity Report, click Save Report.
The Save As dialog opens.
Browse to the folder where you want to save the report.
Replace the default report name with one that best represents this report, and click Save.
The Integrity Report is saved as a text file in the location that you have specified.
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageRegister your project and we'll help you get started with no strings attached!
Get started with Wwise