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

#include <voyant_types_ffi.hpp>

Public Attributes

uint8_t sensor_state_raw [154]
uint8_t host_state_raw [21]
uint8_t state_provenance
int64_t timestamp_seconds
int32_t timestamp_nanoseconds
uint32_t frame_index
uintptr_t n_points

Detailed Description

Fixed-size fields of a VoyantFrame for FFI transfer. The point array travels separately as n_points consecutive PointDataV1 values.

Member Data Documentation

◆ frame_index

uint32_t VoyantFrameMeta::frame_index

Device frame counter.

◆ host_state_raw

uint8_t VoyantFrameMeta::host_state_raw[21]

Raw host-state region. Opaque — decode with voyant_frame_host_state.

◆ n_points

uintptr_t VoyantFrameMeta::n_points

Number of points in the frame's point array.

◆ sensor_state_raw

uint8_t VoyantFrameMeta::sensor_state_raw[154]

Raw sensor-state region exactly as recordings store it. Opaque — decode with voyant_frame_sensor_state / voyant_frame_device_id.

◆ state_provenance

uint8_t VoyantFrameMeta::state_provenance

StateProvenance discriminant. Unrecognized values decode as Unknown, which counts as absent — a garbled tag withholds state rather than inventing it.

◆ timestamp_nanoseconds

int32_t VoyantFrameMeta::timestamp_nanoseconds

Sub-second remainder of the frame-start time (0..=999999999).

◆ timestamp_seconds

int64_t VoyantFrameMeta::timestamp_seconds

Time of frame start, whole seconds since the Unix epoch.


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