Amazonka.KinesisVideoArchivedMedia.Types.HLSTimestampRange

Documentation

data HLSTimestampRange

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

ToJSON HLSTimestampRange

Defined in Amazonka.KinesisVideoArchivedMedia.Types.HLSTimestampRange

Methods

toJSON :: HLSTimestampRange -> Value

toEncoding :: HLSTimestampRange -> Encoding

toJSONList :: [HLSTimestampRange] -> Value

toEncodingList :: [HLSTimestampRange] -> Encoding

Generic HLSTimestampRange

Defined in Amazonka.KinesisVideoArchivedMedia.Types.HLSTimestampRange

Associated Types

type Rep HLSTimestampRange :: Type -> Type

Methods

from :: HLSTimestampRange -> Rep HLSTimestampRange x

to :: Rep HLSTimestampRange x -> HLSTimestampRange

Read HLSTimestampRange

Defined in Amazonka.KinesisVideoArchivedMedia.Types.HLSTimestampRange

Methods

readsPrec :: Int -> ReadS HLSTimestampRange

readList :: ReadS [HLSTimestampRange]

readPrec :: ReadPrec HLSTimestampRange

readListPrec :: ReadPrec [HLSTimestampRange]

Show HLSTimestampRange

Defined in Amazonka.KinesisVideoArchivedMedia.Types.HLSTimestampRange

Methods

showsPrec :: Int -> HLSTimestampRange -> ShowS

show :: HLSTimestampRange -> String

showList :: [HLSTimestampRange] -> ShowS

NFData HLSTimestampRange

Defined in Amazonka.KinesisVideoArchivedMedia.Types.HLSTimestampRange

Methods

rnf :: HLSTimestampRange -> ()

Eq HLSTimestampRange

Defined in Amazonka.KinesisVideoArchivedMedia.Types.HLSTimestampRange

Methods

(==) :: HLSTimestampRange -> HLSTimestampRange -> Bool

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

Hashable HLSTimestampRange

Defined in Amazonka.KinesisVideoArchivedMedia.Types.HLSTimestampRange

Methods

hashWithSalt :: Int -> HLSTimestampRange -> Int

hash :: HLSTimestampRange -> Int

type Rep HLSTimestampRange

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

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)

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)

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.