Roc Toolkit internal modules
Roc Toolkit: real-time audio streaming
roc::audio::LatencyMonitorConfig Struct Reference

Parameters for latency monitor. More...

#include <latency_monitor.h>

Public Member Functions

void deduce_fe_profile (const core::nanoseconds_t target_latency)
 Automatically deduce FreqEstimator profile from target latency. More...
 
void deduce_latency_tolerance (core::nanoseconds_t target_latency)
 Automatically deduce latency_tolerance from target_latency. More...
 

Public Attributes

bool fe_enable
 Enable FreqEstimator. More...
 
FreqEstimatorProfile fe_profile
 FreqEstimator profile. More...
 
core::nanoseconds_t fe_update_interval
 FreqEstimator update interval, nanoseconds. How often to run FreqEstimator and update Resampler scaling. More...
 
core::nanoseconds_t latency_tolerance
 Maximum allowed deviation from target latency, nanoseconds. If the latency goes out of bounds, the session is terminated. More...
 
float scaling_tolerance
 Maximum allowed deviation of freq_coeff from 1.0. If the scaling goes out of bounds, it is trimmed. For example, 0.01 allows freq_coeff values in range [0.99; 1.01]. More...
 

Detailed Description

Parameters for latency monitor.

Definition at line 31 of file latency_monitor.h.

Member Function Documentation

◆ deduce_fe_profile()

void roc::audio::LatencyMonitorConfig::deduce_fe_profile ( const core::nanoseconds_t  target_latency)
inline

Automatically deduce FreqEstimator profile from target latency.

Definition at line 60 of file latency_monitor.h.

◆ deduce_latency_tolerance()

void roc::audio::LatencyMonitorConfig::deduce_latency_tolerance ( core::nanoseconds_t  target_latency)
inline

Automatically deduce latency_tolerance from target_latency.

Definition at line 71 of file latency_monitor.h.

Member Data Documentation

◆ fe_enable

bool roc::audio::LatencyMonitorConfig::fe_enable

Enable FreqEstimator.

Definition at line 33 of file latency_monitor.h.

◆ fe_profile

FreqEstimatorProfile roc::audio::LatencyMonitorConfig::fe_profile

FreqEstimator profile.

Definition at line 36 of file latency_monitor.h.

◆ fe_update_interval

core::nanoseconds_t roc::audio::LatencyMonitorConfig::fe_update_interval

FreqEstimator update interval, nanoseconds. How often to run FreqEstimator and update Resampler scaling.

Definition at line 40 of file latency_monitor.h.

◆ latency_tolerance

core::nanoseconds_t roc::audio::LatencyMonitorConfig::latency_tolerance

Maximum allowed deviation from target latency, nanoseconds. If the latency goes out of bounds, the session is terminated.

Definition at line 44 of file latency_monitor.h.

◆ scaling_tolerance

float roc::audio::LatencyMonitorConfig::scaling_tolerance

Maximum allowed deviation of freq_coeff from 1.0. If the scaling goes out of bounds, it is trimmed. For example, 0.01 allows freq_coeff values in range [0.99; 1.01].

Definition at line 49 of file latency_monitor.h.


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