Class: AWS.KinesisVideoWebRTCStorage
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.KinesisVideoWebRTCStorage
- Identifier:
- kinesisvideowebrtcstorage
- API Version:
- 2018-05-10
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service Description
Sending a Request Using KinesisVideoWebRTCStorage
var kinesisvideowebrtcstorage = new AWS.KinesisVideoWebRTCStorage();
kinesisvideowebrtcstorage.joinStorageSession(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 KinesisVideoWebRTCStorage object uses this specific API, you can
construct the object by passing the apiVersion
option to the constructor:
var kinesisvideowebrtcstorage = new AWS.KinesisVideoWebRTCStorage({apiVersion: '2018-05-10'});
You can also set the API version globally in AWS.config.apiVersions
using
the kinesisvideowebrtcstorage service identifier:
AWS.config.apiVersions = {
kinesisvideowebrtcstorage: '2018-05-10',
// other service API versions
};
var kinesisvideowebrtcstorage = new AWS.KinesisVideoWebRTCStorage();
Constructor Summary collapse
-
new AWS.KinesisVideoWebRTCStorage(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
joinStorageSession(params = {}, callback) ⇒ AWS.Request
Join the ongoing one way-video and/or multi-way audio WebRTC session as a video producing device for an input channel.
Methods inherited from AWS.Service
makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService
Constructor Details
new AWS.KinesisVideoWebRTCStorage(options = {}) ⇒ Object
Constructs a service object. This object has one method for each API operation.
Property Details
Method Details
joinStorageSession(params = {}, callback) ⇒ AWS.Request
Join the ongoing one way-video and/or multi-way audio WebRTC session as a video producing device for an input channel. If there’s no existing session for the channel, a new streaming session needs to be created, and the Amazon Resource Name (ARN) of the signaling channel must be provided.
Currently for the SINGLE_MASTER
type, a video producing device is able to ingest both audio and video media into a stream, while viewers can only ingest audio. Both a video producing device and viewers can join the session first, and wait for other participants.
While participants are having peer to peer conversations through webRTC, the ingested media session will be stored into the Kinesis Video Stream. Multiple viewers are able to playback real-time media.
Customers can also use existing Kinesis Video Streams features like HLS
or DASH
playback, Image generation, and more with ingested WebRTC media.