Struct SegmentDetection

#[non_exhaustive]
pub struct SegmentDetection {
    pub type: Option<SegmentType>,
    pub start_timestamp_millis: i64,
    pub end_timestamp_millis: i64,
    pub duration_millis: Option<i64>,
    pub start_timecode_smpte: Option<String>,
    pub end_timecode_smpte: Option<String>,
    pub duration_smpte: Option<String>,
    pub technical_cue_segment: Option<TechnicalCueSegment>,
    pub shot_segment: Option<ShotSegment>,
    pub start_frame_number: Option<i64>,
    pub end_frame_number: Option<i64>,
    pub duration_frames: Option<i64>,
}

A technical cue or shot detection segment detected in a video. An array of SegmentDetection objects containing all segments detected in a stored video is returned by GetSegmentDetection.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

type: Option<SegmentType>

The type of the segment. Valid values are TECHNICAL_CUE and SHOT.

start_timestamp_millis: i64

The start time of the detected segment in milliseconds from the start of the video. This value is rounded down. For example, if the actual timestamp is 100.6667 milliseconds, Amazon Rekognition Video returns a value of 100 millis.

end_timestamp_millis: i64

The end time of the detected segment, in milliseconds, from the start of the video. This value is rounded down.

duration_millis: Option<i64>

The duration of the detected segment in milliseconds.

start_timecode_smpte: Option<String>

The frame-accurate SMPTE timecode, from the start of a video, for the start of a detected segment. StartTimecode is in HH:MM:SS:fr format (and ;fr for drop frame-rates).

end_timecode_smpte: Option<String>

The frame-accurate SMPTE timecode, from the start of a video, for the end of a detected segment. EndTimecode is in HH:MM:SS:fr format (and ;fr for drop frame-rates).

duration_smpte: Option<String>

The duration of the timecode for the detected segment in SMPTE format.

technical_cue_segment: Option<TechnicalCueSegment>

If the segment is a technical cue, contains information about the technical cue.

shot_segment: Option<ShotSegment>

If the segment is a shot detection, contains information about the shot detection.

start_frame_number: Option<i64>

The frame number of the start of a video segment, using a frame index that starts with 0.

end_frame_number: Option<i64>

The frame number at the end of a video segment, using a frame index that starts with 0.

duration_frames: Option<i64>

The duration of a video segment, expressed in frames.

Implementations

impl SegmentDetection

pub fn type(&self) -> Option<&SegmentType>

The type of the segment. Valid values are TECHNICAL_CUE and SHOT.

pub fn start_timestamp_millis(&self) -> i64

The start time of the detected segment in milliseconds from the start of the video. This value is rounded down. For example, if the actual timestamp is 100.6667 milliseconds, Amazon Rekognition Video returns a value of 100 millis.

pub fn end_timestamp_millis(&self) -> i64

The end time of the detected segment, in milliseconds, from the start of the video. This value is rounded down.

pub fn duration_millis(&self) -> Option<i64>

The duration of the detected segment in milliseconds.

pub fn start_timecode_smpte(&self) -> Option<&str>

The frame-accurate SMPTE timecode, from the start of a video, for the start of a detected segment. StartTimecode is in HH:MM:SS:fr format (and ;fr for drop frame-rates).

pub fn end_timecode_smpte(&self) -> Option<&str>

The frame-accurate SMPTE timecode, from the start of a video, for the end of a detected segment. EndTimecode is in HH:MM:SS:fr format (and ;fr for drop frame-rates).

pub fn duration_smpte(&self) -> Option<&str>

The duration of the timecode for the detected segment in SMPTE format.

pub fn technical_cue_segment(&self) -> Option<&TechnicalCueSegment>

If the segment is a technical cue, contains information about the technical cue.

pub fn shot_segment(&self) -> Option<&ShotSegment>

If the segment is a shot detection, contains information about the shot detection.

pub fn start_frame_number(&self) -> Option<i64>

The frame number of the start of a video segment, using a frame index that starts with 0.

pub fn end_frame_number(&self) -> Option<i64>

The frame number at the end of a video segment, using a frame index that starts with 0.

pub fn duration_frames(&self) -> Option<i64>

The duration of a video segment, expressed in frames.

impl SegmentDetection

pub fn builder() -> SegmentDetectionBuilder

Creates a new builder-style object to manufacture SegmentDetection.

Trait Implementations

impl Clone for SegmentDetection

fn clone(&self) -> SegmentDetection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SegmentDetection

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

Formats the value using the given formatter.

impl PartialEq for SegmentDetection

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

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

const 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 StructuralPartialEq for SegmentDetection