@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonKinesisVideoMedia
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
|Modifier and Type||Field and Description|
The region metadata service name for computing region endpoints.
|Modifier and Type||Method and Description|
Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
Use this API to retrieve media content from a Kinesis video stream.
Shuts down this client object, releasing any resources that might be held open.
GetMediaResult getMedia(GetMediaRequest getMediaRequest)
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
requests to this endpoint using the --endpoint-url
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 PutMedia. The
GetMedia API returns a stream of these chunks starting from the chunk that you specify in the
The following limits apply when using the
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)
If an error is thrown after invoking a Kinesis Video Streams media API, in addition to the HTTP status code and the response body, it includes the following pieces of information:
x-amz-ErrorType HTTP header – contains a more specific error type in addition to what the HTTP
status code provides.
x-amz-RequestId HTTP header – if you want to report an issue to AWS, the support team can better
diagnose the problem if given the Request Id.
Both the HTTP status code and the ErrorType header can be utilized to make programmatic decisions about whether errors are retry-able and under what conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again.
For more information, see the Errors section at the bottom of this topic, as well as Common Errors.
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
AccessModeset to "READ" and use the endpoint Kinesis Video returns in the next
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.
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request- The originally executed request.