@Generated(value="software.amazon.awssdk:codegen") public final class StartSelector extends Object implements SdkPojo, Serializable, ToCopyableBuilder<StartSelector.Builder,StartSelector>
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 time stamp (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.
Modifier and Type | Class and Description |
---|---|
static interface |
StartSelector.Builder |
Modifier and Type | Method and Description |
---|---|
String |
afterFragmentNumber()
Specifies the fragment number from where you want the
GetMedia API to start returning the fragments. |
static StartSelector.Builder |
builder() |
String |
continuationToken()
Continuation token that Kinesis Video Streams returned in the previous
GetMedia response. |
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
List<SdkField<?>> |
sdkFields() |
static Class<? extends StartSelector.Builder> |
serializableBuilderClass() |
StartSelectorType |
startSelectorType()
Identifies the fragment on the Kinesis video stream where you want to start getting the data from.
|
String |
startSelectorTypeAsString()
Identifies the fragment on the Kinesis video stream where you want to start getting the data from.
|
Instant |
startTimestamp()
A time stamp value.
|
StartSelector.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
copy
public 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 containing the specific fragment. You must also specify the
StartFragmentNumber
.
PRODUCER_TIMESTAMP or SERVER_TIMESTAMP - Start with the chunk containing a fragment with the specified producer
or server time stamp. You specify the time stamp 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
.
If the service returns an enum value that is not available in the current SDK version, startSelectorType
will return StartSelectorType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from startSelectorTypeAsString()
.
NOW - Start with the latest chunk on the stream.
EARLIEST - Start with earliest available chunk on the stream.
FRAGMENT_NUMBER - Start with the chunk containing the specific fragment. You must also specify the
StartFragmentNumber
.
PRODUCER_TIMESTAMP or SERVER_TIMESTAMP - Start with the chunk containing a fragment with the specified
producer or server time stamp. You specify the time stamp 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
.
StartSelectorType
public String startSelectorTypeAsString()
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 containing the specific fragment. You must also specify the
StartFragmentNumber
.
PRODUCER_TIMESTAMP or SERVER_TIMESTAMP - Start with the chunk containing a fragment with the specified producer
or server time stamp. You specify the time stamp 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
.
If the service returns an enum value that is not available in the current SDK version, startSelectorType
will return StartSelectorType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from startSelectorTypeAsString()
.
NOW - Start with the latest chunk on the stream.
EARLIEST - Start with earliest available chunk on the stream.
FRAGMENT_NUMBER - Start with the chunk containing the specific fragment. You must also specify the
StartFragmentNumber
.
PRODUCER_TIMESTAMP or SERVER_TIMESTAMP - Start with the chunk containing a fragment with the specified
producer or server time stamp. You specify the time stamp 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
.
StartSelectorType
public String afterFragmentNumber()
Specifies the fragment number from where you want the GetMedia
API to start returning the fragments.
GetMedia
API to start returning the
fragments.public Instant startTimestamp()
A time stamp 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 time stamp.
startSelectorType
. The GetMedia
API then starts with the chunk
containing the fragment that has the specified time stamp.public String 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.
GetMedia
response.
The GetMedia
API then starts with the chunk identified by the continuation token.public StartSelector.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<StartSelector.Builder,StartSelector>
public static StartSelector.Builder builder()
public static Class<? extends StartSelector.Builder> serializableBuilderClass()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.