AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Implementation for accessing KinesisVideoMedia

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.KinesisVideoMedia.AmazonKinesisVideoMediaClient

Namespace: Amazon.KinesisVideoMedia
Assembly: AWSSDK.KinesisVideoMedia.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonKinesisVideoMediaClient : AmazonServiceClient
         IAmazonKinesisVideoMedia, IAmazonService, IDisposable

The AmazonKinesisVideoMediaClient type exposes the following members

Constructors

NameDescription
Public Method AmazonKinesisVideoMediaClient(string)

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.



    
        
    

             

Public Method AmazonKinesisVideoMediaClient(AmazonKinesisVideoMediaConfig)

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.



    
        
    

             

Public Method AmazonKinesisVideoMediaClient(string, AWSCredentials)

Constructs AmazonKinesisVideoMediaClient with AWS Credentials

Public Method AmazonKinesisVideoMediaClient(AWSCredentials, AmazonKinesisVideoMediaConfig)

Constructs AmazonKinesisVideoMediaClient with AWS Credentials and an AmazonKinesisVideoMediaClient Configuration object.

Public Method AmazonKinesisVideoMediaClient(string, string, string)

Constructs AmazonKinesisVideoMediaClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonKinesisVideoMediaClient(string, string, AmazonKinesisVideoMediaConfig)

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

Public Method AmazonKinesisVideoMediaClient(string, string, string, string)

Constructs AmazonKinesisVideoMediaClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonKinesisVideoMediaClient(string, string, string, AmazonKinesisVideoMediaConfig)

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

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method GetMedia(GetMediaRequest)

Use this API to retrieve media content from a Kinesis video stream. In the request, you identify 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 to which you can then send the GetMedia requests.

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.

Public Method GetMediaAsync(GetMediaRequest, CancellationToken)

Initiates the asynchronous execution of the GetMedia operation.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms