Skip to main content

nominal_api/conjure/objects/scout/video/api/
video_channel_segments_metadata.rs

1/// Aggregated segment metadata for a video channel series
2#[derive(
3    Debug,
4    Clone,
5    conjure_object::serde::Serialize,
6    conjure_object::serde::Deserialize,
7    conjure_object::private::DeriveWith
8)]
9#[serde(crate = "conjure_object::serde")]
10#[derive_with(PartialEq, Eq, PartialOrd, Ord, Hash)]
11#[conjure_object::private::staged_builder::staged_builder]
12#[builder(crate = conjure_object::private::staged_builder, update, inline)]
13pub struct VideoChannelSegmentsMetadata {
14    #[serde(rename = "numFrames")]
15    num_frames: i32,
16    #[serde(rename = "numSegments")]
17    num_segments: i32,
18    #[builder(
19        custom(type = super::super::super::super::api::Timestamp, convert = Box::new)
20    )]
21    #[serde(rename = "minAbsoluteTimestamp")]
22    min_absolute_timestamp: Box<super::super::super::super::api::Timestamp>,
23    #[builder(
24        custom(type = super::super::super::super::api::Timestamp, convert = Box::new)
25    )]
26    #[serde(rename = "maxAbsoluteTimestamp")]
27    max_absolute_timestamp: Box<super::super::super::super::api::Timestamp>,
28    #[serde(rename = "mediaDurationSeconds")]
29    #[derive_with(with = conjure_object::private::DoubleWrapper)]
30    media_duration_seconds: f64,
31    #[serde(rename = "mediaFrameRate")]
32    #[derive_with(with = conjure_object::private::DoubleWrapper)]
33    media_frame_rate: f64,
34}
35impl VideoChannelSegmentsMetadata {
36    #[inline]
37    pub fn num_frames(&self) -> i32 {
38        self.num_frames
39    }
40    #[inline]
41    pub fn num_segments(&self) -> i32 {
42        self.num_segments
43    }
44    #[inline]
45    pub fn min_absolute_timestamp(&self) -> &super::super::super::super::api::Timestamp {
46        &*self.min_absolute_timestamp
47    }
48    #[inline]
49    pub fn max_absolute_timestamp(&self) -> &super::super::super::super::api::Timestamp {
50        &*self.max_absolute_timestamp
51    }
52    #[inline]
53    pub fn media_duration_seconds(&self) -> f64 {
54        self.media_duration_seconds
55    }
56    /// The average media frame rate (FPS) calculated as total frames / duration in seconds.
57    #[inline]
58    pub fn media_frame_rate(&self) -> f64 {
59        self.media_frame_rate
60    }
61}