AWSSDK.KinesisVideoMedia

Implementation for accessing KinesisVideoMedia

Constructs AmazonKinesisVideoMediaClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.


             <?xml version="1.0" encoding="utf-8" ?>
             <configuration>
                 <appSettings>
                     <add key="AWSProfileName" value="AWS Default"/>
                 </appSettings>
             </configuration>

The URL of the search or document service.


             <?xml version="1.0" encoding="utf-8" ?>
             <configuration>
                 <appSettings>
                     <add key="AWSProfileName" value="AWS Default"/>
                 </appSettings>
             </configuration>

The AmazonKinesisVideoMediaClient Configuration Object

Constructs AmazonKinesisVideoMediaClient with AWS Credentials

The URL of the search or document service. AWS Credentials

Constructs AmazonKinesisVideoMediaClient with AWS Credentials and an AmazonKinesisVideoMediaClient Configuration object.

AWS Credentials The AmazonKinesisVideoMediaClient Configuration Object

Constructs AmazonKinesisVideoMediaClient with AWS Access Key ID and AWS Secret Key

AWS Access Key ID AWS Secret Access Key The URL of the search or document service.

Constructs AmazonKinesisVideoMediaClient with AWS Access Key ID, AWS Secret Key and an AmazonKinesisVideoMediaClient Configuration object.

AWS Access Key ID AWS Secret Access Key The AmazonKinesisVideoMediaClient Configuration Object

Constructs AmazonKinesisVideoMediaClient with AWS Access Key ID and AWS Secret Key

AWS Access Key ID AWS Secret Access Key AWS Session Token The URL of the search or document service.

Constructs AmazonKinesisVideoMediaClient with AWS Access Key ID, AWS Secret Key and an AmazonKinesisVideoMediaClient Configuration object.

AWS Access Key ID AWS Secret Access Key AWS Session Token The AmazonKinesisVideoMediaClient Configuration Object

Creates the signer for the service.

Capture metadata for the service.

Disposes the service client.

Use this API to retrieve media content from a Kinesis video stream. In the request, you identify the stream name or stream Amazon Resource Name (ARN), and the starting chunk. Kinesis Video Streams then returns a stream of chunks in order by fragment number. You must first call the GetDataEndpoint API to get an endpoint. Then send the GetMedia requests to this endpoint using the --endpoint-url parameter. When you put media data (fragments) on a stream, Kinesis Video Streams stores each incoming fragment and related metadata in what is called a "chunk." For more information, see . The GetMedia API returns a stream of these chunks starting from the chunk that you specify in the request. The following limits apply when using the GetMedia API:

A client can call GetMedia up to five times per second per stream.
Kinesis Video Streams sends media data at a rate of up to 25 megabytes per second (or 200 megabits per second) during a GetMedia session.

Container for the necessary parameters to execute the GetMedia service method. The response from the GetMedia service method, as returned by KinesisVideoMedia. Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later. Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client connections. The value for this input parameter is invalid. Status Code: 400, Caller used wrong endpoint to write data to a stream. On receiving such an exception, the user must call GetDataEndpoint with AccessMode set to "READ" and use the endpoint Kinesis Video returns in the next GetMedia call. Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token has expired. Status Code: 404, The stream with the given name does not exist. REST API Reference for GetMedia Operation

Initiates the asynchronous execution of the GetMedia operation.

Container for the necessary parameters to execute the GetMedia operation. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The task object representing the asynchronous operation. REST API Reference for GetMedia Operation

Configuration for accessing Amazon KinesisVideoMedia service

This method contains custom initializations for the config object.

Validate that the config object is properly configured.

Default constructor

The constant used to lookup in the region hash the endpoint.

Gets the ServiceVersion property.

Gets the value of UserAgent property.

Common exception for the KinesisVideoMedia service.

Construct instance of AmazonKinesisVideoMediaException

Constructs a new instance of the AmazonKinesisVideoMediaException class with serialized data.

The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is null. The class name is null or is zero (0).

Service metadata for Amazon KinesisVideoMedia service

Gets the value of the Service Id.

Gets the dictionary that gives mapping of renamed operations

Base class for KinesisVideoMedia operation requests.

KinesisVideoMedia exception

Constructs a new ClientLimitExceededException with the specified error message.

Describes the error encountered.

