libZSservicesZSamazonka-kinesis-video-archived-mediaZSamazonka-kinesis-video-archived-media
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.KinesisVideoArchivedMedia.Types.ClipTimestampRange

Description

 
Synopsis

Documentation

data ClipTimestampRange Source #

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

Instances details
Eq ClipTimestampRange Source # 
Instance details

Defined in Amazonka.KinesisVideoArchivedMedia.Types.ClipTimestampRange

Read ClipTimestampRange Source # 
Instance details

Defined in Amazonka.KinesisVideoArchivedMedia.Types.ClipTimestampRange

Show ClipTimestampRange Source # 
Instance details

Defined in Amazonka.KinesisVideoArchivedMedia.Types.ClipTimestampRange

Generic ClipTimestampRange Source # 
Instance details

Defined in Amazonka.KinesisVideoArchivedMedia.Types.ClipTimestampRange

Associated Types

type Rep ClipTimestampRange :: Type -> Type #

NFData ClipTimestampRange Source # 
Instance details

Defined in Amazonka.KinesisVideoArchivedMedia.Types.ClipTimestampRange

Methods

rnf :: ClipTimestampRange -> () #

Hashable ClipTimestampRange Source # 
Instance details

Defined in Amazonka.KinesisVideoArchivedMedia.Types.ClipTimestampRange

ToJSON ClipTimestampRange Source # 
Instance details

Defined in Amazonka.KinesisVideoArchivedMedia.Types.ClipTimestampRange

type Rep ClipTimestampRange Source # 
Instance details

Defined in Amazonka.KinesisVideoArchivedMedia.Types.ClipTimestampRange

type Rep ClipTimestampRange = D1 ('MetaData "ClipTimestampRange" "Amazonka.KinesisVideoArchivedMedia.Types.ClipTimestampRange" "libZSservicesZSamazonka-kinesis-video-archived-mediaZSamazonka-kinesis-video-archived-media" '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 Source #

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 Source #

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 Source #

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.