1.2 Profiling the Game


1.2) Profiling the Game



To integrate sound into the Platformer Game, you need to first evaluate the kind of information that is being sent from the game to Wwise. The game for this learning course is a development build containing all necessary information for profiling.

Pic01 Capture Log

Pic02 Remote Connections

Pic03 Start Capture

Pic04 Disconnect

Pic05 Filters

Pic06 Events and Errors

Pic07 Profiling Session

  1. Launch the Platformer Game .exe and play it!

    You now need to return to Wwise. In fact, you’ll be switching back and forth between the game and Wwise quite often throughout this course, so you have to become familiar with using Alt+Tab on Windows, or Command+Tab on a Mac to switch between programs.

  2. Press Alt+Tab or Command+Tab to return to Wwise.

    There are a number of Views that work together to show you information related to reviewing information being received from the game by Wwise, but rather than opening them one at a time you can quickly open them in one step using a so called Layout. A Layout is a predefined collection of Views that are commonly used together.

  3. In the menu bar click Layouts, choose Profiler or press F6.

    The Profiler Layout is displayed. You can use the Views in this Layout to evaluate information about messages generated in the game and monitor details about sound engine performance. You’re going to use the Capture Log View (Pic01 Capture Log) in the upper left to display information that is being generated in game. To access this information, you need to connect Wwise to the game, that you should still have running in the background.

  4. In the toolbar, click Connect to Remote Platform.

    The Remote Connections window (Pic02 Remote Connections) opens displaying computers on the network (including your own local computer) that are running a version of the game that uses the Wwise Audio Engine and are designed to communicate with Wwise. If at any point throughout this course no computers are displayed in this list, then please deactivate your firewall or define an exception rule for Wwise to allow communication with the game client.

  5. Select your computer from the list and click Connect.

    The window closes and because the Start Capture checkbox (Pic03 Start Capture) was selected, you’ll see the capture button in the toolbar turn red, while a counter ticks next to it. Capturing is the process of recording, in real-time, a log of any information coming from the Wwise Audio Engine in your game related to the gameplay, an invaluable asset as you develop the sound for a game.

  6. Return to the Platformer Game, play it again and then return to Wwise to view the Capture Log.

    In the Capture Log View you can see a few lines, confirming that the game transmitted information to Wwise. When connected to a game, some Wwise Parameters cannot be adjusted. So, once you have the desired Capture Log information, you should disconnect from the game.

  7. Click Disconnect. (Pic04 Disconnect)

    The capture process stops and Wwise disconnects from the game. You can now evaluate what just happened. These message are referred to as Game Calls and there are a variety of different types of calls such as Events, Actions or Game Syncs that may be triggered. You will learn more about the different types of Game Calls later, but for now you can look at them more closely and try to find out some of the different types by yourself.

  8. Click Filters. (Pic05 Filters)

    The Capture Log Filter dialog box allows you to include or remove entries from the Capture Log based on a series of filter options, such as Item type, Wwise Object name, and Scope. Since the Capture Log displays quite a lot of information, you are only interested in seeing Events and Errors for now. The reason why the Event Filter is relevant is, because the built Platformer Game calls an Event for every sound it wants to play. So to find out which Events are called at any given moment, you need to set an Event Filter. The reason why the Error Filter is relevant is, because all Events are not connected to actual content at this point of the course. To get an overview about what’s missing, make sure to filter out everything else, except Events and Errors. (Pic06 Events and Errors)

  9. After inspecting the Capture Log, go to the project folder of the Wwise project. (Pic07 Profiling Session)

    At the bottom of the folder, you will see a new Profiling Session file. Every time a profiling is being done, a new file is being created. Since they can get quite big in file size, you can delete them regularly and exclude them in an Ignore file when you are using Source Control for your own projects.