Class: Aws::KinesisVideoMedia::Types::GetMediaOutput

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#content_type ⇒ String

The content type of the requested media.

Returns:

  • (String) 


128
129
130
131
132
133
 
# File 'lib/aws-sdk-kinesisvideomedia/types.rb', line 128

class GetMediaOutput < Struct.new(
  :content_type,
  :payload)
  SENSITIVE = []
  include Aws::Structure
end

#payload ⇒ IO

The payload Kinesis Video Streams returns is a sequence of chunks from the specified stream. For information about the chunks, see . The chunks that Kinesis Video Streams returns in the ‘GetMedia` call also include the following additional Matroska (MKV) tags:

  • AWS_KINESISVIDEO_CONTINUATION_TOKEN (UTF-8 string) - In the event your ‘GetMedia` call terminates, you can use this continuation token in your next request to get the next chunk where the last request terminated.

  • AWS_KINESISVIDEO_MILLIS_BEHIND_NOW (UTF-8 string) - Client applications can use this tag value to determine how far behind the chunk returned in the response is from the latest chunk on the stream.

  • AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the chunk.

  • AWS_KINESISVIDEO_SERVER_TIMESTAMP - Server timestamp of the fragment.

  • AWS_KINESISVIDEO_PRODUCER_TIMESTAMP - Producer timestamp of the fragment.

The following tags will be present if an error occurs:

  • AWS_KINESISVIDEO_ERROR_CODE - String description of an error that caused GetMedia to stop.

  • AWS_KINESISVIDEO_ERROR_ID: Integer code of the error.

The error codes are as follows:

  • 3002 - Error writing to the stream

  • 4000 - Requested fragment is not found

  • 4500 - Access denied for the stream’s KMS key

  • 4501 - Stream’s KMS key is disabled

  • 4502 - Validation error on the stream’s KMS key

  • 4503 - KMS key specified in the stream is unavailable

  • 4504 - Invalid usage of the KMS key specified in the stream

  • 4505 - Invalid state of the KMS key specified in the stream

  • 4506 - Unable to find the KMS key specified in the stream

  • 5000 - Internal error

Returns:

  • (IO) 


128
129
130
131
132
133
 
# File 'lib/aws-sdk-kinesisvideomedia/types.rb', line 128

class GetMediaOutput < Struct.new(
  :content_type,
  :payload)
  SENSITIVE = []
  include Aws::Structure
end