Pulp 1.88.0
Cross-platform audio plugin framework
Loading...
Searching...
No Matches
pulp::inspect::AudioInspector Class Reference

Monitors audio thread performance and state for the inspector. More...

#include <audio_inspector.hpp>

Public Member Functions

 AudioInspector ()=default
void set_config (const AudioConfig &config)
AudioConfig config () const
void begin_callback ()
 Call at the start/end of each audio callback to measure duration.
void end_callback (uint64_t frame_number)
void report_levels (const std::vector< ChannelLevels > &levels)
 Report output levels for the current buffer.
void log_midi (uint8_t status, uint8_t data1, uint8_t data2, const std::string &description={})
void set_runtime_telemetry (const pulp::audio::AudioProcessLoadSnapshot &process_load, uint64_t xrun_count)
void set_xrun_count (uint64_t xrun_count)
 Update the independently valid backend xrun counter without claiming a process-load producer is attached.
void clear_runtime_telemetry ()
AudioRuntimeTelemetry runtime_telemetry () const
std::vector< BufferUnderrun > recent_underruns () const
std::vector< MidiLogEntry > recent_midi () const
std::vector< ChannelLevels > latest_levels () const
bool metering_enabled () const
void set_metering_enabled (bool enabled)

Detailed Description

Monitors audio thread performance and state for the inspector.

All methods are thread-safe (called from audio thread, read from UI thread).

Constructor & Destructor Documentation

◆ AudioInspector()

pulp::inspect::AudioInspector::AudioInspector ( )
default

Member Function Documentation

◆ begin_callback()

void pulp::inspect::AudioInspector::begin_callback ( )

Call at the start/end of each audio callback to measure duration.

◆ clear_runtime_telemetry()

void pulp::inspect::AudioInspector::clear_runtime_telemetry ( )

◆ config()

AudioConfig pulp::inspect::AudioInspector::config ( ) const

◆ end_callback()

void pulp::inspect::AudioInspector::end_callback ( uint64_t frame_number)

◆ latest_levels()

std::vector< ChannelLevels > pulp::inspect::AudioInspector::latest_levels ( ) const

◆ log_midi()

void pulp::inspect::AudioInspector::log_midi ( uint8_t status,
uint8_t data1,
uint8_t data2,
const std::string & description = {} )

◆ metering_enabled()

bool pulp::inspect::AudioInspector::metering_enabled ( ) const
inline

◆ recent_midi()

std::vector< MidiLogEntry > pulp::inspect::AudioInspector::recent_midi ( ) const

◆ recent_underruns()

std::vector< BufferUnderrun > pulp::inspect::AudioInspector::recent_underruns ( ) const

◆ report_levels()

void pulp::inspect::AudioInspector::report_levels ( const std::vector< ChannelLevels > & levels)

Report output levels for the current buffer.

◆ runtime_telemetry()

AudioRuntimeTelemetry pulp::inspect::AudioInspector::runtime_telemetry ( ) const

◆ set_config()

void pulp::inspect::AudioInspector::set_config ( const AudioConfig & config)

◆ set_metering_enabled()

void pulp::inspect::AudioInspector::set_metering_enabled ( bool enabled)
inline

◆ set_runtime_telemetry()

void pulp::inspect::AudioInspector::set_runtime_telemetry ( const pulp::audio::AudioProcessLoadSnapshot & process_load,
uint64_t xrun_count )

◆ set_xrun_count()

void pulp::inspect::AudioInspector::set_xrun_count ( uint64_t xrun_count)

Update the independently valid backend xrun counter without claiming a process-load producer is attached.


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