AWS.KinesisVideoSignalingChannels — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Inherits:

AWS.Service

Identifier:

kinesisvideosignalingchannels

API Version:

2019-12-04

Defined in:

(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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.

Sending a Request Using KinesisVideoSignalingChannels

var kinesisvideosignalingchannels = new AWS.KinesisVideoSignalingChannels();
kinesisvideosignalingchannels.getIceServerConfig(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the KinesisVideoSignalingChannels object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var kinesisvideosignalingchannels = new AWS.KinesisVideoSignalingChannels({apiVersion: '2019-12-04'});

You can also set the API version globally in AWS.config.apiVersions using the kinesisvideosignalingchannels service identifier:

AWS.config.apiVersions = {
  kinesisvideosignalingchannels: '2019-12-04',
  // other service API versions
};

var kinesisvideosignalingchannels = new AWS.KinesisVideoSignalingChannels();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.KinesisVideoSignalingChannels(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

getIceServerConfig(params = {}, callback) ⇒ AWS.Request

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.

sendAlexaOfferToMaster(params = {}, callback) ⇒ AWS.Request

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.