Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Rekognition.Types.SegmentDetection

Description

Synopsis

data SegmentDetection = SegmentDetection' {
- durationFrames :: Maybe Natural
- durationMillis :: Maybe Natural
- durationSMPTE :: Maybe Text
- endFrameNumber :: Maybe Natural
- endTimecodeSMPTE :: Maybe Text
- endTimestampMillis :: Maybe Integer
- shotSegment :: Maybe ShotSegment
- startFrameNumber :: Maybe Natural
- startTimecodeSMPTE :: Maybe Text
- startTimestampMillis :: Maybe Integer
- technicalCueSegment :: Maybe TechnicalCueSegment
- type' :: Maybe SegmentType
}
newSegmentDetection :: SegmentDetection
segmentDetection_durationFrames :: Lens' SegmentDetection (Maybe Natural)
segmentDetection_durationMillis :: Lens' SegmentDetection (Maybe Natural)
segmentDetection_durationSMPTE :: Lens' SegmentDetection (Maybe Text)
segmentDetection_endFrameNumber :: Lens' SegmentDetection (Maybe Natural)
segmentDetection_endTimecodeSMPTE :: Lens' SegmentDetection (Maybe Text)
segmentDetection_endTimestampMillis :: Lens' SegmentDetection (Maybe Integer)
segmentDetection_shotSegment :: Lens' SegmentDetection (Maybe ShotSegment)
segmentDetection_startFrameNumber :: Lens' SegmentDetection (Maybe Natural)
segmentDetection_startTimecodeSMPTE :: Lens' SegmentDetection (Maybe Text)
segmentDetection_startTimestampMillis :: Lens' SegmentDetection (Maybe Integer)
segmentDetection_technicalCueSegment :: Lens' SegmentDetection (Maybe TechnicalCueSegment)
segmentDetection_type :: Lens' SegmentDetection (Maybe SegmentType)

Documentation

data SegmentDetection Source #

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.

See: newSegmentDetection smart constructor.

Constructors

SegmentDetection'

Fields

durationFrames :: Maybe Natural
The duration of a video segment, expressed in frames.
durationMillis :: Maybe Natural
The duration of the detected segment in milliseconds.
durationSMPTE :: Maybe Text
The duration of the timecode for the detected segment in SMPTE format.
endFrameNumber :: Maybe Natural
The frame number at the end of a video segment, using a frame index that starts with 0.
endTimecodeSMPTE :: Maybe Text
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).
endTimestampMillis :: Maybe Integer
The end time of the detected segment, in milliseconds, from the start of the video. This value is rounded down.
shotSegment :: Maybe ShotSegment
If the segment is a shot detection, contains information about the shot detection.
startFrameNumber :: Maybe Natural
The frame number of the start of a video segment, using a frame index that starts with 0.
startTimecodeSMPTE :: Maybe Text
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).
startTimestampMillis :: Maybe Integer
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.
technicalCueSegment :: Maybe TechnicalCueSegment
If the segment is a technical cue, contains information about the technical cue.
type' :: Maybe SegmentType
The type of the segment. Valid values are TECHNICAL_CUE and SHOT.

Instances

Instances details

