Om  1.0.0
A universal framework for multimedia simulation
Public Member Functions | Public Attributes | List of all members
om::sound::acoustics::contexts::AcousticStatistics Class Reference

A class that receives sound propagation and rendering statistics for an acoustic context. More...

#include <omAcousticStatistics.h>

Public Member Functions

 AcousticStatistics ()
 Create a default acoustic statistics object. More...
 

Public Attributes

Size listenerCount
 Th enumber of enabled listeners in the scene on the last frame. More...
 
Size activeListenerCount
 The number of active sound listeners in the scene on the last frame, e.g. the number simulated. More...
 
Size sourceCount
 The total number of enabled sources in the scene on the last frame. More...
 
Size activeSourceCount
 The number of active sound sources in the scene on the last frame, e.g. the number simulated. More...
 
Size objectCount
 The number of objects there were in the scene on the last frame. More...
 
Float averageIRLength
 The average length of all impulse responses that were computed. More...
 
Float maxIRLength
 The length of the longest impulse responses that was computed. More...
 
Time updateTime
 The total time spent updating the state of the acoustic context on the last frame. More...
 
Float bufferingLoad
 The current buffering load, from 0 to 1, indicating the fraction of real time spent buffering source audio. More...
 
Float renderingLoad
 The current audio rendering load, from 0 to 1, indicating the fraction of real time spent rendering. More...
 
Float renderingLatency
 The latency in seconds of the rendering system. More...
 
Size propagationMemory
 The approximate total amount of memory in bytes used for the propagation system. More...
 
Size renderingMemory
 The approximate total amount of memory in bytes used for the rendering system. More...
 
Size totalMemory
 The approximate total amount of memory in bytes used by the whole system. More...
 

Detailed Description

A class that receives sound propagation and rendering statistics for an acoustic context.

Constructor & Destructor Documentation

om::sound::acoustics::contexts::AcousticStatistics::AcousticStatistics ( )

Create a default acoustic statistics object.

Member Data Documentation

Size om::sound::acoustics::contexts::AcousticStatistics::listenerCount

Th enumber of enabled listeners in the scene on the last frame.

Size om::sound::acoustics::contexts::AcousticStatistics::activeListenerCount

The number of active sound listeners in the scene on the last frame, e.g. the number simulated.

Size om::sound::acoustics::contexts::AcousticStatistics::sourceCount

The total number of enabled sources in the scene on the last frame.

Size om::sound::acoustics::contexts::AcousticStatistics::activeSourceCount

The number of active sound sources in the scene on the last frame, e.g. the number simulated.

Size om::sound::acoustics::contexts::AcousticStatistics::objectCount

The number of objects there were in the scene on the last frame.

Float om::sound::acoustics::contexts::AcousticStatistics::averageIRLength

The average length of all impulse responses that were computed.

Float om::sound::acoustics::contexts::AcousticStatistics::maxIRLength

The length of the longest impulse responses that was computed.

Time om::sound::acoustics::contexts::AcousticStatistics::updateTime

The total time spent updating the state of the acoustic context on the last frame.

Float om::sound::acoustics::contexts::AcousticStatistics::bufferingLoad

The current buffering load, from 0 to 1, indicating the fraction of real time spent buffering source audio.

Float om::sound::acoustics::contexts::AcousticStatistics::renderingLoad

The current audio rendering load, from 0 to 1, indicating the fraction of real time spent rendering.

Float om::sound::acoustics::contexts::AcousticStatistics::renderingLatency

The latency in seconds of the rendering system.

Size om::sound::acoustics::contexts::AcousticStatistics::propagationMemory

The approximate total amount of memory in bytes used for the propagation system.

This value includes any caches or data structures that accelerate sound propagation.

Size om::sound::acoustics::contexts::AcousticStatistics::renderingMemory

The approximate total amount of memory in bytes used for the rendering system.

Size om::sound::acoustics::contexts::AcousticStatistics::totalMemory

The approximate total amount of memory in bytes used by the whole system.


The documentation for this class was generated from the following file: