com.amazonaws.services.kinesisvideosignalingchannels

Interface AmazonKinesisVideoSignalingChannels

All Known Subinterfaces:

AmazonKinesisVideoSignalingChannelsAsync

All Known Implementing Classes:

AbstractAmazonKinesisVideoSignalingChannels, AbstractAmazonKinesisVideoSignalingChannelsAsync, AmazonKinesisVideoSignalingChannelsAsyncClient, AmazonKinesisVideoSignalingChannelsClient

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

Interface for accessing Amazon Kinesis Video Signaling Channels.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonKinesisVideoSignalingChannels 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

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

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 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.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

getIceServerConfig

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

Result of the GetIceServerConfig operation returned by the service.

Throws:

InvalidClientException - The specified client is invalid.

SessionExpiredException - If the client session is expired. Once the client is connected, the session is valid for 45 minutes. Client should reconnect to the channel to continue sending/receiving messages.

ClientLimitExceededException - Your request was throttled because you have exceeded the limit of allowed client calls. Try making the call later.

ResourceNotFoundException - The specified resource is not found.

InvalidArgumentException - The value for this input parameter is invalid.

NotAuthorizedException - The caller is not authorized to perform this operation.

See Also:

AWS API Documentation

sendAlexaOfferToMaster

SendAlexaOfferToMasterResult sendAlexaOfferToMaster(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:

Result of the SendAlexaOfferToMaster operation returned by the service.

Throws:

ClientLimitExceededException - Your request was throttled because you have exceeded the limit of allowed client calls. Try making the call later.

ResourceNotFoundException - The specified resource is not found.

InvalidArgumentException - The value for this input parameter is invalid.

NotAuthorizedException - The caller is not authorized to perform this operation.

See Also:

AWS API Documentation

shutdown

void shutdown()

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.

getCachedResponseMetadata

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

Parameters:

request - The originally executed request.

Returns:

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