/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.kinesisvideo; import javax.annotation.Generated; import com.amazonaws.services.kinesisvideo.model.*; /** * Interface for accessing Kinesis Video Media asynchronously. Each asynchronous method will return a Java Future object * representing the asynchronous operation; overloads which accept an {@code 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 * {@link com.amazonaws.services.kinesisvideo.AbstractAmazonKinesisVideoMediaAsync} instead. *

*

*

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

* 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 GetMedia * 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: *

* * *

* 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: *

* *

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

* * * @param getMediaRequest * @return A Java Future containing the result of the GetMedia operation returned by the service. * @sample AmazonKinesisVideoMediaAsync.GetMedia * @see AWS * API Documentation */ java.util.concurrent.Future getMediaAsync(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 GetMedia * 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: *

* * *

* 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: *

* *

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

* * * @param getMediaRequest * @param 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. * @return A Java Future containing the result of the GetMedia operation returned by the service. * @sample AmazonKinesisVideoMediaAsyncHandler.GetMedia * @see AWS * API Documentation */ java.util.concurrent.Future getMediaAsync(GetMediaRequest getMediaRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); }