@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonKinesisVideoSignalingChannelsAsyncClient extends AmazonKinesisVideoSignalingChannelsClient implements AmazonKinesisVideoSignalingChannelsAsync
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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| 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.
|
builder, getCachedResponseMetadata, getIceServerConfig, sendAlexaOfferToMasteraddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetCachedResponseMetadata, getIceServerConfig, sendAlexaOfferToMasterpublic static AmazonKinesisVideoSignalingChannelsAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<GetIceServerConfigResult> getIceServerConfigAsync(GetIceServerConfigRequest request)
AmazonKinesisVideoSignalingChannelsAsyncGets 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.
getIceServerConfigAsync in interface AmazonKinesisVideoSignalingChannelsAsyncpublic Future<GetIceServerConfigResult> getIceServerConfigAsync(GetIceServerConfigRequest request, AsyncHandler<GetIceServerConfigRequest,GetIceServerConfigResult> asyncHandler)
AmazonKinesisVideoSignalingChannelsAsyncGets 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.
getIceServerConfigAsync in interface AmazonKinesisVideoSignalingChannelsAsyncasyncHandler - 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.public Future<SendAlexaOfferToMasterResult> sendAlexaOfferToMasterAsync(SendAlexaOfferToMasterRequest request)
AmazonKinesisVideoSignalingChannelsAsyncThis 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.
sendAlexaOfferToMasterAsync in interface AmazonKinesisVideoSignalingChannelsAsyncpublic Future<SendAlexaOfferToMasterResult> sendAlexaOfferToMasterAsync(SendAlexaOfferToMasterRequest request, AsyncHandler<SendAlexaOfferToMasterRequest,SendAlexaOfferToMasterResult> asyncHandler)
AmazonKinesisVideoSignalingChannelsAsyncThis 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.
sendAlexaOfferToMasterAsync in interface AmazonKinesisVideoSignalingChannelsAsyncasyncHandler - 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.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AmazonKinesisVideoSignalingChannelsshutdown in class AmazonKinesisVideoSignalingChannelsClient