Construct instance of ClientLimitExceededException

Constructs a new instance of the ClientLimitExceededException class with serialized data.

KinesisVideoMedia exception

Constructs a new ConnectionLimitExceededException with the specified error message.

Describes the error encountered.

Construct instance of ConnectionLimitExceededException

Constructs a new instance of the ConnectionLimitExceededException class with serialized data.

Container for the parameters to the GetMedia operation. Use this API to retrieve media content from a Kinesis video stream. In the request, you identify the stream name or stream Amazon Resource Name (ARN), and the starting chunk. Kinesis Video Streams then returns a stream of chunks in order by fragment number. You must first call the GetDataEndpoint API to get an endpoint. Then send the GetMedia requests to this endpoint using the --endpoint-url parameter. When you put media data (fragments) on a stream, Kinesis Video Streams stores each incoming fragment and related metadata in what is called a "chunk." For more information, see . The GetMedia API returns a stream of these chunks starting from the chunk that you specify in the request. The following limits apply when using the GetMedia API:

A client can call GetMedia up to five times per second per stream.
Kinesis Video Streams sends media data at a rate of up to 25 megabytes per second (or 200 megabits per second) during a GetMedia session.

Gets and sets the property StartSelector. Identifies the starting chunk to get from the specified stream.

Gets and sets the property StreamARN. The ARN of the stream from where you want to get the media content. If you don't specify the streamARN, you must specify the streamName.

Gets and sets the property StreamName. The Kinesis video stream name from where you want to get the media content. If you don't specify the streamName, you must specify the streamARN.

This is the response object from the GetMedia operation.

Gets and sets the property ContentType. The content type of the requested media.

Gets and sets the property Payload. 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

GetMedia Request Marshaller

Marshaller the request object to the HTTP request.

Gets the singleton.

Response Unmarshaller for GetMedia operation

Unmarshaller the response from the service to the response class.

Unmarshaller error response to exception.

Overriden to return true indicating the response contains streaming data.

Gets the singleton.

StartSelector Marshaller

Unmarshaller the response from the service to the response class.

Singleton Marshaller.

KinesisVideoMedia exception

Constructs a new InvalidArgumentException with the specified error message.

Describes the error encountered.

Construct instance of InvalidArgumentException

Constructs a new instance of the InvalidArgumentException class with serialized data.

KinesisVideoMedia exception

Constructs a new InvalidEndpointException with the specified error message.

Describes the error encountered.

Construct instance of InvalidEndpointException

Constructs a new instance of the InvalidEndpointException class with serialized data.

KinesisVideoMedia exception

Constructs a new NotAuthorizedException with the specified error message.

Describes the error encountered.

Construct instance of NotAuthorizedException

Constructs a new instance of the NotAuthorizedException class with serialized data.

KinesisVideoMedia exception

Constructs a new ResourceNotFoundException with the specified error message.

Describes the error encountered.

Construct instance of ResourceNotFoundException

Constructs a new instance of the ResourceNotFoundException class with serialized data.

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 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.

Gets and sets the property AfterFragmentNumber. Specifies the fragment number from where you want the GetMedia API to start returning the fragments.

Gets and sets the property 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.

Gets and sets the property 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 timestamp. You specify the timestamp 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.

Gets and sets the property StartTimestamp. 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.

Constants used for properties of type StartSelectorType.

Constant CONTINUATION_TOKEN for StartSelectorType

Constant EARLIEST for StartSelectorType

Constant FRAGMENT_NUMBER for StartSelectorType

Constant NOW for StartSelectorType

Constant PRODUCER_TIMESTAMP for StartSelectorType

Constant SERVER_TIMESTAMP for StartSelectorType

This constant constructor does not need to be called if the constant you are attempting to use is already defined as a static instance of this class. This constructor should be used to construct constants that are not defined as statics, for instance if attempting to use a feature that is newer than the current version of the SDK.

Finds the constant for the unique value.

The unique value for the constant The constant for the unique value

Utility method to convert strings to the constant class.

The string value to convert to the constant class.

Interface for accessing KinesisVideoMedia

A client can call GetMedia up to five times per second per stream.
Kinesis Video Streams sends media data at a rate of up to 25 megabytes per second (or 200 megabits per second) during a GetMedia session.

Initiates the asynchronous execution of the GetMedia operation.