com.amazonaws.services.kinesisvideoarchivedmedia

Class AWSKinesisVideoArchivedMediaClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.kinesisvideoarchivedmedia.AWSKinesisVideoArchivedMediaClient

All Implemented Interfaces:

AWSKinesisVideoArchivedMedia

public class AWSKinesisVideoArchivedMediaClient
extends AmazonWebServiceClient
implements AWSKinesisVideoArchivedMedia

Client for accessing AWSKinesisVideoFrontend. All service calls made using this client are blocking, and will not return until the service call completes.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Constructor Summary

Constructors

Constructor and Description
AWSKinesisVideoArchivedMediaClient() Deprecated.
AWSKinesisVideoArchivedMediaClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AWSKinesisVideoArchivedMedia using the specified AWS account credentials.
AWSKinesisVideoArchivedMediaClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWSKinesisVideoArchivedMedia using the specified AWS account credentials and client configuration options.
AWSKinesisVideoArchivedMediaClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AWSKinesisVideoArchivedMedia using the specified AWS account credentials provider.
AWSKinesisVideoArchivedMediaClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWSKinesisVideoArchivedMedia using the specified AWS account credentials provider and client configuration options.
AWSKinesisVideoArchivedMediaClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, HttpClient httpClient) Constructs a new client to invoke service methods on AWSKinesisVideoArchivedMedia using the specified AWS account credentials provider, client configuration options and request metric collector.
AWSKinesisVideoArchivedMediaClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, com.amazonaws.metrics.RequestMetricCollector requestMetricCollector) Deprecated.
AWSKinesisVideoArchivedMediaClient(ClientConfiguration clientConfiguration) Deprecated.

Method Summary

Modifier and Type	Method and Description
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Deprecated. ResponseMetadata cache can hold up to 50 requests and responses in memory and will cause memory issue. This method now always returns null.
GetHLSStreamingSessionURLResult	getHLSStreamingSessionURL(GetHLSStreamingSessionURLRequest getHLSStreamingSessionURLRequest) Retrieves an HTTP Live Streaming (HLS) URL for the stream.
GetMediaForFragmentListResult	getMediaForFragmentList(GetMediaForFragmentListRequest getMediaForFragmentListRequest) Gets media for a list of fragments (specified by fragment number) from the archived data in an Amazon Kinesis video stream.
ListFragmentsResult	listFragments(ListFragmentsRequest listFragmentsRequest) Returns a list of Fragment objects from the specified stream and start location within the archived data.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, getEndpoint, getEndpointPrefix, getRegions, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, removeRequestHandler, removeRequestHandler, setConfiguration, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.kinesisvideoarchivedmedia.AWSKinesisVideoArchivedMedia

setEndpoint, setRegion, shutdown

Constructor Detail

AWSKinesisVideoArchivedMediaClient

@Deprecated
public AWSKinesisVideoArchivedMediaClient()

Deprecated.

Constructs a new client to invoke service methods on AWSKinesisVideoArchivedMedia. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AWSKinesisVideoArchivedMediaClient

@Deprecated
public AWSKinesisVideoArchivedMediaClient(ClientConfiguration clientConfiguration)

Deprecated.

Constructs a new client to invoke service methods on AWSKinesisVideoArchivedMedia. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AWSKinesisVideoArchivedMedia (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AWSKinesisVideoArchivedMediaClient

public AWSKinesisVideoArchivedMediaClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AWSKinesisVideoArchivedMedia using the specified AWS account credentials.

The client requests are authenticated using the AWSCredentials provided in this constructor. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AWSKinesisVideoArchivedMediaClient client = new AWSKinesisVideoArchivedMediaClient(AWSMobileClient.getInstance());
     }

     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AWSKinesisVideoArchivedMediaClient

public AWSKinesisVideoArchivedMediaClient(AWSCredentials awsCredentials,
                                          ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AWSKinesisVideoArchivedMedia using the specified AWS account credentials and client configuration options.

The client requests are authenticated using the AWSCredentials provided in this constructor. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AWSKinesisVideoArchivedMediaClient client = new AWSKinesisVideoArchivedMediaClient(AWSMobileClient.getInstance());
     }

     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWSKinesisVideoArchivedMedia (ex: proxy settings, retry counts, etc.).

AWSKinesisVideoArchivedMediaClient

public AWSKinesisVideoArchivedMediaClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AWSKinesisVideoArchivedMedia using the specified AWS account credentials provider.

