Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.KinesisVideoMedia.Types.StartSelector

Description

Documentation

data StartSelector Source #

Identifies the chunk on the Kinesis video stream where you want the GetMedia API to start returning media data. You have the following options to identify the starting chunk:

Choose the latest (or oldest) chunk.
Identify a specific chunk. You can identify a specific chunk either by providing a fragment number or timestamp (server or producer).
Each chunk's metadata includes a continuation token as a Matroska (MKV) tag (AWS_KINESISVIDEO_CONTINUATION_TOKEN). If your previous GetMedia request terminated, you can use this tag value in your next GetMedia request. The API then starts returning chunks starting where the last API ended.

See: newStartSelector smart constructor.

Constructors

StartSelector'

Fields

afterFragmentNumber :: Maybe Text
Specifies the fragment number from where you want the GetMedia API to start returning the fragments.
continuationToken :: Maybe Text
Continuation token that Kinesis Video Streams returned in the previous GetMedia response. The GetMedia API then starts with the chunk identified by the continuation token.
startTimestamp :: Maybe POSIX
A timestamp value. This value is required if you choose the PRODUCER_TIMESTAMP or the SERVER_TIMESTAMP as the startSelectorType. The GetMedia API then starts with the chunk containing the fragment that has the specified timestamp.
startSelectorType :: StartSelectorType
Identifies the fragment on the Kinesis video stream where you want to start getting the data from.
- NOW - Start with the latest chunk on the stream.
- EARLIEST - Start with earliest available chunk on the stream.
- FRAGMENT_NUMBER - Start with the chunk after a specific fragment. You must also specify the AfterFragmentNumber parameter.
- PRODUCER_TIMESTAMP or SERVER_TIMESTAMP - Start with the chunk containing a fragment with the specified producer or server timestamp. You specify the timestamp by adding StartTimestamp.
- CONTINUATION_TOKEN - Read using the specified continuation token.
If you choose the NOW, EARLIEST, or CONTINUATION_TOKEN as the startSelectorType, you don't provide any additional information in the startSelector.

Instances

Instances details

ToJSON StartSelector Source #
Instance details Defined in Amazonka.KinesisVideoMedia.Types.StartSelector Methods toJSON :: StartSelector -> Value # toEncoding :: StartSelector -> Encoding # toJSONList :: [StartSelector] -> Value # toEncodingList :: [StartSelector] -> Encoding #
Generic StartSelector Source #
Instance details Defined in Amazonka.KinesisVideoMedia.Types.StartSelector Associated Types type Rep StartSelector :: Type -> Type # Methods from :: StartSelector -> Rep StartSelector x # to :: Rep StartSelector x -> StartSelector #
Read StartSelector Source #
Instance details Defined in Amazonka.KinesisVideoMedia.Types.StartSelector Methods readsPrec :: Int -> ReadS StartSelector # readList :: ReadS [StartSelector] # readPrec :: ReadPrec StartSelector # readListPrec :: ReadPrec [StartSelector] #
Show StartSelector Source #
Instance details Defined in Amazonka.KinesisVideoMedia.Types.StartSelector Methods showsPrec :: Int -> StartSelector -> ShowS # show :: StartSelector -> String # showList :: [StartSelector] -> ShowS #
NFData StartSelector Source #
Instance details Defined in Amazonka.KinesisVideoMedia.Types.StartSelector Methods rnf :: StartSelector -> () #
Eq StartSelector Source #
Instance details Defined in Amazonka.KinesisVideoMedia.Types.StartSelector Methods (==) :: StartSelector -> StartSelector -> Bool # (/=) :: StartSelector -> StartSelector -> Bool #
Hashable StartSelector Source #
Instance details Defined in Amazonka.KinesisVideoMedia.Types.StartSelector Methods hashWithSalt :: Int -> StartSelector -> Int # hash :: StartSelector -> Int #
type Rep StartSelector Source #
Instance details Defined in Amazonka.KinesisVideoMedia.Types.StartSelector type Rep StartSelector = D1 ('MetaData "StartSelector" "Amazonka.KinesisVideoMedia.Types.StartSelector" "amazonka-kinesis-video-media-2.0-8H5b1pPJy7EDyfUB3Ys1cI" 'False) (C1 ('MetaCons "StartSelector'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "afterFragmentNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "continuationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "startTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "startSelectorType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 StartSelectorType))))

newStartSelector Source #

Arguments

:: StartSelectorType	`$sel:startSelectorType:StartSelector'`
-> StartSelector

Create a value of StartSelector 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:afterFragmentNumber:StartSelector', startSelector_afterFragmentNumber - Specifies the fragment number from where you want the GetMedia API to start returning the fragments.

$sel:continuationToken:StartSelector', startSelector_continuationToken - Continuation token that Kinesis Video Streams returned in the previous GetMedia response. The GetMedia API then starts with the chunk identified by the continuation token.

$sel:startTimestamp:StartSelector', startSelector_startTimestamp - A timestamp value. This value is required if you choose the PRODUCER_TIMESTAMP or the SERVER_TIMESTAMP as the startSelectorType. The GetMedia API then starts with the chunk containing the fragment that has the specified timestamp.

$sel:startSelectorType:StartSelector', startSelector_startSelectorType - Identifies the fragment on the Kinesis video stream where you want to start getting the data from.

NOW - Start with the latest chunk on the stream.
EARLIEST - Start with earliest available chunk on the stream.
FRAGMENT_NUMBER - Start with the chunk after a specific fragment. You must also specify the AfterFragmentNumber parameter.
PRODUCER_TIMESTAMP or SERVER_TIMESTAMP - Start with the chunk containing a fragment with the specified producer or server timestamp. You specify the timestamp by adding StartTimestamp.
CONTINUATION_TOKEN - Read using the specified continuation token.

If you choose the NOW, EARLIEST, or CONTINUATION_TOKEN as the startSelectorType, you don't provide any additional information in the startSelector.

startSelector_afterFragmentNumber :: Lens' StartSelector (Maybe Text) Source #

Specifies the fragment number from where you want the GetMedia API to start returning the fragments.

startSelector_continuationToken :: Lens' StartSelector (Maybe Text) Source #

Continuation token that Kinesis Video Streams returned in the previous GetMedia response. The GetMedia API then starts with the chunk identified by the continuation token.

startSelector_startTimestamp :: Lens' StartSelector (Maybe UTCTime) Source #

A timestamp value. This value is required if you choose the PRODUCER_TIMESTAMP or the SERVER_TIMESTAMP as the startSelectorType. The GetMedia API then starts with the chunk containing the fragment that has the specified timestamp.

startSelector_startSelectorType :: Lens' StartSelector StartSelectorType Source #

Identifies the fragment on the Kinesis video stream where you want to start getting the data from.

NOW - Start with the latest chunk on the stream.
EARLIEST - Start with earliest available chunk on the stream.
FRAGMENT_NUMBER - Start with the chunk after a specific fragment. You must also specify the AfterFragmentNumber parameter.
PRODUCER_TIMESTAMP or SERVER_TIMESTAMP - Start with the chunk containing a fragment with the specified producer or server timestamp. You specify the timestamp by adding StartTimestamp.
CONTINUATION_TOKEN - Read using the specified continuation token.

If you choose the NOW, EARLIEST, or CONTINUATION_TOKEN as the startSelectorType, you don't provide any additional information in the startSelector.