Skip to content

StartSelector

Source code in docs_src/capo_kinesis_video_media/types/start_selector.py
class StartSelector(TypedDict, closed=True):
    start_selector_type: (
        "capo_kinesis_video_media.types.start_selector_type.StartSelectorType"
    )
    """<p>Identifies the fragment on the Kinesis video stream where you want to start getting the data from.</p> <ul> <li> <p>NOW - Start with the latest chunk on the stream.</p> </li> <li> <p>EARLIEST - Start with earliest available chunk on the stream.</p> </li> <li> <p>FRAGMENT_NUMBER - Start with the chunk after a specific fragment. You must also specify the <code>AfterFragmentNumber</code> parameter.</p> </li> <li> <p>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 <code>StartTimestamp</code>.</p> </li> <li> <p> CONTINUATION_TOKEN - Read using the specified continuation token. </p> </li> </ul> <note> <p>If you choose the NOW, EARLIEST, or CONTINUATION_TOKEN as the <code>startSelectorType</code>, you don't provide any additional information in the <code>startSelector</code>.</p> </note>"""
    after_fragment_number: NotRequired[
        "capo_kinesis_video_media.types.fragment_number_string.FragmentNumberString"
    ]
    """<p>Specifies the fragment number from where you want the <code>GetMedia</code> API to start returning the fragments. </p>"""
    start_timestamp: NotRequired["capo_kinesis_video_media.types.timestamp.Timestamp"]
    """<p>A timestamp value. This value is required if you choose the PRODUCER_TIMESTAMP or the SERVER_TIMESTAMP as the <code>startSelectorType</code>. The <code>GetMedia</code> API then starts with the chunk containing the fragment that has the specified timestamp.</p>"""
    continuation_token: NotRequired[
        "capo_kinesis_video_media.types.continuation_token.ContinuationToken"
    ]
    """<p>Continuation token that Kinesis Video Streams returned in the previous <code>GetMedia</code> response. The <code>GetMedia</code> API then starts with the chunk identified by the continuation token.</p>"""

after_fragment_number instance-attribute

after_fragment_number: NotRequired[FragmentNumberString]

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

continuation_token instance-attribute

continuation_token: NotRequired[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.

start_selector_type instance-attribute

start_selector_type: 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.

start_timestamp instance-attribute

start_timestamp: NotRequired[Timestamp]

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.