com.amazonaws.services.kinesisvideosignaling

Class AWSKinesisVideoSignalingClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.kinesisvideosignaling.AWSKinesisVideoSignalingClient

All Implemented Interfaces:

AWSKinesisVideoSignaling

public class AWSKinesisVideoSignalingClient
extends AmazonWebServiceClient
implements AWSKinesisVideoSignaling

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

Kinesis Video Streams Signaling Service is a intermediate service that establishes a communication channel for discovering peers, transmitting offers and answers in order to establish peer-to-peer connection in webRTC technology.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<com.amazonaws.transform.JsonErrorUnmarshaller>	jsonErrorUnmarshallers List of exception unmarshallers for all Amazon Kinesis Video Signaling exceptions.

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, endpointPrefix, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

Constructor and Description
AWSKinesisVideoSignalingClient() Deprecated.
AWSKinesisVideoSignalingClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AWSKinesisVideoSignaling using the specified AWS account credentials.
AWSKinesisVideoSignalingClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWSKinesisVideoSignaling using the specified AWS account credentials and client configuration options.
AWSKinesisVideoSignalingClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AWSKinesisVideoSignaling using the specified AWS account credentials provider.
AWSKinesisVideoSignalingClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWSKinesisVideoSignaling using the specified AWS account credentials provider and client configuration options.
AWSKinesisVideoSignalingClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, HttpClient httpClient) Constructs a new client to invoke service methods on AWSKinesisVideoSignaling using the specified AWS account credentials provider, client configuration options and request metric collector.
AWSKinesisVideoSignalingClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Deprecated.
AWSKinesisVideoSignalingClient(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.
GetIceServerConfigResult	getIceServerConfig(GetIceServerConfigRequest getIceServerConfigRequest) Gets the Interactive Connectivity Establishment (ICE) server configuration information, including URIs, username, and password which can be used to configure the WebRTC connection.
SendAlexaOfferToMasterResult	sendAlexaOfferToMaster(SendAlexaOfferToMasterRequest sendAlexaOfferToMasterRequest) This API allows you to connect WebRTC-enabled devices with Alexa display devices.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configSigner, configSigner, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpoint, getEndpointPrefix, getRegions, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffset

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.amazonaws.services.kinesisvideosignaling.AWSKinesisVideoSignaling

setEndpoint, setRegion, shutdown

Field Detail

jsonErrorUnmarshallers

protected List<com.amazonaws.transform.JsonErrorUnmarshaller> jsonErrorUnmarshallers

List of exception unmarshallers for all Amazon Kinesis Video Signaling exceptions.

Constructor Detail

AWSKinesisVideoSignalingClient

@Deprecated
public AWSKinesisVideoSignalingClient()

Deprecated.

Constructs a new client to invoke service methods on AWSKinesisVideoSignaling. 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

AWSKinesisVideoSignalingClient

@Deprecated
public AWSKinesisVideoSignalingClient(ClientConfiguration clientConfiguration)

Deprecated.

Constructs a new client to invoke service methods on AWSKinesisVideoSignaling. 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 AWSKinesisVideoSignaling (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AWSKinesisVideoSignalingClient

public AWSKinesisVideoSignalingClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AWSKinesisVideoSignaling 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) {
         AWSKinesisVideoSignalingClient client = new AWSKinesisVideoSignalingClient(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.

AWSKinesisVideoSignalingClient

public AWSKinesisVideoSignalingClient(AWSCredentials awsCredentials,
                                      ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AWSKinesisVideoSignaling 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) {
         AWSKinesisVideoSignalingClient client = new AWSKinesisVideoSignalingClient(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 AWSKinesisVideoSignaling (ex: proxy settings, retry counts, etc.).

AWSKinesisVideoSignalingClient

public AWSKinesisVideoSignalingClient(AWSCredentialsProvider awsCredentialsProvider)

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

The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. 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) {
         AWSKinesisVideoSignalingClient client = new AWSKinesisVideoSignalingClient(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.

AWSKinesisVideoSignalingClient

public AWSKinesisVideoSignalingClient(AWSCredentialsProvider awsCredentialsProvider,
                                      ClientConfiguration clientConfiguration)

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

The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. 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) {
         AWSKinesisVideoSignalingClient client = new AWSKinesisVideoSignalingClient(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 AWSKinesisVideoSignaling (ex: proxy settings, retry counts, etc.).

AWSKinesisVideoSignalingClient

@Deprecated
public AWSKinesisVideoSignalingClient(AWSCredentialsProvider awsCredentialsProvider,
                                                  ClientConfiguration clientConfiguration,
                                                  RequestMetricCollector requestMetricCollector)

Deprecated.

Constructs a new client to invoke service methods on AWSKinesisVideoSignaling 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 AWSKinesisVideoSignaling (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

AWSKinesisVideoSignalingClient

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

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

The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. 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) {
         AWSKinesisVideoSignalingClient client = new AWSKinesisVideoSignalingClient(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 AWSKinesisVideoSignaling (ex: proxy settings, retry counts, etc.).

httpClient - A http client

Method Detail

getIceServerConfig

public GetIceServerConfigResult getIceServerConfig(GetIceServerConfigRequest getIceServerConfigRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

Gets the Interactive Connectivity Establishment (ICE) server configuration information, including URIs, username, and password which can be used to configure the WebRTC connection. The ICE component uses this configuration information to setup the WebRTC connection, including authenticating with the Traversal Using Relays around NAT (TURN) relay server.

TURN is a protocol that is used to improve the connectivity of peer-to-peer applications. By providing a cloud-based relay service, TURN ensures that a connection can be established even when one or more peers are incapable of a direct peer-to-peer connection. For more information, see A REST API For Access To TURN Services.

You can invoke this API to establish a fallback mechanism in case either of the peers is unable to establish a direct peer-to-peer connection over a signaling channel. You must specify either a signaling channel ARN or the client ID in order to invoke this API.

Specified by:

getIceServerConfig in interface AWSKinesisVideoSignaling

Parameters:

getIceServerConfigRequest -

Returns:

getIceServerConfigResult The response from the GetIceServerConfig service method, as returned by Amazon Kinesis Video Signaling.

Throws:

InvalidClientException

SessionExpiredException

ClientLimitExceededException

ResourceNotFoundException

InvalidArgumentException

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 Amazon Kinesis Video Signaling indicating either a problem with the data in the request, or a server side issue.

sendAlexaOfferToMaster

public SendAlexaOfferToMasterResult sendAlexaOfferToMaster(SendAlexaOfferToMasterRequest sendAlexaOfferToMasterRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException

This API allows you to connect WebRTC-enabled devices with Alexa display devices. When invoked, it sends the Alexa Session Description Protocol (SDP) offer to the master peer. The offer is delivered as soon as the master is connected to the specified signaling channel. This API returns the SDP answer from the connected master. If the master is not connected to the signaling channel, redelivery requests are made until the message expires.

Specified by:

sendAlexaOfferToMaster in interface AWSKinesisVideoSignaling

Parameters:

sendAlexaOfferToMasterRequest -

Returns:

sendAlexaOfferToMasterResult The response from the SendAlexaOfferToMaster service method, as returned by Amazon Kinesis Video Signaling.

Throws:

ClientLimitExceededException

ResourceNotFoundException

InvalidArgumentException

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 Amazon Kinesis Video Signaling 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 AWSKinesisVideoSignaling

Parameters:

request - The originally executed request

Returns:

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