com.amazonaws.services.kinesisvideosignalingchannels

Class AmazonKinesisVideoSignalingChannelsAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.kinesisvideosignalingchannels.AmazonKinesisVideoSignalingChannelsClient

com.amazonaws.services.kinesisvideosignalingchannels.AmazonKinesisVideoSignalingChannelsAsyncClient

All Implemented Interfaces:

AmazonKinesisVideoSignalingChannels, AmazonKinesisVideoSignalingChannelsAsync

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonKinesisVideoSignalingChannelsAsyncClient
extends AmazonKinesisVideoSignalingChannelsClient
implements AmazonKinesisVideoSignalingChannelsAsync

Client for accessing Amazon Kinesis Video Signaling Channels asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation 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 inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.kinesisvideosignalingchannels.AmazonKinesisVideoSignalingChannels

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonKinesisVideoSignalingChannelsAsyncClientBuilder	asyncBuilder()
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<GetIceServerConfigResult>	getIceServerConfigAsync(GetIceServerConfigRequest request) Gets the Interactive Connectivity Establishment (ICE) server configuration information, including URIs, username, and password which can be used to configure the WebRTC connection.
Future<GetIceServerConfigResult>	getIceServerConfigAsync(GetIceServerConfigRequest request, AsyncHandler<GetIceServerConfigRequest,GetIceServerConfigResult> asyncHandler) Gets the Interactive Connectivity Establishment (ICE) server configuration information, including URIs, username, and password which can be used to configure the WebRTC connection.
Future<SendAlexaOfferToMasterResult>	sendAlexaOfferToMasterAsync(SendAlexaOfferToMasterRequest request) This API allows you to connect WebRTC-enabled devices with Alexa display devices.
Future<SendAlexaOfferToMasterResult>	sendAlexaOfferToMasterAsync(SendAlexaOfferToMasterRequest request, AsyncHandler<SendAlexaOfferToMasterRequest,SendAlexaOfferToMasterResult> asyncHandler) This API allows you to connect WebRTC-enabled devices with Alexa display devices.
void	shutdown() Shuts down the client, releasing all managed resources.

Methods inherited from class com.amazonaws.services.kinesisvideosignalingchannels.AmazonKinesisVideoSignalingChannelsClient

builder, getCachedResponseMetadata, getIceServerConfig, sendAlexaOfferToMaster

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.amazonaws.services.kinesisvideosignalingchannels.AmazonKinesisVideoSignalingChannels

getCachedResponseMetadata, getIceServerConfig, sendAlexaOfferToMaster

Method Detail

asyncBuilder

public static AmazonKinesisVideoSignalingChannelsAsyncClientBuilder asyncBuilder()

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this client to execute async requests.

Returns:

The executor service used by this client to execute async requests.

getIceServerConfigAsync

public Future<GetIceServerConfigResult> getIceServerConfigAsync(GetIceServerConfigRequest request)

Description copied from interface: AmazonKinesisVideoSignalingChannelsAsync

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:

getIceServerConfigAsync in interface AmazonKinesisVideoSignalingChannelsAsync

Returns:

A Java Future containing the result of the GetIceServerConfig operation returned by the service.

See Also:

AWS API Documentation

getIceServerConfigAsync

public Future<GetIceServerConfigResult> getIceServerConfigAsync(GetIceServerConfigRequest request,
                                                                AsyncHandler<GetIceServerConfigRequest,GetIceServerConfigResult> asyncHandler)

Description copied from interface: AmazonKinesisVideoSignalingChannelsAsync

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:

getIceServerConfigAsync in interface AmazonKinesisVideoSignalingChannelsAsync

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.

Returns:

A Java Future containing the result of the GetIceServerConfig operation returned by the service.

See Also:

AWS API Documentation

sendAlexaOfferToMasterAsync

public Future<SendAlexaOfferToMasterResult> sendAlexaOfferToMasterAsync(SendAlexaOfferToMasterRequest request)

Description copied from interface: AmazonKinesisVideoSignalingChannelsAsync

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:

sendAlexaOfferToMasterAsync in interface AmazonKinesisVideoSignalingChannelsAsync

Returns:

A Java Future containing the result of the SendAlexaOfferToMaster operation returned by the service.

See Also:

AWS API Documentation

sendAlexaOfferToMasterAsync

public Future<SendAlexaOfferToMasterResult> sendAlexaOfferToMasterAsync(SendAlexaOfferToMasterRequest request,
                                                                        AsyncHandler<SendAlexaOfferToMasterRequest,SendAlexaOfferToMasterResult> asyncHandler)

Description copied from interface: AmazonKinesisVideoSignalingChannelsAsync

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:

sendAlexaOfferToMasterAsync in interface AmazonKinesisVideoSignalingChannelsAsync

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.

Returns:

A Java Future containing the result of the SendAlexaOfferToMaster operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AmazonKinesisVideoSignalingChannels

Overrides:

shutdown in class AmazonKinesisVideoSignalingChannelsClient