Class: Aws::KinesisVideoMedia::Types::StartSelector
- Inherits:
-
Struct
- Object
- Struct
- Aws::KinesisVideoMedia::Types::StartSelector
- Defined in:
- gems/aws-sdk-kinesisvideomedia/lib/aws-sdk-kinesisvideomedia/types.rb
Overview
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 previousGetMedia
request terminated, you can use this tag value in your nextGetMedia
request. The API then starts returning chunks starting where the last API ended.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#after_fragment_number ⇒ String
Specifies the fragment number from where you want the
GetMedia
API to start returning the fragments. -
#continuation_token ⇒ String
Continuation token that Kinesis Video Streams returned in the previous
GetMedia
response. -
#start_selector_type ⇒ String
Identifies the fragment on the Kinesis video stream where you want to start getting the data from.
-
#start_timestamp ⇒ Time
A timestamp value.
Instance Attribute Details
#after_fragment_number ⇒ String
Specifies the fragment number from where you want the GetMedia
API
to start returning the fragments.
250 251 252 253 254 255 256 257 |
# File 'gems/aws-sdk-kinesisvideomedia/lib/aws-sdk-kinesisvideomedia/types.rb', line 250 class StartSelector < Struct.new( :start_selector_type, :after_fragment_number, :start_timestamp, :continuation_token) SENSITIVE = [] include Aws::Structure end |
#continuation_token ⇒ String
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.
250 251 252 253 254 255 256 257 |
# File 'gems/aws-sdk-kinesisvideomedia/lib/aws-sdk-kinesisvideomedia/types.rb', line 250 class StartSelector < Struct.new( :start_selector_type, :after_fragment_number, :start_timestamp, :continuation_token) SENSITIVE = [] include Aws::Structure end |
#start_selector_type ⇒ String
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.
startSelectorType
, you don't provide any additional information
in the startSelector
.
250 251 252 253 254 255 256 257 |
# File 'gems/aws-sdk-kinesisvideomedia/lib/aws-sdk-kinesisvideomedia/types.rb', line 250 class StartSelector < Struct.new( :start_selector_type, :after_fragment_number, :start_timestamp, :continuation_token) SENSITIVE = [] include Aws::Structure end |
#start_timestamp ⇒ Time
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.
250 251 252 253 254 255 256 257 |
# File 'gems/aws-sdk-kinesisvideomedia/lib/aws-sdk-kinesisvideomedia/types.rb', line 250 class StartSelector < Struct.new( :start_selector_type, :after_fragment_number, :start_timestamp, :continuation_token) SENSITIVE = [] include Aws::Structure end |