You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#content_typeString

The content type of the requested media.

Returns:

  • (String)


111
112
113
114
115
# File 'gems/aws-sdk-kinesisvideomedia/lib/aws-sdk-kinesisvideomedia/types.rb', line 111

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

#payloadIO

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 time stamp of the fragment.

  • AWS_KINESISVIDEO_PRODUCER_TIMESTAMP - Producer time stamp 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)


111
112
113
114
115
# File 'gems/aws-sdk-kinesisvideomedia/lib/aws-sdk-kinesisvideomedia/types.rb', line 111

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