Struct AudioRenderCapacity

pub struct AudioRenderCapacity { /* private fields */ }

Provider for rendering performance metrics

A load value is computed for each system-level audio callback, by dividing its execution duration by the system-level audio callback buffer size divided by the sample rate.

Ideally the load value is below 1.0, meaning that it took less time to render the audio than it took to play it out. An audio buffer underrun happens when this load value is greater than 1.0: the system could not render audio fast enough for real-time.

Implementations

impl AudioRenderCapacity

pub fn start(&self, options: AudioRenderCapacityOptions)

Start metric collection and analysis

pub fn stop(&self)

Stop metric collection and analysis

pub fn set_onupdate<F: FnMut(AudioRenderCapacityEvent) + Send + 'static>( &self, callback: F, )

The EventHandler for AudioRenderCapacityEvent.

Only a single event handler is active at any time. Calling this method multiple times will override the previous event handler.

pub fn clear_onupdate(&self)

Unset the EventHandler for AudioRenderCapacityEvent.

Trait Implementations

impl Clone for AudioRenderCapacity

fn clone(&self) -> AudioRenderCapacity

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AudioRenderCapacity

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.