FromJSON SegmentDetection Source #
Instance details Defined in Amazonka.Rekognition.Types.SegmentDetection Methods parseJSON :: Value -> Parser SegmentDetection # parseJSONList :: Value -> Parser [SegmentDetection] #
Generic SegmentDetection Source #
Instance details Defined in Amazonka.Rekognition.Types.SegmentDetection Associated Types type Rep SegmentDetection :: Type -> Type # Methods from :: SegmentDetection -> Rep SegmentDetection x # to :: Rep SegmentDetection x -> SegmentDetection #
Read SegmentDetection Source #
Instance details Defined in Amazonka.Rekognition.Types.SegmentDetection Methods readsPrec :: Int -> ReadS SegmentDetection # readList :: ReadS [SegmentDetection] # readPrec :: ReadPrec SegmentDetection # readListPrec :: ReadPrec [SegmentDetection] #
Show SegmentDetection Source #
Instance details Defined in Amazonka.Rekognition.Types.SegmentDetection Methods showsPrec :: Int -> SegmentDetection -> ShowS # show :: SegmentDetection -> String # showList :: [SegmentDetection] -> ShowS #
NFData SegmentDetection Source #
Instance details Defined in Amazonka.Rekognition.Types.SegmentDetection Methods rnf :: SegmentDetection -> () #
Eq SegmentDetection Source #
Instance details Defined in Amazonka.Rekognition.Types.SegmentDetection Methods (==) :: SegmentDetection -> SegmentDetection -> Bool # (/=) :: SegmentDetection -> SegmentDetection -> Bool #
Hashable SegmentDetection Source #
Instance details Defined in Amazonka.Rekognition.Types.SegmentDetection Methods hashWithSalt :: Int -> SegmentDetection -> Int # hash :: SegmentDetection -> Int #
type Rep SegmentDetection Source #
Instance details Defined in Amazonka.Rekognition.Types.SegmentDetection type Rep SegmentDetection = D1 ('MetaData "SegmentDetection" "Amazonka.Rekognition.Types.SegmentDetection" "amazonka-rekognition-2.0-EaCrS9R3rWADqefEZvOx5B" 'False) (C1 ('MetaCons "SegmentDetection'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "durationFrames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "durationMillis") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "durationSMPTE") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "endFrameNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "endTimecodeSMPTE") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "endTimestampMillis") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))) :: ((S1 ('MetaSel ('Just "shotSegment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ShotSegment)) :: (S1 ('MetaSel ('Just "startFrameNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "startTimecodeSMPTE") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "startTimestampMillis") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: (S1 ('MetaSel ('Just "technicalCueSegment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TechnicalCueSegment)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SegmentType)))))))

newSegmentDetection :: SegmentDetection Source #

Create a value of SegmentDetection with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:durationFrames:SegmentDetection', segmentDetection_durationFrames - The duration of a video segment, expressed in frames.

$sel:durationMillis:SegmentDetection', segmentDetection_durationMillis - The duration of the detected segment in milliseconds.

$sel:durationSMPTE:SegmentDetection', segmentDetection_durationSMPTE - The duration of the timecode for the detected segment in SMPTE format.

$sel:endFrameNumber:SegmentDetection', segmentDetection_endFrameNumber - The frame number at the end of a video segment, using a frame index that starts with 0.

$sel:endTimecodeSMPTE:SegmentDetection', segmentDetection_endTimecodeSMPTE - 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).

$sel:endTimestampMillis:SegmentDetection', segmentDetection_endTimestampMillis - The end time of the detected segment, in milliseconds, from the start of the video. This value is rounded down.

$sel:shotSegment:SegmentDetection', segmentDetection_shotSegment - If the segment is a shot detection, contains information about the shot detection.

$sel:startFrameNumber:SegmentDetection', segmentDetection_startFrameNumber - The frame number of the start of a video segment, using a frame index that starts with 0.

$sel:startTimecodeSMPTE:SegmentDetection', segmentDetection_startTimecodeSMPTE - 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).

$sel:startTimestampMillis:SegmentDetection', segmentDetection_startTimestampMillis - 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.

$sel:technicalCueSegment:SegmentDetection', segmentDetection_technicalCueSegment - If the segment is a technical cue, contains information about the technical cue.

SegmentDetection, segmentDetection_type - The type of the segment. Valid values are TECHNICAL_CUE and SHOT.

segmentDetection_durationFrames :: Lens' SegmentDetection (Maybe Natural) Source #

The duration of a video segment, expressed in frames.

segmentDetection_durationMillis :: Lens' SegmentDetection (Maybe Natural) Source #

The duration of the detected segment in milliseconds.

segmentDetection_durationSMPTE :: Lens' SegmentDetection (Maybe Text) Source #

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

segmentDetection_endFrameNumber :: Lens' SegmentDetection (Maybe Natural) Source #

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

segmentDetection_endTimecodeSMPTE :: Lens' SegmentDetection (Maybe Text) Source #

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

segmentDetection_endTimestampMillis :: Lens' SegmentDetection (Maybe Integer) Source #

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

segmentDetection_shotSegment :: Lens' SegmentDetection (Maybe ShotSegment) Source #

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

segmentDetection_startFrameNumber :: Lens' SegmentDetection (Maybe Natural) Source #

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

segmentDetection_startTimecodeSMPTE :: Lens' SegmentDetection (Maybe Text) Source #

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

segmentDetection_startTimestampMillis :: Lens' SegmentDetection (Maybe Integer) Source #

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.

segmentDetection_technicalCueSegment :: Lens' SegmentDetection (Maybe TechnicalCueSegment) Source #

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

segmentDetection_type :: Lens' SegmentDetection (Maybe SegmentType) Source #

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