pulp::audio::LiveDspTelemetryBlockWriter Class Reference

Handle for one audio block. More...

#include <live_dsp_telemetry.hpp>

Public Member Functions
	LiveDspTelemetryBlockWriter () noexcept=default
	LiveDspTelemetryBlockWriter (LiveDspTelemetryStore *store, std::uint32_t ring_slot, std::uint32_t frame_count, double sample_rate) noexcept
	LiveDspTelemetryBlockWriter (const LiveDspTelemetryBlockWriter &)=delete
LiveDspTelemetryBlockWriter &	operator= (const LiveDspTelemetryBlockWriter &)=delete
	LiveDspTelemetryBlockWriter (LiveDspTelemetryBlockWriter &&other) noexcept
LiveDspTelemetryBlockWriter &	operator= (LiveDspTelemetryBlockWriter &&)=delete
	~LiveDspTelemetryBlockWriter () noexcept
bool	active () const noexcept
LiveDspTelemetryNodeScope	node (std::uint32_t node_slot) noexcept
	Start timing node node_slot (0-based, < node_count).
void	finish () noexcept
	Publish the block.

Detailed Description

Handle for one audio block.

Inactive when telemetry is disabled or the ring is full (drop-on-full). All work is RT-safe.

Constructor & Destructor Documentation

LiveDspTelemetryBlockWriter() [1/4]

pulp::audio::LiveDspTelemetryBlockWriter::LiveDspTelemetryBlockWriter ( )

defaultnoexcept

LiveDspTelemetryBlockWriter() [2/4]

pulp::audio::LiveDspTelemetryBlockWriter::LiveDspTelemetryBlockWriter ( LiveDspTelemetryStore * store, std::uint32_t ring_slot, std::uint32_t frame_count, double sample_rate )

noexcept

LiveDspTelemetryBlockWriter() [3/4]

pulp::audio::LiveDspTelemetryBlockWriter::LiveDspTelemetryBlockWriter ( const LiveDspTelemetryBlockWriter & )

delete

LiveDspTelemetryBlockWriter() [4/4]

pulp::audio::LiveDspTelemetryBlockWriter::LiveDspTelemetryBlockWriter ( LiveDspTelemetryBlockWriter && other )

noexcept

~LiveDspTelemetryBlockWriter()

pulp::audio::LiveDspTelemetryBlockWriter::~LiveDspTelemetryBlockWriter ( )

inlinenoexcept

Member Function Documentation

active()

bool pulp::audio::LiveDspTelemetryBlockWriter::active ( ) const

inlinenoexcept

finish()

void pulp::audio::LiveDspTelemetryBlockWriter::finish ( )

noexcept

Publish the block.

Idempotent; called by the destructor if not called explicitly. Records the total graph elapsed for the block.

node()

LiveDspTelemetryNodeScope pulp::audio::LiveDspTelemetryBlockWriter::node ( std::uint32_t node_slot )

noexcept

Start timing node node_slot (0-based, < node_count).

No-op if inactive or the slot is out of range.

operator=() [1/2]

LiveDspTelemetryBlockWriter & pulp::audio::LiveDspTelemetryBlockWriter::operator= ( const LiveDspTelemetryBlockWriter & )

delete

operator=() [2/2]

LiveDspTelemetryBlockWriter & pulp::audio::LiveDspTelemetryBlockWriter::operator= ( LiveDspTelemetryBlockWriter && )

delete

---

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

• /home/runner/work/pulp/pulp/core/audio/include/pulp/audio/live_dsp_telemetry.hpp