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

Description

 
Synopsis

Documentation

data HLSFragmentSelector Source #

Contains the range of timestamps for the requested media, and the source of the timestamps.

See: newHLSFragmentSelector smart constructor.

Constructors

HLSFragmentSelector' 

Fields

  • fragmentSelectorType :: Maybe HLSFragmentSelectorType

    The source of the timestamps for the requested media.

    When FragmentSelectorType is set to PRODUCER_TIMESTAMP and GetHLSStreamingSessionURLInput$PlaybackMode is ON_DEMAND or LIVE_REPLAY, the first fragment ingested with a producer timestamp within the specified FragmentSelector$TimestampRange is included in the media playlist. In addition, the fragments with producer timestamps within the TimestampRange ingested immediately following the first fragment (up to the GetHLSStreamingSessionURLInput$MaxMediaPlaylistFragmentResults value) are included.

    Fragments that have duplicate producer timestamps are deduplicated. This means that if producers are producing a stream of fragments with producer timestamps that are approximately equal to the true clock time, the HLS media playlists will contain all of the fragments within the requested timestamp range. If some fragments are ingested within the same time range and very different points in time, only the oldest ingested collection of fragments are returned.

    When FragmentSelectorType is set to PRODUCER_TIMESTAMP and GetHLSStreamingSessionURLInput$PlaybackMode is LIVE, the producer timestamps are used in the MP4 fragments and for deduplication. But the most recently ingested fragments based on server timestamps are included in the HLS media playlist. This means that even if fragments ingested in the past have producer timestamps with values now, they are not included in the HLS media playlist.

    The default is SERVER_TIMESTAMP.

  • timestampRange :: Maybe HLSTimestampRange

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

    This value should not be present if PlaybackType is LIVE.

Instances

Instances details
Eq HLSFragmentSelector Source # 
Instance details

Defined in Amazonka.KinesisVideoArchivedMedia.Types.HLSFragmentSelector

Read HLSFragmentSelector Source # 
Instance details

Defined in Amazonka.KinesisVideoArchivedMedia.Types.HLSFragmentSelector

Show HLSFragmentSelector Source # 
Instance details

Defined in Amazonka.KinesisVideoArchivedMedia.Types.HLSFragmentSelector

Generic HLSFragmentSelector Source # 
Instance details

Defined in Amazonka.KinesisVideoArchivedMedia.Types.HLSFragmentSelector

Associated Types

type Rep HLSFragmentSelector :: Type -> Type #

NFData HLSFragmentSelector Source # 
Instance details

Defined in Amazonka.KinesisVideoArchivedMedia.Types.HLSFragmentSelector

Methods

rnf :: HLSFragmentSelector -> () #

Hashable HLSFragmentSelector Source # 
Instance details

Defined in Amazonka.KinesisVideoArchivedMedia.Types.HLSFragmentSelector

ToJSON HLSFragmentSelector Source # 
Instance details

Defined in Amazonka.KinesisVideoArchivedMedia.Types.HLSFragmentSelector

type Rep HLSFragmentSelector Source # 
Instance details

Defined in Amazonka.KinesisVideoArchivedMedia.Types.HLSFragmentSelector

type Rep HLSFragmentSelector = D1 ('MetaData "HLSFragmentSelector" "Amazonka.KinesisVideoArchivedMedia.Types.HLSFragmentSelector" "libZSservicesZSamazonka-kinesis-video-archived-mediaZSamazonka-kinesis-video-archived-media" 'False) (C1 ('MetaCons "HLSFragmentSelector'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fragmentSelectorType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HLSFragmentSelectorType)) :*: S1 ('MetaSel ('Just "timestampRange") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HLSTimestampRange))))

newHLSFragmentSelector :: HLSFragmentSelector Source #

Create a value of HLSFragmentSelector 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:fragmentSelectorType:HLSFragmentSelector', hLSFragmentSelector_fragmentSelectorType - The source of the timestamps for the requested media.

When FragmentSelectorType is set to PRODUCER_TIMESTAMP and GetHLSStreamingSessionURLInput$PlaybackMode is ON_DEMAND or LIVE_REPLAY, the first fragment ingested with a producer timestamp within the specified FragmentSelector$TimestampRange is included in the media playlist. In addition, the fragments with producer timestamps within the TimestampRange ingested immediately following the first fragment (up to the GetHLSStreamingSessionURLInput$MaxMediaPlaylistFragmentResults value) are included.

Fragments that have duplicate producer timestamps are deduplicated. This means that if producers are producing a stream of fragments with producer timestamps that are approximately equal to the true clock time, the HLS media playlists will contain all of the fragments within the requested timestamp range. If some fragments are ingested within the same time range and very different points in time, only the oldest ingested collection of fragments are returned.

When FragmentSelectorType is set to PRODUCER_TIMESTAMP and GetHLSStreamingSessionURLInput$PlaybackMode is LIVE, the producer timestamps are used in the MP4 fragments and for deduplication. But the most recently ingested fragments based on server timestamps are included in the HLS media playlist. This means that even if fragments ingested in the past have producer timestamps with values now, they are not included in the HLS media playlist.

The default is SERVER_TIMESTAMP.

$sel:timestampRange:HLSFragmentSelector', hLSFragmentSelector_timestampRange - The start and end of the timestamp range for the requested media.

This value should not be present if PlaybackType is LIVE.

hLSFragmentSelector_fragmentSelectorType :: Lens' HLSFragmentSelector (Maybe HLSFragmentSelectorType) Source #

The source of the timestamps for the requested media.

When FragmentSelectorType is set to PRODUCER_TIMESTAMP and GetHLSStreamingSessionURLInput$PlaybackMode is ON_DEMAND or LIVE_REPLAY, the first fragment ingested with a producer timestamp within the specified FragmentSelector$TimestampRange is included in the media playlist. In addition, the fragments with producer timestamps within the TimestampRange ingested immediately following the first fragment (up to the GetHLSStreamingSessionURLInput$MaxMediaPlaylistFragmentResults value) are included.

Fragments that have duplicate producer timestamps are deduplicated. This means that if producers are producing a stream of fragments with producer timestamps that are approximately equal to the true clock time, the HLS media playlists will contain all of the fragments within the requested timestamp range. If some fragments are ingested within the same time range and very different points in time, only the oldest ingested collection of fragments are returned.

When FragmentSelectorType is set to PRODUCER_TIMESTAMP and GetHLSStreamingSessionURLInput$PlaybackMode is LIVE, the producer timestamps are used in the MP4 fragments and for deduplication. But the most recently ingested fragments based on server timestamps are included in the HLS media playlist. This means that even if fragments ingested in the past have producer timestamps with values now, they are not included in the HLS media playlist.

The default is SERVER_TIMESTAMP.

hLSFragmentSelector_timestampRange :: Lens' HLSFragmentSelector (Maybe HLSTimestampRange) Source #

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

This value should not be present if PlaybackType is LIVE.