Version
menu_open

Capture Log

The Capture Log captures and records all information coming from the sound engine. This can include specific activities, such as Events triggered by the game or triggered manually in the Soundcaster or Game Simulator while prototyping. Each piece of information captured is recorded as a separate entry in the Capture Log. You can double-click an entry in the Capture Log to load the related Wwise object or Event in the Property Editor or Event Editor. You can also press Ctrl+\ on an entry to move the time cursor in the Performance Monitor and synchronize all other views to the same time.

You can filter the list using a number of different filter criteria, such as game object type, Wwise object name, or a specific type of activity performed by the sound engine. You can also save the list as a PROF file to reload it in Wwise later. Alternatively, choose a text file format and then import it into Microsoft Excel for sorting and further analysis.

Filtering Toolbar

This view includes the filtering toolbar, which allows you to reduce the amount of information displayed in the view so you can focus on specific elements. Refer to Filtering in the Profiling Views for further details.

Unlink Filter: Allows you to disable synchronization between multiple filter views.

Text Filter: Allows you to filter content by specifying the text. The specified words are matched with the beginning of names or strings found in content. Each additional word refines the results. This match is not case sensitive. For advanced usage, refer to Using Profiler Filter Expressions.

Object Filter: Allows you to filter content by specifying the Wwise object. The specified Wwise objects, from the project, are used to match content from the view. Additionally, object relations, such as parent-children relations and output bus relations, are also used to match content.

Browse Object Filter: Shows a project explorer browser to select an object to filter.

Mute/Solo Filtering: When enabled, the objects with Mute activated are removed from the results, and the objects with Solo activated are exclusively displayed.

Options: Displays additional actions.

Interface Element

Description

Opens the Capture Log Filter dialog box where you can define the criteria by which the Capture Log output will be filtered.

Saves the Capture Log contents either as a PROF file or as a tab delimited text file. The text file will include any filtering or sorting that has been applied to the list.

Opens a search field where standard alphanumeric entries filter out unmatching elements from the view. Learn more in Using Tables.

Click the Close icon to the left of the search icon to close the search field and remove the filter.

[Note] Note

The searches do not include elements in collapsed nodes of the List View, Query Editor, MIDI Keymap Editor, and Reference View.

(Indicators)

The varying shades of dots, whose colors are set by the theme wherein Classic is turquoise and Dark is orange, indicate which items in the Capture Log were captured within 100 ms of the Performance Monitor time cursor position. The brighter the indicator, the closer the entry is to the time cursor's position. You can force the cursor to the timestamp of a specific log entry by selecting Move Cursor to Timestamp from the shortcut menu (Ctrl+\). Alternatively, just double-click the timestamp.

The connected dots, whose colors are set by the theme wherein Classic is dark gray and Dark is white, indicate which items in the Capture Log are related to each other. They only appear when you select a single entry in the log.

Timestamp

The game time at which the item was captured. The timestamp helps to identify what has happened at a precise time during your simulation in Wwise or in game.

Type

The type of item logged in the Capture Log. See the Capture Log Filter page for a short list and explanation of the different Types available.

Description

Descriptive information about the logged item. The description can also include information about changes to property values, changes to States, and so on.

Wwise Object Name

The name of the Wwise object that is related to the logged item, if any.

If multiple Wwise objects are associated with the logged item, "Multiple Objects" will be displayed. If no Wwise objects are associated with the logged item, "No Element" will be displayed.

Wwise Object ID

The ID of the Wwise object that is related to the logged item, if any.

If multiple Wwise objects are associated with the logged item, "Multiple Objects" will be displayed. If no Wwise objects are associated with the logged item, "No Element" will be displayed.

[Note] Note

When using the search field in the Capture Log, IDs only match if they are complete and exact.

Game Object Name

The name of the game object that is associated with the logged item.

"Transport/Soundcaster" can relate to entries triggered by Wwise objects that are not associated with a particular game object.

Game Object ID

The ID of the game object that is associated with the logged item.

"Transport/Soundcaster" can relate to entries triggered by Wwise objects that are not associated with a particular game object.

[Note] Note

When using the search field in the Capture Log, IDs only match if they are complete and exact.

Scope

The extent to which the logged item applies to objects within the game. The scope can be one of two types:

  • Global, which means that the logged item applies to all game objects.

  • Game object, which means that the logged item only applies to the game object specified in the Game Object column.

Related Topics

[Tip] Tip

Press Ctrl+\ or double-click a time stamp to set the Game Profiler cursor to the time of the entry.


Related Topics

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