amazonka-kinesis-video-archived-media-2.0: Amazon Kinesis Video Streams Archived Media SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.KinesisVideoArchivedMedia.Types.HLSTimestampRange

Description

 
Synopsis

Documentation

data HLSTimestampRange Source #

The start and end of the timestamp range for the requested media.

This value should not be present if PlaybackType is LIVE.

See: newHLSTimestampRange smart constructor.

Constructors

HLSTimestampRange' 

Fields

  • endTimestamp :: Maybe 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.

    The EndTimestamp value is required for ON_DEMAND mode, but optional for LIVE_REPLAY mode. If the EndTimestamp is not set for LIVE_REPLAY mode then the session will continue to include newly ingested fragments until the session expires.

    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.

  • startTimestamp :: Maybe POSIX

    The start of the timestamp range for the requested media.

    If the HLSTimestampRange value is specified, the StartTimestamp value is required.

    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.

Instances

Instances details
ToJSON HLSTimestampRange Source # 
Instance details

Defined in Amazonka.KinesisVideoArchivedMedia.Types.HLSTimestampRange

Generic HLSTimestampRange Source # 
Instance details

Defined in Amazonka.KinesisVideoArchivedMedia.Types.HLSTimestampRange

Associated Types

type Rep HLSTimestampRange :: Type -> Type #

Read HLSTimestampRange Source # 
Instance details

Defined in Amazonka.KinesisVideoArchivedMedia.Types.HLSTimestampRange

Show HLSTimestampRange Source # 
Instance details

Defined in Amazonka.KinesisVideoArchivedMedia.Types.HLSTimestampRange

NFData HLSTimestampRange Source # 
Instance details

Defined in Amazonka.KinesisVideoArchivedMedia.Types.HLSTimestampRange

Methods

rnf :: HLSTimestampRange -> () #

Eq HLSTimestampRange Source # 
Instance details

Defined in Amazonka.KinesisVideoArchivedMedia.Types.HLSTimestampRange

Hashable HLSTimestampRange Source # 
Instance details

Defined in Amazonka.KinesisVideoArchivedMedia.Types.HLSTimestampRange

type Rep HLSTimestampRange Source # 
Instance details

Defined in Amazonka.KinesisVideoArchivedMedia.Types.HLSTimestampRange

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

newHLSTimestampRange :: HLSTimestampRange Source #

Create a value of HLSTimestampRange 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:endTimestamp:HLSTimestampRange', hLSTimestampRange_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.

The EndTimestamp value is required for ON_DEMAND mode, but optional for LIVE_REPLAY mode. If the EndTimestamp is not set for LIVE_REPLAY mode then the session will continue to include newly ingested fragments until the session expires.

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.

$sel:startTimestamp:HLSTimestampRange', hLSTimestampRange_startTimestamp - The start of the timestamp range for the requested media.

If the HLSTimestampRange value is specified, the StartTimestamp value is required.

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.

hLSTimestampRange_endTimestamp :: Lens' HLSTimestampRange (Maybe 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.

The EndTimestamp value is required for ON_DEMAND mode, but optional for LIVE_REPLAY mode. If the EndTimestamp is not set for LIVE_REPLAY mode then the session will continue to include newly ingested fragments until the session expires.

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.

hLSTimestampRange_startTimestamp :: Lens' HLSTimestampRange (Maybe UTCTime) Source #

The start of the timestamp range for the requested media.

If the HLSTimestampRange value is specified, the StartTimestamp value is required.

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.