com.amazonaws.services.kinesisvideosignalingchannels

Class AbstractAmazonKinesisVideoSignalingChannels

java.lang.Object

com.amazonaws.services.kinesisvideosignalingchannels.AbstractAmazonKinesisVideoSignalingChannels

All Implemented Interfaces:

AmazonKinesisVideoSignalingChannels

Direct Known Subclasses:

AbstractAmazonKinesisVideoSignalingChannelsAsync

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonKinesisVideoSignalingChannels
extends Object
implements AmazonKinesisVideoSignalingChannels

Abstract implementation of AmazonKinesisVideoSignalingChannels. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary

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

ENDPOINT_PREFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAmazonKinesisVideoSignalingChannels()

Method Summary

Modifier and Type	Method and Description
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetIceServerConfigResult	getIceServerConfig(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.
SendAlexaOfferToMasterResult	sendAlexaOfferToMaster(SendAlexaOfferToMasterRequest request) This API allows you to connect WebRTC-enabled devices with Alexa display devices.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractAmazonKinesisVideoSignalingChannels

protected AbstractAmazonKinesisVideoSignalingChannels()

Method Detail

getIceServerConfig

public GetIceServerConfigResult getIceServerConfig(GetIceServerConfigRequest request)

Description copied from interface: AmazonKinesisVideoSignalingChannels

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 AmazonKinesisVideoSignalingChannels

Returns:

Result of the GetIceServerConfig operation returned by the service.

See Also:

AWS API Documentation

sendAlexaOfferToMaster

public SendAlexaOfferToMasterResult sendAlexaOfferToMaster(SendAlexaOfferToMasterRequest request)

Description copied from interface: AmazonKinesisVideoSignalingChannels

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 AmazonKinesisVideoSignalingChannels

Returns:

Result of the SendAlexaOfferToMaster operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Description copied from interface: AmazonKinesisVideoSignalingChannels

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonKinesisVideoSignalingChannels

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Description copied from interface: AmazonKinesisVideoSignalingChannels

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

Specified by:

getCachedResponseMetadata in interface AmazonKinesisVideoSignalingChannels

Parameters:

request - The originally executed request.

Returns:

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