rlsl-rec 0.0.5

Real Life Streaming Layer recorder with TUI — records LSL streams to XDF files
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

//! Stream markers / annotations — inject timestamped event markers during recording.
//!
//! Creates a dedicated LSL string stream for markers so they are recorded
//! alongside data streams in XDF/Parquet.

use rlsl::outlet::StreamOutlet;
use rlsl::stream_info::StreamInfo;
use rlsl::types::ChannelFormat;

/// A marker outlet that pushes string events with timestamps.
pub struct MarkerOutlet {
    outlet: StreamOutlet,
    count: u64,
}

impl MarkerOutlet {
    /// Create a new marker stream.
    pub fn new(name: &str) -> Self {
        let info = StreamInfo::new(
            name,
            "Markers",
            1,
            0.0, // irregular rate
            ChannelFormat::String,
            &format!("marker_{}", uuid::Uuid::new_v4()),
        );
        let outlet = StreamOutlet::new(&info, 0, 360);
        MarkerOutlet { outlet, count: 0 }
    }

    /// Push a marker event with the current timestamp.
    pub fn push(&mut self, label: &str) {
        self.count += 1;
        self.outlet.push_sample_str(&[label.to_string()], 0.0, true);
    }

    /// Push a marker with a custom timestamp.
    pub fn push_at(&mut self, label: &str, timestamp: f64) {
        self.count += 1;
        self.outlet
            .push_sample_str(&[label.to_string()], timestamp, true);
    }

    /// Number of markers pushed.
    pub fn count(&self) -> u64 {
        self.count
    }

    /// Get the stream info (useful for recording).
    pub fn info(&self) -> &StreamInfo {
        self.outlet.info()
    }
}