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

1/// Segment for V2 channel-based video API (without videoRid).
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 SegmentV2 {
14    #[serde(rename = "rid")]
15    rid: super::super::super::super::api::rids::SegmentRid,
16    #[builder(default, into)]
17    #[serde(rename = "datasetFileId", skip_serializing_if = "Option::is_none", default)]
18    dataset_file_id: Option<conjure_object::Uuid>,
19    #[builder(
20        custom(type = super::super::super::super::api::Handle, convert = Box::new)
21    )]
22    #[serde(rename = "dataHandle")]
23    data_handle: Box<super::super::super::super::api::Handle>,
24    #[serde(rename = "frameRate")]
25    #[derive_with(with = conjure_object::private::DoubleWrapper)]
26    frame_rate: f64,
27    #[serde(rename = "durationSeconds")]
28    #[derive_with(with = conjure_object::private::DoubleWrapper)]
29    duration_seconds: f64,
30    #[builder(custom(type = super::SegmentTimestamps, convert = Box::new))]
31    #[serde(rename = "timestamps")]
32    timestamps: Box<super::SegmentTimestamps>,
33}
34impl SegmentV2 {
35    #[inline]
36    pub fn rid(&self) -> &super::super::super::super::api::rids::SegmentRid {
37        &self.rid
38    }
39    /// The dataset file ID that this segment belongs to.
40    #[inline]
41    pub fn dataset_file_id(&self) -> Option<conjure_object::Uuid> {
42        self.dataset_file_id.as_ref().map(|o| *o)
43    }
44    #[inline]
45    pub fn data_handle(&self) -> &super::super::super::super::api::Handle {
46        &*self.data_handle
47    }
48    /// The average frame rate (FPS) of the segment calculated as total frames / duration in seconds.
49    #[inline]
50    pub fn frame_rate(&self) -> f64 {
51        self.frame_rate
52    }
53    /// The duration of a segment in media time.
54    #[inline]
55    pub fn duration_seconds(&self) -> f64 {
56        self.duration_seconds
57    }
58    /// for videos with frame-level timestamps, we provide mappings, otherwise we just include a single list
59    /// of timestamps.
60    #[inline]
61    pub fn timestamps(&self) -> &super::SegmentTimestamps {
62        &*self.timestamps
63    }
64}
nominal_api/conjure/objects/scout/video/api/segment_v2.rs

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