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

Collects and formats diagnostic information about the system, plugin configuration, and audio state for troubleshooting. More...

#include <diagnostic_reporter.hpp>

Public Member Functions

void set_plugin_info (const PluginDescriptor &desc, const state::StateStore &store)
void set_audio_config (double sample_rate, int buffer_size, int input_channels, int output_channels)
void set_format_name (const std::string &name)
void set_host_name (const std::string &name)
void set_cpu_load (float load, float peak)
void add_custom_entry (const std::string &key, const std::string &value)
std::string generate_report () const
 Generate a full diagnostic report as a human-readable string.
std::string generate_json () const
 Generate a compact JSON report for programmatic consumption.

Detailed Description

Collects and formats diagnostic information about the system, plugin configuration, and audio state for troubleshooting.

diag.set_plugin_info(host.descriptor(), host.state());
diag.set_audio_config(44100, 512, 2, 2);
std::string report = diag.generate_report();
// Copy to clipboard or save to file
Collects and formats diagnostic information about the system, plugin configuration,...
Definition diagnostic_reporter.hpp:28
std::string generate_report() const
Generate a full diagnostic report as a human-readable string.
Definition diagnostic_reporter.hpp:84
void set_plugin_info(const PluginDescriptor &desc, const state::StateStore &store)
Definition diagnostic_reporter.hpp:32
void set_audio_config(double sample_rate, int buffer_size, int input_channels, int output_channels)
Definition diagnostic_reporter.hpp:57
Bounded event contracts shared by host ingress and graph-authored nodes.
Definition anticipation_eligibility.hpp:9

Member Function Documentation

◆ add_custom_entry()

void pulp::format::DiagnosticReporter::add_custom_entry ( const std::string & key,
const std::string & value )
inline

◆ generate_json()

std::string pulp::format::DiagnosticReporter::generate_json ( ) const
inline

Generate a compact JSON report for programmatic consumption.

◆ generate_report()

std::string pulp::format::DiagnosticReporter::generate_report ( ) const
inline

Generate a full diagnostic report as a human-readable string.

◆ set_audio_config()

void pulp::format::DiagnosticReporter::set_audio_config ( double sample_rate,
int buffer_size,
int input_channels,
int output_channels )
inline

◆ set_cpu_load()

void pulp::format::DiagnosticReporter::set_cpu_load ( float load,
float peak )
inline

◆ set_format_name()

void pulp::format::DiagnosticReporter::set_format_name ( const std::string & name)
inline

◆ set_host_name()

void pulp::format::DiagnosticReporter::set_host_name ( const std::string & name)
inline

◆ set_plugin_info()

void pulp::format::DiagnosticReporter::set_plugin_info ( const PluginDescriptor & desc,
const state::StateStore & store )
inline

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