Amazonka.KinesisVideoArchivedMedia.Types.ClipTimestampRange

Documentation

data ClipTimestampRange

The range of timestamps for which to return fragments.

See: newClipTimestampRange smart constructor.

Constructors

ClipTimestampRange'

Fields

• startTimestamp :: POSIX

  The starting timestamp in the range of timestamps for which to return fragments.

  Only fragments that start exactly at or after StartTimestamp are included in the session. Fragments that start before StartTimestamp and continue past it aren't included in the session. If FragmentSelectorType is SERVER_TIMESTAMP, the StartTimestamp must be later than the stream head.

• endTimestamp :: POSIX

  The end of the timestamp range for the requested media.

  This value must be within 24 hours of the specified StartTimestamp, and it must be later than the StartTimestamp value. If FragmentSelectorType for the request is SERVER_TIMESTAMP, this value must be in the past.

  This value is inclusive. The EndTimestamp is compared to the (starting) timestamp of the fragment. Fragments that start before the EndTimestamp value and continue past it are included in the session.

Instances

ToJSON ClipTimestampRange

Defined in Amazonka.KinesisVideoArchivedMedia.Types.ClipTimestampRange

Methods

toJSON :: ClipTimestampRange -> Value

toEncoding :: ClipTimestampRange -> Encoding

toJSONList :: [ClipTimestampRange] -> Value

toEncodingList :: [ClipTimestampRange] -> Encoding

Generic ClipTimestampRange

Defined in Amazonka.KinesisVideoArchivedMedia.Types.ClipTimestampRange

Associated Types

type Rep ClipTimestampRange :: Type -> Type

Methods

from :: ClipTimestampRange -> Rep ClipTimestampRange x

to :: Rep ClipTimestampRange x -> ClipTimestampRange

Read ClipTimestampRange

Defined in Amazonka.KinesisVideoArchivedMedia.Types.ClipTimestampRange

Methods

readsPrec :: Int -> ReadS ClipTimestampRange

readList :: ReadS [ClipTimestampRange]

readPrec :: ReadPrec ClipTimestampRange

readListPrec :: ReadPrec [ClipTimestampRange]

Show ClipTimestampRange

Defined in Amazonka.KinesisVideoArchivedMedia.Types.ClipTimestampRange

Methods

showsPrec :: Int -> ClipTimestampRange -> ShowS

show :: ClipTimestampRange -> String

showList :: [ClipTimestampRange] -> ShowS

NFData ClipTimestampRange

Defined in Amazonka.KinesisVideoArchivedMedia.Types.ClipTimestampRange

Methods

rnf :: ClipTimestampRange -> ()

Eq ClipTimestampRange

Defined in Amazonka.KinesisVideoArchivedMedia.Types.ClipTimestampRange

Methods

(==) :: ClipTimestampRange -> ClipTimestampRange -> Bool

(/=) :: ClipTimestampRange -> ClipTimestampRange -> Bool

Hashable ClipTimestampRange

Defined in Amazonka.KinesisVideoArchivedMedia.Types.ClipTimestampRange

Methods

hashWithSalt :: Int -> ClipTimestampRange -> Int

hash :: ClipTimestampRange -> Int

type Rep ClipTimestampRange

Defined in Amazonka.KinesisVideoArchivedMedia.Types.ClipTimestampRange

type Rep ClipTimestampRange = D1 ('MetaData "ClipTimestampRange" "Amazonka.KinesisVideoArchivedMedia.Types.ClipTimestampRange" "amazonka-kinesis-video-archived-media-2.0-ByMPs2ZAQOi357CZJGqXlN" 'False) (C1 ('MetaCons "ClipTimestampRange'" 'PrefixI 'True) (S1 ('MetaSel ('Just "startTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "endTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)))

newClipTimestampRange

Arguments

:: UTCTime

$sel:startTimestamp:ClipTimestampRange'

-> UTCTime

$sel:endTimestamp:ClipTimestampRange'

-> ClipTimestampRange

Create a value of ClipTimestampRange 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:startTimestamp:ClipTimestampRange', clipTimestampRange_startTimestamp - The starting timestamp in the range of timestamps for which to return fragments.

Only fragments that start exactly at or after StartTimestamp are included in the session. Fragments that start before StartTimestamp and continue past it aren't included in the session. If FragmentSelectorType is SERVER_TIMESTAMP, the StartTimestamp must be later than the stream head.

$sel:endTimestamp:ClipTimestampRange', clipTimestampRange_endTimestamp - The end of the timestamp range for the requested media.

This value must be within 24 hours of the specified StartTimestamp, and it must be later than the StartTimestamp value. If FragmentSelectorType for the request is SERVER_TIMESTAMP, this value must be in the past.

This value is inclusive. The EndTimestamp is compared to the (starting) timestamp of the fragment. Fragments that start before the EndTimestamp value and continue past it are included in the session.

clipTimestampRange_startTimestamp :: Lens' ClipTimestampRange UTCTime

The starting timestamp in the range of timestamps for which to return fragments.

Only fragments that start exactly at or after StartTimestamp are included in the session. Fragments that start before StartTimestamp and continue past it aren't included in the session. If FragmentSelectorType is SERVER_TIMESTAMP, the StartTimestamp must be later than the stream head.

clipTimestampRange_endTimestamp :: Lens' ClipTimestampRange UTCTime

The end of the timestamp range for the requested media.

This value must be within 24 hours of the specified StartTimestamp, and it must be later than the StartTimestamp value. If FragmentSelectorType for the request is SERVER_TIMESTAMP, this value must be in the past.

This value is inclusive. The EndTimestamp is compared to the (starting) timestamp of the fragment. Fragments that start before the EndTimestamp value and continue past it are included in the session.