The client requests are authenticated using the AWSCredentials provided in this constructor. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AWSKinesisVideoArchivedMediaClient client = new AWSKinesisVideoArchivedMediaClient(AWSMobileClient.getInstance());
     }

     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AWSKinesisVideoArchivedMediaClient

public AWSKinesisVideoArchivedMediaClient(AWSCredentialsProvider awsCredentialsProvider,
                                          ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AWSKinesisVideoArchivedMedia using the specified AWS account credentials provider and client configuration options.

The client requests are authenticated using the AWSCredentials provided in this constructor. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AWSKinesisVideoArchivedMediaClient client = new AWSKinesisVideoArchivedMediaClient(AWSMobileClient.getInstance());
     }

     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWSKinesisVideoArchivedMedia (ex: proxy settings, retry counts, etc.).

AWSKinesisVideoArchivedMediaClient

@Deprecated
public AWSKinesisVideoArchivedMediaClient(AWSCredentialsProvider awsCredentialsProvider,
                                                      ClientConfiguration clientConfiguration,
                                                      com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)

Deprecated.

Constructs a new client to invoke service methods on AWSKinesisVideoArchivedMedia using the specified AWS account credentials provider, client configuration options and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWSKinesisVideoArchivedMedia (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

AWSKinesisVideoArchivedMediaClient

public AWSKinesisVideoArchivedMediaClient(AWSCredentialsProvider awsCredentialsProvider,
                                          ClientConfiguration clientConfiguration,
                                          HttpClient httpClient)

Constructs a new client to invoke service methods on AWSKinesisVideoArchivedMedia using the specified AWS account credentials provider, client configuration options and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWSKinesisVideoArchivedMedia (ex: proxy settings, retry counts, etc.).

httpClient - A http client

Method Detail

getHLSStreamingSessionURL

public GetHLSStreamingSessionURLResult getHLSStreamingSessionURL(GetHLSStreamingSessionURLRequest getHLSStreamingSessionURLRequest)
                                                          throws AmazonServiceException,
                                                                 AmazonClientException

Retrieves an HTTP Live Streaming (HLS) URL for the stream. The URL can then be opened in a browser or media player to view the stream contents.

You must specify either the StreamName or the StreamARN.

An Amazon Kinesis video stream has the following requirements for providing data through HLS:

• The media type must be video/h264.

• Data retention must be greater than 0.

• The fragments must contain codec private data in the AVC (Advanced Video Coding) for H.264 format (MPEG-4 specification ISO/IEC 14496-15). For information about adapting stream data to a given format, see NAL Adaptation Flags.

Kinesis Video Streams HLS sessions contain fragments in the fragmented MPEG-4 form (also called fMP4 or CMAF), rather than the MPEG-2 form (also called TS chunks, which the HLS specification also supports). For more information about HLS fragment types, see the HLS specification.

The following procedure shows how to use HLS with Kinesis Video Streams:

1. Get an endpoint using GetDataEndpoint, specifying GET_HLS_STREAMING_SESSION_URL for the APIName parameter.

2. Retrieve the HLS URL using GetHLSStreamingSessionURL. Kinesis Video Streams creates an HLS streaming session to be used for accessing content in a stream using the HLS protocol. GetHLSStreamingSessionURL returns an authenticated URL (that includes an encrypted session token) for the session's HLS master playlist (the root resource needed for streaming with HLS).

   Don't share or store this token where an unauthorized entity could access it. The token provides access to the content of the stream. Safeguard the token with the same measures that you would use with your AWS credentials.

   The media that is made available through the playlist consists only of the requested stream, time range, and format. No other media data (such as frames outside the requested window or alternate bit rates) is made available.

3. Provide the URL (containing the encrypted session token) for the HLS master playlist to a media player that supports the HLS protocol. Kinesis Video Streams makes the HLS media playlist, initialization fragment, and media fragments available through the master playlist URL. The initialization fragment contains the codec private data for the stream, and other data needed to set up the video decoder and renderer. The media fragments contain H.264-encoded video frames and time stamps.

4. The media player receives the authenticated URL and requests stream metadata and media data normally. When the media player requests data, it calls the following actions:

   • GetHLSMasterPlaylist: Retrieves an HLS master playlist, which contains a URL for the GetHLSMediaPlaylist action, and additional metadata for the media player, including estimated bit rate and resolution.

   • GetHLSMediaPlaylist: Retrieves an HLS media playlist, which contains a URL to access the MP4 intitialization fragment with the GetMP4InitFragment action, and URLs to access the MP4 media fragments with the GetMP4MediaFragment actions. The HLS media playlist also contains metadata about the stream that the player needs to play it, such as whether the PlaybackMode is LIVE or ON_DEMAND. The HLS media playlist is typically static for sessions with a PlaybackType of ON_DEMAND. The HLS media playlist is continually updated with new fragments for sessions with a PlaybackType of LIVE.

   • GetMP4InitFragment: Retrieves the MP4 initialization fragment. The media player typically loads the initialization fragment before loading any media fragments. This fragment contains the "fytp" and " moov" MP4 atoms, and the child atoms that are needed to initialize the media player decoder.

     The initialization fragment does not correspond to a fragment in a Kinesis video stream. It contains only the codec private data for the stream, which the media player needs to decode video frames.

   • GetMP4MediaFragment: Retrieves MP4 media fragments. These fragments contain the "moof" and "mdat" MP4 atoms and their child atoms, containing the encoded fragment's video frames and their time stamps.

     After the first media fragment is made available in a streaming session, any fragments that don't contain the same codec private data are excluded in the HLS media playlist. Therefore, the codec private data does not change between fragments in a session.

The following restrictions apply to HLS sessions:

• A streaming session URL should not be shared between players. The service might throttle a session if multiple media players are sharing it. For connection limits, see Kinesis Video Streams Limits.

• A Kinesis video stream can have a maximum of five active HLS streaming sessions. If a new session is created when the maximum number of sessions is already active, the oldest (earliest created) session is closed. The number of active GetMedia connections on a Kinesis video stream does not count against this limit, and the number of active HLS sessions does not count against the active GetMedia connection limit.

You can monitor the amount of data that the media player consumes by monitoring the GetMP4MediaFragment.OutgoingBytes Amazon CloudWatch metric. For information about using CloudWatch to monitor Kinesis Video Streams, see Monitoring Kinesis Video Streams. For pricing information, see Amazon Kinesis Video Streams Pricing and AWS Pricing. Charges for both HLS sessions and outgoing AWS data apply.

For more information about HLS, see HTTP Live Streaming on the Apple Developer site.

Specified by:

getHLSStreamingSessionURL in interface AWSKinesisVideoArchivedMedia

Parameters:

getHLSStreamingSessionURLRequest -

Returns:

getHLSStreamingSessionURLResult The response from the GetHLSStreamingSessionURL service method, as returned by AWSKinesisVideoFrontend.

Throws:

ResourceNotFoundException

InvalidArgumentException

ClientLimitExceededException

NotAuthorizedException

UnsupportedStreamMediaTypeException

NoDataRetentionException

MissingCodecPrivateDataException

InvalidCodecPrivateDataException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKinesisVideoFrontend indicating either a problem with the data in the request, or a server side issue.

getMediaForFragmentList

public GetMediaForFragmentListResult getMediaForFragmentList(GetMediaForFragmentListRequest getMediaForFragmentListRequest)
                                                      throws AmazonServiceException,
                                                             AmazonClientException

Gets media for a list of fragments (specified by fragment number) from the archived data in an Amazon Kinesis video stream.

The following limits apply when using the GetMediaForFragmentList API:

• A client can call GetMediaForFragmentList 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 GetMediaForFragmentList session.

Specified by:

getMediaForFragmentList in interface AWSKinesisVideoArchivedMedia

Parameters:

getMediaForFragmentListRequest -

Returns:

getMediaForFragmentListResult The response from the GetMediaForFragmentList service method, as returned by AWSKinesisVideoFrontend.

Throws:

ResourceNotFoundException

InvalidArgumentException

ClientLimitExceededException

NotAuthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKinesisVideoFrontend indicating either a problem with the data in the request, or a server side issue.

listFragments

public ListFragmentsResult listFragments(ListFragmentsRequest listFragmentsRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

Returns a list of Fragment objects from the specified stream and start location within the archived data.

Specified by:

listFragments in interface AWSKinesisVideoArchivedMedia

Parameters:

listFragmentsRequest -

Returns:

listFragmentsResult The response from the ListFragments service method, as returned by AWSKinesisVideoFrontend.

Throws:

ResourceNotFoundException

InvalidArgumentException

ClientLimitExceededException

NotAuthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKinesisVideoFrontend indicating either a problem with the data in the request, or a server side issue.

getCachedResponseMetadata

@Deprecated
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Deprecated. ResponseMetadata cache can hold up to 50 requests and responses in memory and will cause memory issue. This method now always returns null.

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 the request.

Specified by:

getCachedResponseMetadata in interface AWSKinesisVideoArchivedMedia

Parameters:

request - The originally executed request

Returns:

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