Struct StoreType 

pub struct StoreType {

    pub is_braid: bool,
    pub ffmpeg_version: Option<String>,
    pub is_nvenc_functioning: bool,
    pub is_videotoolbox_functioning: bool,
    pub is_recording_mp4: Option<RecordingPath>,
    pub is_recording_fmf: Option<RecordingPath>,
    pub is_recording_ufmf: Option<RecordingPath>,
    pub format_str_mp4: String,
    pub format_str: String,
    pub format_str_ufmf: String,
    pub camera_name: String,
    pub camera_gamma: Option<f32>,
    pub recording_filename: Option<String>,
    pub mp4_max_framerate: RecordingFrameRate,
    pub mp4_bitrate: BitrateSelection,
    pub mp4_codec: CodecSelection,
    pub mp4_cuda_device: String,
    pub gain_auto: Option<AutoMode>,
    pub gain: RangedValue,
    pub exposure_auto: Option<AutoMode>,
    pub exposure_time: RangedValue,
    pub frame_rate_limit_enabled: bool,
    pub frame_rate_limit: Option<RangedValue>,
    pub trigger_mode: TriggerMode,
    pub trigger_selector: TriggerSelector,
    pub image_width: u32,
    pub image_height: u32,
    pub has_image_tracker_compiled: bool,
    pub is_doing_object_detection: bool,
    pub measured_fps: f32,
    pub is_saving_im_pt_detect_csv: Option<RecordingPath>,
    pub im_pt_detect_cfg: ImPtDetectCfg,
    pub has_flydratrax_compiled: bool,
    pub kalman_tracking_config: KalmanTrackingConfig,
    pub led_program_config: LedProgramConfig,
    pub led_box_device_lost: bool,
    pub led_box_device_state: Option<DeviceState>,
    pub led_box_device_path: Option<String>,
    pub has_checkercal_compiled: bool,
    pub checkerboard_data: CheckerboardCalState,
    pub checkerboard_save_debug: Option<String>,
    pub post_trigger_buffer_size: usize,
    pub cuda_devices: Vec<String>,
    pub apriltag_state: Option<ApriltagState>,
    pub im_ops_state: ImOpsState,
    pub format_str_apriltag_csv: String,
    pub had_frame_processing_error: bool,
    pub camera_calibration: Option<Camera<f64>>,
    pub version_update: Option<VersionUpdate>,
}

Complete state representation of a Strand Camera instance.

This is the primary data structure that encapsulates all configuration, status, and capability information for a running camera. It includes everything from basic camera settings to complex processing features like object detection, Kalman tracking, and AprilTag recognition.

The structure is designed to be serialized and sent to web browsers for real-time monitoring and control of the camera system.

Feature Compilation

Many fields are conditional based on compile-time features:

• has_image_tracker_compiled: Object detection capabilities
• has_flydratrax_compiled: Kalman tracking and LED control
• has_checkercal_compiled: Checkerboard calibration
• apriltag_state: AprilTag detection (None if not compiled)

Fields

is_braid: bool

Whether we are running inside Braid.

ffmpeg_version: Option<String>

What version of ffmpeg is available to Strand Camera

is_nvenc_functioning: bool

Whether we have Nvidia NvEnc encoder available.

is_videotoolbox_functioning: bool

Whether we have VideoToolbox

is_recording_mp4: Option<RecordingPath>

is saving MP4 file

is_recording_fmf: Option<RecordingPath>

is saving FMF file

is_recording_ufmf: Option<RecordingPath>

is saving UFMF file

format_str_mp4: String

Format string template for MP4 filenames.

format_str: String

Format string template for FMF filenames.

format_str_ufmf: String

Format string template for UFMF filenames.

camera_name: String

Name of the camera device.

camera_gamma: Option<f32>

Current gamma correction value applied to the camera.

recording_filename: Option<String>

Base filename for recordings (without extension).

mp4_max_framerate: RecordingFrameRate

Maximum frame rate for MP4 recording.

mp4_bitrate: BitrateSelection

Bitrate selection for MP4 encoding.

mp4_codec: CodecSelection

Video codec selection for MP4 encoding.

mp4_cuda_device: String

CUDA device number (only used if using nvidia encoder)

gain_auto: Option<AutoMode>

Automatic gain control mode.

gain: RangedValue

Camera gain settings and range.

exposure_auto: Option<AutoMode>

Automatic exposure control mode.

exposure_time: RangedValue

Camera exposure time settings and range.

frame_rate_limit_enabled: bool

Whether software frame rate limiting is enabled.

frame_rate_limit: Option<RangedValue>

None when frame_rate_limit is not supported

trigger_mode: TriggerMode

Camera trigger mode (internal, external, etc.).

trigger_selector: TriggerSelector

Which trigger input to use.

image_width: u32

Width of captured images in pixels.

image_height: u32

Height of captured images in pixels.

has_image_tracker_compiled: bool

Whether object detection with image-tracker crate is compiled.

is_doing_object_detection: bool

Whether object detection is currently used.

measured_fps: f32

Current measured frame rate in frames per second.

is_saving_im_pt_detect_csv: Option<RecordingPath>

is saving object detection CSV file

im_pt_detect_cfg: ImPtDetectCfg

Configuration for image point detection algorithms.

has_flydratrax_compiled: bool

Whether flydratrax (2D kalman tracking and LED triggering) is compiled.

kalman_tracking_config: KalmanTrackingConfig

Configuration for Kalman tracking of detected objects.

led_program_config: LedProgramConfig

Configuration for LED control and triggering.

led_box_device_lost: bool

Whether connection to LED control device has been lost.

led_box_device_state: Option<DeviceState>

Current state of the LED control device.

led_box_device_path: Option<String>

Path to the LED control device.

has_checkercal_compiled: bool

Whether checkerboard calibration is compiled.

checkerboard_data: CheckerboardCalState

Current state of checkerboard calibration process.

checkerboard_save_debug: Option<String>

Path where debug data is being saved.

post_trigger_buffer_size: usize

Number of frames to buffer for post-trigger recording.

cuda_devices: Vec<String>

List of available CUDA devices for hardware acceleration.

apriltag_state: Option<ApriltagState>

This is None if no apriltag support is compiled in. Otherwise Some(_).

im_ops_state: ImOpsState

State of image operations processing.

format_str_apriltag_csv: String

Format string template for AprilTag CSV filenames.

had_frame_processing_error: bool

Whether there was an error during frame processing.

camera_calibration: Option<Camera<f64>>

The camera calibration (does not contain potential information about water)

version_update: Option<VersionUpdate>

A newer available release discovered by the background version check, or None if up to date (or the check has not yet found a newer version).

Trait Implementations

impl Clone for StoreType

fn clone(&self) -> StoreType

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StoreType

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StoreType

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for StoreType

fn eq(&self, other: &StoreType) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for StoreType

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StoreType