com.amazonaws.services.kinesisvideo

Interface AmazonKinesisVideoMedia

All Known Subinterfaces:

AmazonKinesisVideoMediaAsync

All Known Implementing Classes:

AbstractAmazonKinesisVideoMedia, AbstractAmazonKinesisVideoMediaAsync, AmazonKinesisVideoMediaAsyncClient, AmazonKinesisVideoMediaClient

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

Interface for accessing Kinesis Video Media.

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetMediaResult	getMedia(GetMediaRequest getMediaRequest) Use this API to retrieve media content from a Kinesis video stream.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

getMedia

GetMediaResult getMedia(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:

Result of the GetMedia operation returned by the service.

Throws:

ResourceNotFoundException - Status Code: 404, The stream with the given name does not exist.

NotAuthorizedException - Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token has expired.

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

ClientLimitExceededException - Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

ConnectionLimitExceededException - Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client connections.

InvalidArgumentException - The value for this input parameter is invalid.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.