WebRTC Session Controller Index

Oracle® Communications WebRTC Session Controller Javascript API Reference, E55131-03

The WebRTC Session Controller Javascript SDK provides APIs (under the root namespace wsc) that enable you to build WebRTC-enabled applications, including:

WebRTC based audio/video/datachannel applications.
MSRP(Message Session Relay Protocol) based chat and file transfer applications.
Paging Mode messaging applications.
Capability discovery applications.
Message alert applications.

The APIs are defined in different source files so that you can choose only the ones that are necessary for your application's functionality.

The following two files enable you to build Flash-based applications. You need to include these files to your client application. Additionally, you will need to call wsc_flash.wscFlash.init() to perform flash extension initialization after loading your WebRTC Session Controller client functions.

wsc-flash.js

wsc-ie-adapter.js

wsc-common.js

This file contains all the essential classes to setup a session between a client and the WebRTC Session Controller Signaling Engine, as well as other common utility classes. All applications need to include this file.

Name	Description
Session	Represents a session between a client and the WebRTC Session Controller server
ExtensibleSession	A session object that exposes functions for extension
Message	Represents the JSON-RTC message between a client and server
AuthHandler	Used to handle a challenge from a server
Map	An implementation of the Map data structure

wsc-call.js

This file contains all the classes to configure WebRTC-based audio/video/datachannel communications.

Name	Description
CallPackage	Package class to manage wsc.Call
Call	Represents a WebRTC-based audio/video/datachannel communications
CallConfig	Describes the capabilities (audio/video/data channel) of a call.
DataTransfer	Object to manage the underlying data channel
DataSender	Represents the sender of a DataTransfer object that can send raw data over the underlying data channel
DataReceiver	Represents the receiver of a DataTransfer object that can receive raw data over the underlying data channel

wsc-chat.js

This file contains all the classes to setup MSRP-based chat.

Name	Description
ChatPackage	Package class to manage wsc.Chat
Chat	Represents an MSRP based chat

wsc-filetransfer.js

This file contains all the classes to setup an MSRP-based file transfer.

Name	Description
FileTransferPackage	Package class to manage wsc.FileTransfer
FileTransfer	Represents a MSRP based file transfer

wsc-messaging.js

This file contains all the classes to setup a Paging mode messaging application.

Name	Description
MessagingPackage	Package class to manage wsc.Messaging
Messaging	Controller class to send/receive a message and handle the response

wsc-capability.js

This file contains all the classes used to provide capability discovery functions.

Name	Description
CapabilityPackage	Package class to manage wsc.CapabilityExchange
CapabilityExchange	Controller class to send/receive a query and handle the response

wsc-msgalert.js

This file contains all the classes to implement Message alert applications that follow RFC-3842, A Message Summary and Message Waiting Indication Event Package for the Session Initiation Protocol.

Name	Description
MessageAlertPackage	Package class to manage wsc.Subscription
Subscription	Represents a subscription for an event
Notification	Represents general notifications for an event
MessageSummary	A sub-class of Notification that represents a message-summary type notification
MessageCounts	Represents the notification message counts of the message-summary type.

wsc-flash.js

This file contains the extended classes for Flash-based audio/video communications. All Flash based applications need to include this file after loading the relevant WebRTC Session Controller Javascript source files. You also will need to call wsc_flash.wscFlash.init() to perform flash extension initialization after loading your WebRTC Session Controller client functions.

Name	Description
FlashCall	An Object that represents a flash call between two peers.
FlashCallPackage	A package that enables flash call applications.

wsc-ie-adapter.js

This file contains functions to support IE versions from 8 to 11. Flash based client applications run on IE need to include this file first.