Class: Aws::KinesisVideoMedia::Types::StartSelector

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kinesisvideomedia/types.rb

Overview

Note:

When making an API call, you may pass StartSelector data as a hash:

{
  start_selector_type: "FRAGMENT_NUMBER", # required, accepts FRAGMENT_NUMBER, SERVER_TIMESTAMP, PRODUCER_TIMESTAMP, NOW, EARLIEST, CONTINUATION_TOKEN
  after_fragment_number: "FragmentNumberString",
  start_timestamp: Time.now,
  continuation_token: "ContinuationToken",
}

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.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#after_fragment_number ⇒ String

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

Returns:

  • (String) 


186
187
188
189
190
191
192
 
# File 'lib/aws-sdk-kinesisvideomedia/types.rb', line 186

class StartSelector < Struct.new(
  :start_selector_type,
  :after_fragment_number,
  :start_timestamp,
  :continuation_token)
  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.

Returns:

  • (String) 


186
187
188
189
190
191
192
 
# File 'lib/aws-sdk-kinesisvideomedia/types.rb', line 186

class StartSelector < Struct.new(
  :start_selector_type,
  :after_fragment_number,
  :start_timestamp,
  :continuation_token)
  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 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.

<note markdown=“1”> If you choose the NOW, EARLIEST, or CONTINUATION_TOKEN as the ‘startSelectorType`, you don’t provide any additional information in the ‘startSelector`.

</note>

Returns:

  • (String) 


186
187
188
189
190
191
192
 
# File 'lib/aws-sdk-kinesisvideomedia/types.rb', line 186

class StartSelector < Struct.new(
  :start_selector_type,
  :after_fragment_number,
  :start_timestamp,
  :continuation_token)
  include Aws::Structure
end

#start_timestamp ⇒ Time

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.

Returns:

  • (Time) 


186
187
188
189
190
191
192
 
# File 'lib/aws-sdk-kinesisvideomedia/types.rb', line 186

class StartSelector < Struct.new(
  :start_selector_type,
  :after_fragment_number,
  :start_timestamp,
  :continuation_token)
  include Aws::Structure
end