Table of Contents

Monitoring and Troubleshooting with the Performance Monitor

Since Wwise is so tightly integrated with the sound engine, you can monitor a wide range of key performance indicators in real time as the game is being played. The game profiler also works with the Soundcaster, Game Simulator, and other SoundFrame applications so that you can monitor the performance of your ideas or prototypes even before they have been integrated into the game.

As Wwise captures information related to the activities of the sound engine, performance graphs are created in real time in the Performance Monitor. The actual numbers and percentages related to the graphs are also displayed in the Performance Data list, which is located to the right of the graph view.

The different graphs will help you quickly locate areas in your game where the audio is surpassing certain constraints, such as platform limitations. Using a combination of the Performance Monitor, Advanced Profiler, and Capture Log, you can troubleshoot any issues that may arise.

The Performance Monitor is customizable, which means that you can decide which performance indicators or counters are displayed in the Performance Monitor. For more information on customizing the Performance Monitor, refer to Customizing the Performance Monitor.

[Tip] Tip

You can monitor the performance as the data is being captured, or you can perform a capture session and then scroll through the graph to investigate the issues afterwards. If you plan to monitor the performance while the data is being captured, you must select the Follow Capture Time option to keep the Capture Log and Performance Monitor in sync with the capture time.

To monitor performance:

  1. Connect to a remote console, PC, SoundFrame application, or running version of the Game Simulator.

    [Note] Note

    If you are profiling a certain model or prototype using the Soundcaster, the information is captured as you play back the different modules.

  2. Do one of the following:

    • From the menu bar, click Layouts > Profiler.

    • Press F6

    The Profiler layout is displayed.

  3. On the toolbar, click the Start Capture button.

    Wwise begins to graph the performance of the particular platform in relation to the information captured from the sound engine.

    [Note] Note

    Solid blocks indicate places where the captured information exceeds a minimum or maximum value. Blocks at the top of a graph indicate values higher than the maximum, and blocks at the bottom indicate values lower than the minimum.

  4. Drag the Performance Monitor time cursor (white) to a location on the graph where there is a performance issue.

    [Note] Note

    As you scroll through the graph view, the position of the Capture Log and the information in the Performance Data pane and the Advanced Profiler are automatically updated.

  5. Use the time cursor indicators (white circles) in the Capture Log to locate the Event, Action, or other activities performed by the sound engine that are creating the issue. Alternatively, shift-click an entry in the Capture Log to synchronize all the profiling views on this timestamp.

  6. To edit the contents and/or properties of an object or Event, double-click the entry in the Capture Log. The corresponding Event or object will open in the Event Editor or Property Editor where you can make any necessary modifications.

  7. Review the information in the various tabs of the Advanced Profiler to get more information about the performance of the particular activity.

  8. To save a text file version of the Performance Monitor graph, right-click the graph and select Save All Counters to File. This will allow you to save the counters to a tab delimited text file that includes all counters from the beginning of the capture to the current moment, recorded at 200 ms intervals.