Skip to main content

TelemetryProbe

Struct TelemetryProbe 

Source
pub struct TelemetryProbe<T: Transcendental, const BUF_SIZE: usize, const QUEUE_CAP: usize> { /* private fields */ }
Expand description

Passive telemetry probe that passes audio through while periodically capturing block data + metrics into a shared ring buffer.

§Type Parameters

  • T — sample type (f32/f64)
  • BUF_SIZE — signal block size
  • QUEUE_CAP — capacity of the telemetry ring buffer (must be power of two)

§Design

  • 1 audio input → 1 audio output (passthrough, zero-latency)
  • Every interval blocks, computes peak/RMS/DC and pushes into the queue
  • Queue is SpscQueue with overwrite-oldest policy (default)
  • Non-blocking: if the queue is full, old entries are overwritten

Implementations§

Source§

impl<T: Transcendental, const BUF_SIZE: usize, const QUEUE_CAP: usize> TelemetryProbe<T, BUF_SIZE, QUEUE_CAP>

Source

pub fn new( queue: Arc<SpscQueue<TelemetryBlock<T, BUF_SIZE>, QUEUE_CAP>>, interval: u32, channel: u32, node_name: &str, ) -> Self

Create a new telemetry probe.

§Arguments
  • queue — shared SpscQueue for telemetry output
  • interval — send telemetry every N blocks (1 = every block)
  • channel — channel index to report in telemetry frames
  • node_name — human-readable node name for metadata
Source

pub fn queue(&self) -> &Arc<SpscQueue<TelemetryBlock<T, BUF_SIZE>, QUEUE_CAP>>

Get a reference to the shared telemetry queue.

Trait Implementations§

Source§

impl<T: Transcendental, const BUF_SIZE: usize, const QUEUE_CAP: usize> Node<T, BUF_SIZE> for TelemetryProbe<T, BUF_SIZE, QUEUE_CAP>

Source§

fn metadata(&self) -> NodeMetadata

Get node metadata
Source§

fn init(&mut self, sample_rate: f32)

Initialize the node with a sample rate
Source§

fn reset(&mut self)

Reset the node to its initial state
Source§

fn get_parameter(&self, _id: &ParameterId) -> Option<ParamValue>

Get the value of a parameter
Source§

fn set_parameter( &mut self, _id: &ParameterId, _value: ParamValue, ) -> ProcessResult<()>

Set the value of a parameter
Source§

fn id(&self) -> NodeId

Get node ID
Source§

fn set_id(&mut self, id: NodeId)

Set node ID
Source§

fn input_port(&self, index: usize) -> Option<&Port<T, BUF_SIZE>>

Get input port by index
Source§

fn input_port_mut(&mut self, index: usize) -> Option<&mut Port<T, BUF_SIZE>>

Get mutable input port by index
Source§

fn output_port(&self, index: usize) -> Option<&Port<T, BUF_SIZE>>

Get output port by index
Source§

fn output_port_mut(&mut self, index: usize) -> Option<&mut Port<T, BUF_SIZE>>

Get mutable output port by index
Source§

fn control_port(&self, _index: usize) -> Option<&Port<T, BUF_SIZE>>

Get control port by index
Source§

fn control_port_mut(&mut self, _index: usize) -> Option<&mut Port<T, BUF_SIZE>>

Get mutable control port by index
Source§

fn num_signal_inputs(&self) -> usize

Number of signal input ports
Source§

fn num_signal_outputs(&self) -> usize

Number of signal output ports
Source§

fn num_control_inputs(&self) -> usize

Number of control input ports
Source§

fn num_control_outputs(&self) -> usize

Number of control output ports
Source§

fn state(&self) -> &NodeState<T, BUF_SIZE>

Get node state
Source§

fn state_mut(&mut self) -> &mut NodeState<T, BUF_SIZE>

Get mutable node state
Source§

fn node_type_id(&self) -> NodeTypeId
where Self: Sized + 'static,

Get the node’s type ID
Source§

fn apply_set_parameter( &mut self, cmd: &SetParameter, ) -> Result<(), ProcessError>

Apply a SetParameter command to this node. Read more
Source§

fn resolve_resources(&mut self, _resources: &mut ResourceRegistry<T>)

Resolve named shared resources (tape loops, etc.) from the registry, acquiring the capability handle matching this node’s role.
Source§

fn num_clock_inputs(&self) -> usize

Number of clock input ports
Source§

fn num_clock_outputs(&self) -> usize

Number of clock output ports
Source§

fn num_feedback_ports(&self) -> usize

Number of feedback ports
Source§

fn num_inputs(&self) -> usize

Total number of input ports
Source§

fn num_outputs(&self) -> usize

Total number of output ports
Source§

impl<T: Transcendental, const BUF_SIZE: usize, const QUEUE_CAP: usize> Processor<T, BUF_SIZE> for TelemetryProbe<T, BUF_SIZE, QUEUE_CAP>

Source§

fn process( &mut self, _ctx: &RenderContext, signal_inputs: &[&[T; BUF_SIZE]], _control_inputs: &[T], _clock_inputs: &[RenderContext], _feedback_inputs: &[&[T; BUF_SIZE]], ) -> ProcessResult<()>

Process a block of signal Read more
Source§

fn latency(&self) -> usize

Latency in samples (for delay compensation)

Auto Trait Implementations§

§

impl<T, const BUF_SIZE: usize, const QUEUE_CAP: usize> !RefUnwindSafe for TelemetryProbe<T, BUF_SIZE, QUEUE_CAP>

§

impl<T, const BUF_SIZE: usize, const QUEUE_CAP: usize> !UnwindSafe for TelemetryProbe<T, BUF_SIZE, QUEUE_CAP>

§

impl<T, const BUF_SIZE: usize, const QUEUE_CAP: usize> Freeze for TelemetryProbe<T, BUF_SIZE, QUEUE_CAP>
where T: Freeze,

§

impl<T, const BUF_SIZE: usize, const QUEUE_CAP: usize> Send for TelemetryProbe<T, BUF_SIZE, QUEUE_CAP>

§

impl<T, const BUF_SIZE: usize, const QUEUE_CAP: usize> Sync for TelemetryProbe<T, BUF_SIZE, QUEUE_CAP>

§

impl<T, const BUF_SIZE: usize, const QUEUE_CAP: usize> Unpin for TelemetryProbe<T, BUF_SIZE, QUEUE_CAP>
where T: Unpin,

§

impl<T, const BUF_SIZE: usize, const QUEUE_CAP: usize> UnsafeUnpin for TelemetryProbe<T, BUF_SIZE, QUEUE_CAP>
where T: UnsafeUnpin,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> AsAny for T
where T: 'static,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert to &dyn std::any::Any
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert to &mut dyn std::any::Any
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V