Voyant API 1.0.0
Loading...
Searching...
No Matches
HostState Struct Reference

#include <voyant_types_ffi.hpp>

Public Attributes

int16_t state_age_frames
uint16_t dropped_ramps
bool sync_valid
int64_t sync_offset_ns
uint32_t sync_jitter_ns
uint32_t sync_round_trip_ns

Detailed Description

Host-side frame context in natural units — what the client knew when it sealed the frame. Zero fields mean "nothing to report" (sources without host context, e.g. playback of another producer's recording, leave the region zeroed).

Member Data Documentation

◆ dropped_ramps

uint16_t HostState::dropped_ramps

Data-plane ramp drops within this frame.

◆ state_age_frames

int16_t HostState::state_age_frames

Frames the sensor-state snapshot lags this frame; 0 = fresh, positive = stale snapshot (dropped heartbeats), negative = counter ahead of the rollover rail (e.g. after mid-stream frame loss).

◆ sync_jitter_ns

uint32_t HostState::sync_jitter_ns

Standard deviation of the offset over the measurement window, nanoseconds; saturates at 4294967295.

◆ sync_offset_ns

int64_t HostState::sync_offset_ns

Most recent host − FPGA clock difference, nanoseconds.

◆ sync_round_trip_ns

uint32_t HostState::sync_round_trip_ns

Round-trip of the kept read, nanoseconds; saturates at 4294967295.

◆ sync_valid

bool HostState::sync_valid

True when the sync_* fields hold a fresh time-sync measurement; when false they hold the last stale measurement (or zeros if never measured) — ignore them.


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