Interface KinesisVideoMediaClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aKinesisVideoMediaClient
.static KinesisVideoMediaClient
create()
Create aKinesisVideoMediaClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default ResponseInputStream
<GetMediaResponse> getMedia
(Consumer<GetMediaRequest.Builder> getMediaRequest) Use this API to retrieve media content from a Kinesis video stream.default GetMediaResponse
getMedia
(Consumer<GetMediaRequest.Builder> getMediaRequest, Path destinationPath) Use this API to retrieve media content from a Kinesis video stream.default <ReturnT> ReturnT
getMedia
(Consumer<GetMediaRequest.Builder> getMediaRequest, ResponseTransformer<GetMediaResponse, ReturnT> responseTransformer) Use this API to retrieve media content from a Kinesis video stream.default ResponseInputStream
<GetMediaResponse> getMedia
(GetMediaRequest getMediaRequest) Use this API to retrieve media content from a Kinesis video stream.default GetMediaResponse
getMedia
(GetMediaRequest getMediaRequest, Path destinationPath) Use this API to retrieve media content from a Kinesis video stream.default <ReturnT> ReturnT
getMedia
(GetMediaRequest getMediaRequest, ResponseTransformer<GetMediaResponse, ReturnT> responseTransformer) Use this API to retrieve media content from a Kinesis video stream.default ResponseBytes
<GetMediaResponse> getMediaAsBytes
(Consumer<GetMediaRequest.Builder> getMediaRequest) Use this API to retrieve media content from a Kinesis video stream.default ResponseBytes
<GetMediaResponse> getMediaAsBytes
(GetMediaRequest getMediaRequest) Use this API to retrieve media content from a Kinesis video stream.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
getMedia
default <ReturnT> ReturnT getMedia(GetMediaRequest getMediaRequest, ResponseTransformer<GetMediaResponse, ReturnT> responseTransformer) throws ResourceNotFoundException, NotAuthorizedException, InvalidEndpointException, ClientLimitExceededException, ConnectionLimitExceededException, InvalidArgumentException, AwsServiceException, SdkClientException, KinesisVideoMediaExceptionUse 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 theGetMedia
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 PutMedia. 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.
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.
- Parameters:
getMediaRequest
-responseTransformer
- Functional interface for processing the streamed response content. The unmarshalled GetMediaResponse and an InputStream to the response content are provided as parameters to the callback. The callback may return a transformed type which will be the return value of this method. SeeResponseTransformer
for details on implementing this interface and for links to pre-canned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows '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
-
- Returns:
- The transformed result of the ResponseTransformer.
- See Also:
-
-
getMedia
default <ReturnT> ReturnT getMedia(Consumer<GetMediaRequest.Builder> getMediaRequest, ResponseTransformer<GetMediaResponse, ReturnT> responseTransformer) throws ResourceNotFoundException, NotAuthorizedException, InvalidEndpointException, ClientLimitExceededException, ConnectionLimitExceededException, InvalidArgumentException, AwsServiceException, SdkClientException, KinesisVideoMediaExceptionUse 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 theGetMedia
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 PutMedia. 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.
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.
This is a convenience which creates an instance of the
GetMediaRequest.Builder
avoiding the need to create one manually viaGetMediaRequest.builder()
- Parameters:
getMediaRequest
- AConsumer
that will call methods onGetMediaRequest.Builder
to create a request.responseTransformer
- Functional interface for processing the streamed response content. The unmarshalled GetMediaResponse and an InputStream to the response content are provided as parameters to the callback. The callback may return a transformed type which will be the return value of this method. SeeResponseTransformer
for details on implementing this interface and for links to pre-canned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows '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
-
- Returns:
- The transformed result of the ResponseTransformer.
- See Also:
-
-
getMedia
default GetMediaResponse getMedia(GetMediaRequest getMediaRequest, Path destinationPath) throws ResourceNotFoundException, NotAuthorizedException, InvalidEndpointException, ClientLimitExceededException, ConnectionLimitExceededException, InvalidArgumentException, AwsServiceException, SdkClientException, KinesisVideoMediaException 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 theGetMedia
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 PutMedia. 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.
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.
- Parameters:
getMediaRequest
-destinationPath
-Path
to file that response contents will be written to. The file must not exist or this method will throw an exception. If the file is not writable by the current user then an exception will be thrown. The service documentation for the response content is as follows '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
-
- Returns:
- The transformed result of the ResponseTransformer.
- See Also:
-
-
getMedia
default GetMediaResponse getMedia(Consumer<GetMediaRequest.Builder> getMediaRequest, Path destinationPath) throws ResourceNotFoundException, NotAuthorizedException, InvalidEndpointException, ClientLimitExceededException, ConnectionLimitExceededException, InvalidArgumentException, AwsServiceException, SdkClientException, KinesisVideoMediaException 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 theGetMedia
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 PutMedia. 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.
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.
This is a convenience which creates an instance of the
GetMediaRequest.Builder
avoiding the need to create one manually viaGetMediaRequest.builder()
- Parameters:
getMediaRequest
- AConsumer
that will call methods onGetMediaRequest.Builder
to create a request.destinationPath
-Path
to file that response contents will be written to. The file must not exist or this method will throw an exception. If the file is not writable by the current user then an exception will be thrown. The service documentation for the response content is as follows '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
-
- Returns:
- The transformed result of the ResponseTransformer.
- See Also:
-
-
getMedia
default ResponseInputStream<GetMediaResponse> getMedia(GetMediaRequest getMediaRequest) throws ResourceNotFoundException, NotAuthorizedException, InvalidEndpointException, ClientLimitExceededException, ConnectionLimitExceededException, InvalidArgumentException, AwsServiceException, SdkClientException, KinesisVideoMediaException 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 theGetMedia
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 PutMedia. 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.
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.
- Parameters:
getMediaRequest
-- Returns:
- A
ResponseInputStream
containing data streamed from service. Note that this is an unmanaged reference to the underlying HTTP connection so great care must be taken to ensure all data if fully read from the input stream and that it is properly closed. Failure to do so may result in sub-optimal behavior and exhausting connections in the connection pool. The unmarshalled response object can be obtained viaResponseInputStream.response()
. The service documentation for the response content is as follows '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
-
- See Also:
-
-
getMedia
default ResponseInputStream<GetMediaResponse> getMedia(Consumer<GetMediaRequest.Builder> getMediaRequest) throws ResourceNotFoundException, NotAuthorizedException, InvalidEndpointException, ClientLimitExceededException, ConnectionLimitExceededException, InvalidArgumentException, AwsServiceException, SdkClientException, KinesisVideoMediaException 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 theGetMedia
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 PutMedia. 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.
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.
This is a convenience which creates an instance of the
GetMediaRequest.Builder
avoiding the need to create one manually viaGetMediaRequest.builder()
- Parameters:
getMediaRequest
- AConsumer
that will call methods onGetMediaRequest.Builder
to create a request.- Returns:
- A
ResponseInputStream
containing data streamed from service. Note that this is an unmanaged reference to the underlying HTTP connection so great care must be taken to ensure all data if fully read from the input stream and that it is properly closed. Failure to do so may result in sub-optimal behavior and exhausting connections in the connection pool. The unmarshalled response object can be obtained viaResponseInputStream.response()
. The service documentation for the response content is as follows '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
-
- See Also:
-
-
getMediaAsBytes
default ResponseBytes<GetMediaResponse> getMediaAsBytes(GetMediaRequest getMediaRequest) throws ResourceNotFoundException, NotAuthorizedException, InvalidEndpointException, ClientLimitExceededException, ConnectionLimitExceededException, InvalidArgumentException, AwsServiceException, SdkClientException, KinesisVideoMediaException 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 theGetMedia
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 PutMedia. 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.
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.
- Parameters:
getMediaRequest
-- Returns:
- A
ResponseBytes
that loads the data streamed from the service into memory and exposes it in convenient in-memory representations like a byte buffer or string. The unmarshalled response object can be obtained viaResponseBytes.response()
. The service documentation for the response content is as follows '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
-
- See Also:
-
-
getMediaAsBytes
default ResponseBytes<GetMediaResponse> getMediaAsBytes(Consumer<GetMediaRequest.Builder> getMediaRequest) throws ResourceNotFoundException, NotAuthorizedException, InvalidEndpointException, ClientLimitExceededException, ConnectionLimitExceededException, InvalidArgumentException, AwsServiceException, SdkClientException, KinesisVideoMediaException 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 theGetMedia
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 PutMedia. 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.
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.
This is a convenience which creates an instance of the
GetMediaRequest.Builder
avoiding the need to create one manually viaGetMediaRequest.builder()
- Parameters:
getMediaRequest
- AConsumer
that will call methods onGetMediaRequest.Builder
to create a request.- Returns:
- A
ResponseBytes
that loads the data streamed from the service into memory and exposes it in convenient in-memory representations like a byte buffer or string. The unmarshalled response object can be obtained viaResponseBytes.response()
. The service documentation for the response content is as follows '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
-
- See Also:
-
-
create
Create aKinesisVideoMediaClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aKinesisVideoMediaClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-