com.amazonaws.services.kinesisvideosignalingchannels

Interface AmazonKinesisVideoSignalingChannelsAsync

All Superinterfaces:

AmazonKinesisVideoSignalingChannels

All Known Implementing Classes:

AbstractAmazonKinesisVideoSignalingChannelsAsync, AmazonKinesisVideoSignalingChannelsAsyncClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonKinesisVideoSignalingChannelsAsync
extends AmazonKinesisVideoSignalingChannels

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

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonKinesisVideoSignalingChannelsAsync instead.

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 interface com.amazonaws.services.kinesisvideosignalingchannels.AmazonKinesisVideoSignalingChannels

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
Future<GetIceServerConfigResult>	getIceServerConfigAsync(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.
Future<GetIceServerConfigResult>	getIceServerConfigAsync(GetIceServerConfigRequest getIceServerConfigRequest, 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 sendAlexaOfferToMasterRequest) This API allows you to connect WebRTC-enabled devices with Alexa display devices.
Future<SendAlexaOfferToMasterResult>	sendAlexaOfferToMasterAsync(SendAlexaOfferToMasterRequest sendAlexaOfferToMasterRequest, AsyncHandler<SendAlexaOfferToMasterRequest,SendAlexaOfferToMasterResult> asyncHandler) This API allows you to connect WebRTC-enabled devices with Alexa display devices.

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

getCachedResponseMetadata, getIceServerConfig, sendAlexaOfferToMaster, shutdown

Method Detail

getIceServerConfigAsync

Future<GetIceServerConfigResult> getIceServerConfigAsync(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. 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.

Parameters:

getIceServerConfigRequest -

Returns:

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

See Also:

AWS API Documentation

getIceServerConfigAsync

Future<GetIceServerConfigResult> getIceServerConfigAsync(GetIceServerConfigRequest getIceServerConfigRequest,
                                                         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. 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.

Parameters:

getIceServerConfigRequest -

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

Future<SendAlexaOfferToMasterResult> sendAlexaOfferToMasterAsync(SendAlexaOfferToMasterRequest sendAlexaOfferToMasterRequest)

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.

Parameters:

sendAlexaOfferToMasterRequest -

Returns:

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

See Also:

AWS API Documentation

sendAlexaOfferToMasterAsync

Future<SendAlexaOfferToMasterResult> sendAlexaOfferToMasterAsync(SendAlexaOfferToMasterRequest sendAlexaOfferToMasterRequest,
                                                                 AsyncHandler<SendAlexaOfferToMasterRequest,SendAlexaOfferToMasterResult> asyncHandler)

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.

Parameters:

sendAlexaOfferToMasterRequest -

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