com.amazonaws.services.kinesisvideo

Interface AmazonKinesisVideoMediaAsync

All Superinterfaces:

AmazonKinesisVideoMedia

All Known Implementing Classes:

AbstractAmazonKinesisVideoMediaAsync, AmazonKinesisVideoMediaAsyncClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonKinesisVideoMediaAsync
extends AmazonKinesisVideoMedia

Interface for accessing Kinesis Video Media asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonKinesisVideoMediaAsync instead.

Field Summary

Fields inherited from interface com.amazonaws.services.kinesisvideo.AmazonKinesisVideoMedia

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
Future<GetMediaResult>	getMediaAsync(GetMediaRequest getMediaRequest) Use this API to retrieve media content from a Kinesis video stream.
Future<GetMediaResult>	getMediaAsync(GetMediaRequest getMediaRequest, AsyncHandler<GetMediaRequest,GetMediaResult> asyncHandler) Use this API to retrieve media content from a Kinesis video stream.

Methods inherited from interface com.amazonaws.services.kinesisvideo.AmazonKinesisVideoMedia

getCachedResponseMetadata, getMedia, shutdown

Method Detail

getMediaAsync

Future<GetMediaResult> getMediaAsync(GetMediaRequest 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.

Parameters:

getMediaRequest -

Returns:

A Java Future containing the result of the GetMedia operation returned by the service.

See Also:

AWS API Documentation

getMediaAsync

Future<GetMediaResult> getMediaAsync(GetMediaRequest getMediaRequest,
                                     AsyncHandler<GetMediaRequest,GetMediaResult> asyncHandler)

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.

Parameters:

getMediaRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetMedia operation returned by the service.

See Also:

AWS API Documentation