Version

menu_open

Profiler Settings

The Profiler Settings dialog box allows you to specify which types of information will be captured by the Game Profiler during the capture process. If you select too many types of information, Wwise's performance may be affected. By clearing some of the options, you can do the following:

  • Save network transfer bandwidth.

  • Save memory space in Wwise.

  • Save CPU time in game by not calculating the data.

  • Save CPU time in Wwise by not processing or drawing the data.

[Note]Note

When you deselect a data type in the Profiler Settings dialog box, usually a corresponding tab is removed from the Advanced Profiler. In the case of Spatial Audio information, however, there is no tab. Instead, this data type corresponds to information sent to the Game Object 3D Viewer.

Interface Element

Description

CPU Data

Determines whether information related to CPU usage is captured by the Game Profiler. This includes CPU usage attributed to the various plug-ins.

Memory Data

Determines whether information related to the memory categories registered in the sound engine's Memory Manager is captured by the Game Profiler.

Stream Data

Determines whether information related to each of the streams managed by the sound engine is captured by the Game Profiler.

Voices Data

Determines whether information related to each of the voices managed by the sound engine is captured by the Game Profiler.

Listener Data

Determines whether information related to each of the listeners managed by the sound engine is captured by the Game Profiler.

Obstruction/Occlusion Data

Determines whether information affecting game objects and related to obstruction, occlusion, diffraction, transmission loss, and emitter spread is captured by the Game Profiler. This option must be enabled to visualize spread cones in the Game Object 3D Viewer.

Markers Notification Data

Determines whether information related to audio file markers and Music Segment custom cues is captured by the Game Profiler.

SoundBanks

Determines whether information related to the SoundBanks that have been loaded into memory is captured by the Game Profiler.

Loaded Media

Determines whether information related to the media loaded into memory is captured by the Game Profiler.

Prepared Events

Determines whether information related to Events prepared using the PrepareEvent function is captured by the Game Profiler.

Prepared Game Syncs

Determines whether information related to game syncs prepared using the PrepareGameSyncs function is captured by the Game Profiler.

Interactive Music

Determines whether information related to interactive music is captured by the Game Profiler, that is, Music Playlist Container callbacks and transitions between music objects.

Streaming Device Data

Allows capturing the information from all streaming devices, and usage of the Streaming tab in the Advanced Profiler.

Meter

Allows the usage of signal metering data to drive meters on busses and meter views, as well as output peak and output DC offset.

Auxiliary Sends Data

Determines whether information related to each of the Auxiliary Sends managed by the sound engine is captured by the Game Profiler.

API Calls

Determines whether calls to the Wwise API are captured by the Game Profiler.

Game Syncs

Determines whether information related to Game Syncs is captured by the Game Profiler to be displayed in the Game Sync Monitor.

Spatial Audio

Determines whether data related to spatial audio is captured by the Game Profiler. This includes emitters, listeners, geometry, rooms and their associated portals.

Spatial Audio Ray Casting

Determines whether data related to the spatial audio ray casting engine is captured by the Game Profiler. This includes reflection rays, diffraction rays, and edge receptors.

Voice Inspector Data

Determines whether data related to the Voice Inspector and Game Sync Monitor views is captured by the Game Profiler.

Audio Object Data

Determines whether data related to Audio Objects is captured by the Game Profiler.

Capture Log

Maximum File Size (MB)

Specifies the maximum file size that can be written by the Capture Log.

Min Value: 10 MB
Max Value: 32,000 MB
Default Value: 2,000 MB

Number of sessions kept

Specifies the maximum number of capture sessions that are kept as saved PROF files. Wwise erases the oldest capture session when the limit is surpassed.

Enable CPU Timeline

Enables the CPU timeline view in the CPU tab of the Advanced Profiler. The CPU Timeline provides detailed CPU timing information, including information across multiple threads, in order to allow for in-depth analysis of CPU activity in Wwise. Note that it is intended to be used by advanced users, and alongside other tools for in-depth CPU profiling across the entire process to provide additional information on why certain scopes are taking time to execute, or why work is not being scheduled on time.

Reduce thread heights dynamically

When enabled, this option reduces the height of the threads in the CPU timeline to match the CPU timing scopes that are currently in view, as opposed to the height of the CPU timing scopes across the entire profile session. It can be helpful to enable this option if your title has Wwise perform operations across many threads, which can make it difficult to see a full tick of activity all together.

Applies the changes you made to the Game Profiler settings.

Closes the Profiler Settings dialog box without applying any of the changes you made to the settings of the Game Profiler.


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