Skip to content

SegmentDetection

Source code in docs_src/capo_rekognition/types/segment_detection.py
class SegmentDetection(TypedDict, closed=True):
    type: NotRequired["capo_rekognition.types.segment_type.SegmentType"]
    """<p>The type of the segment. Valid values are <code>TECHNICAL_CUE</code> and <code>SHOT</code>.</p>"""
    start_timestamp_millis: "capo_rekognition.types.timestamp.Timestamp"
    """<p>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.</p>"""
    end_timestamp_millis: "capo_rekognition.types.timestamp.Timestamp"
    """<p>The end time of the detected segment, in milliseconds, from the start of the video. This value is rounded down.</p>"""
    duration_millis: NotRequired["capo_rekognition.types.u_long.ULong"]
    """<p>The duration of the detected segment in milliseconds. </p>"""
    start_timecode_smpte: NotRequired["capo_rekognition.types.timecode.Timecode"]
    """<p>The frame-accurate SMPTE timecode, from the start of a video, for the start of a detected segment. <code>StartTimecode</code> is in <i>HH:MM:SS:fr</i> format (and <i>;fr</i> for drop frame-rates). </p>"""
    end_timecode_smpte: NotRequired["capo_rekognition.types.timecode.Timecode"]
    """<p>The frame-accurate SMPTE timecode, from the start of a video, for the end of a detected segment. <code>EndTimecode</code> is in <i>HH:MM:SS:fr</i> format (and <i>;fr</i> for drop frame-rates).</p>"""
    duration_smpte: NotRequired["capo_rekognition.types.timecode.Timecode"]
    """<p>The duration of the timecode for the detected segment in SMPTE format.</p>"""
    technical_cue_segment: NotRequired[
        "capo_rekognition.types.technical_cue_segment.TechnicalCueSegment"
    ]
    """<p>If the segment is a technical cue, contains information about the technical cue.</p>"""
    shot_segment: NotRequired["capo_rekognition.types.shot_segment.ShotSegment"]
    """<p>If the segment is a shot detection, contains information about the shot detection.</p>"""
    start_frame_number: NotRequired["capo_rekognition.types.u_long.ULong"]
    """<p> The frame number of the start of a video segment, using a frame index that starts with 0. </p>"""
    end_frame_number: NotRequired["capo_rekognition.types.u_long.ULong"]
    """<p> The frame number at the end of a video segment, using a frame index that starts with 0. </p>"""
    duration_frames: NotRequired["capo_rekognition.types.u_long.ULong"]
    """<p> The duration of a video segment, expressed in frames. </p>"""

duration_frames instance-attribute

duration_frames: NotRequired[ULong]

The duration of a video segment, expressed in frames.

duration_millis instance-attribute

duration_millis: NotRequired[ULong]

The duration of the detected segment in milliseconds.

duration_smpte instance-attribute

duration_smpte: NotRequired[Timecode]

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

end_frame_number instance-attribute

end_frame_number: NotRequired[ULong]

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

end_timecode_smpte instance-attribute

end_timecode_smpte: NotRequired[Timecode]

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).

end_timestamp_millis instance-attribute

end_timestamp_millis: Timestamp

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

shot_segment instance-attribute

shot_segment: NotRequired[ShotSegment]

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

start_frame_number instance-attribute

start_frame_number: NotRequired[ULong]

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

start_timecode_smpte instance-attribute

start_timecode_smpte: NotRequired[Timecode]

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).

start_timestamp_millis instance-attribute

start_timestamp_millis: Timestamp

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.

technical_cue_segment instance-attribute

technical_cue_segment: NotRequired[TechnicalCueSegment]

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

type instance-attribute

type: NotRequired[SegmentType]

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