Skip Headers
Oracle® Communications WebRTC Session Controller Web Application Developer's Guide
Release 7.0
E40978-01
Home
Contact Us
1/13
Next
PDF
·
Mobi
·
ePub
Contents
Title and Copyright Information
Preface
Audience
Related Documents
Documentation Accessibility
1
Creating HTML5 Applications for WebRTC-Enabled Browsers
About Applications for WebRTC-Enabled Browsers
About Your Application Development Environment
About WebRTC Session Controller Signaling Engine
About the WebRTC Session Controller and Your Applications
About the Supported WebRTC-Enabled Browsers
About JavaScript
About the Browser Protocols and Your Applications
About the Conventions Used in This Guide
2
About Using the WebRTC Session Controller JavaScript API
About the wsc Namespace
About Using the WebRTC Session Controller JavaScript API Library
About the API Used for General Tasks
About the API Used for Call-Related Tasks
About the API Used for Message-Related Tasks
About Extending WebRTC Session Controller JavaScript API
Managing Sessions with wsc.Session
Authenticating Users with wsc.AuthHandler
Handling Session State Changes
Debugging Your Application with wsc.LOGLEVEL
Managing Calls with wsc.CallPackage
Managing a Call with wsc.Call
Specifying the Configuration for Calls with wsc.CallConfig
Handling Changes in Call States
Handling Changes in Media Stream States
Transferring Data With wsc.DataTransfer
Sending Data Using wsc.DataSender
Receiving Data Using wsc.DataReceiver
About the Code Segments Displayed in This Guide
About the Application HTML File
About Web Applications Using WebRTC Session Controller JavaScript API
General Call Logic of Your Applications
General Notifications Logic of Your Applications
Supporting Libraries
Verifying Browser Capabilities
About Monitoring Your Application WebSocket Connection
About Handling Events in the Application Environment
Managing the Sessions in Your Application
How Your Application Saves Session Information
Recreating the Session Using the Session ID
How WebRTC Session Controller JavaScript API Library Restores Application Data
Restoring Your Application Package Data After Your Application Pages Reload
Restoring CallPackage Data After Pages Reload
Restoring Extended MessageAlertPackage Data After Pages Reload
Restoring a Call Session
Restoring a Subscription Session
Resuming Your Application Operation
3
Setting Up Security
Handling Login to WebRTC Session Controller
Login Using Basic Authentication
Redirecting After a Successful Login
Login Using OAuth Authentication
Login Using Form-Based Authentication
Handling Logout from WebRTC Session Controller
4
Setting Up Audio Calls in Your Applications
About Implementing the Audio Call Feature in Your Applications
About the WebRTC Session Controller JavaScript API Used in Implementing Audio Calls
Setting Up Audio Calls in Your Applications
About the Sample Audio Call Application
Overview of Setting Up the Audio Call Feature in Your Application
Setting Up the General Elements for the Audio Call Feature
Setting Up the Main Objects and Values
Current Stage in the Development of the Audio Call Feature
Enabling Users to Make Audio Calls From Your Application
Setting Up the Configuration for Calls Supported by the Application
Setting Up the Session Object
Setting Up the Call Package for the Session
Handling Session State Changes
Obtaining the Callee Information
Current Stage in the Development of the Audio Call Feature in Your Application
Initial Actions of the Sample Audio Call Application
Implementing the Logic to Set Up the Call Session
Starting a Call From Your Application
Retrieving the Appropriate Authentication Headers
About Digest Access Authentication
Creating the authHeader Object for the Response
Setting Up the Event Handler for Call State Changes
Setting Up the Event Handler for the Media Streams
Current Stage in the Development of the Audio Call Feature in Your Application
How the Sample Audio Call Application Starts a Call
Enabling Your Application Users to Receive Calls
Responding to Your User's Actions on an Incoming Call
Current Stage in the Development of the Audio Call Feature in Your Application
How the Sample Audio Call Application Handles Incoming Calls
How a Call is Established in the Sample Audio Call Application
Monitoring the Call
How the Sample Audio Call Application Monitors a Call
Ending the Call
Current Stage in the Development of the Audio Call Feature in Your Application
Closing the Session When the User Logs Out
Other Actions on Calls
Gathering Information on the Current Call
Supporting Multiple Calls Using CallPackage
Managing Interactive Connectivity Establishment Interval
About the Use of ICE and ICE Candidate Trickling
About WebRTC Session Controller Signaling Engine and the ICE Interval
Retrieving the Current ICE Interval for the Call
Setting Up the ICE Interval for the Call
Updating a Call
Reconnecting Dropped Calls
5
Setting Up Video Calls in Your Applications
About Implementing the Video Call Feature in Your Applications
About the WebRTC Session Controller JavaScript API Used in Implementing Video Calls
Setting Up Video Calls in Your Applications
Setting Up the Video Display
Specifying the Video Direction in the Call Configuration
Managing the Video Display on Your Application Page
Managing the Video Streams in the Media Stream Event Handler
6
Setting Up Data Transfers in Your Applications
About Data Transfers and Signaling Engine
About Setting Up Data Transfers in Your Applications
About the API Used to Manage the Transfer of Data
Managing Data Channels Using wsc.DataTransfer
Sending Data Using wse.DataSender
Handling Incoming Data Using wsc.DataReceiver
Setting up Data Transfers in Your Application
Declaring Variables Specific to the Chat Sessions
Setting Up the Configuration for Data Transfers in Chat Sessions
Assigning the Data Transfer Event Handler to the Call Package
Obtaining the Callee Information
Starting the Call with the Data Transfer Feature in the Call
Responding to Your User's Actions on an Incoming Call
Setting Up the Chat Session User Interface
Setting Up the Data Transfer State Event Handler for the Chat Session
Managing the Flow of Data
Handling the Open State of the Data Channel
Handling the Received Text
Sending the Text
Handling the Closed State of the Data Channel
Monitoring the Chat Session
7
Setting Up Message Alert Notifications
About Message Alert Notifications and Signaling Engine
Handling Message Notifications in Your Web Applications
About the API Used to Manage Message Alert Notifications
Managing Message Alert Notifications with wsc.MessageAlertPackage
Handling Notifications with wsc.Notification
Subscribing to Notifications with wsc.Subscription
Getting Message Summary Information
Retrieving Message Counts from Message-Summary Notifications
Managing Subscriptions
Enabling the User to Subscribe to Notifications
Setting Up a Subscription
Creating a Subscription
Verifying that a Subscription is Active
Handling the Ending of a Subscription
Restoring a Subscription
Managing Notifications
Handling Message Notifications
8
Extending Your Applications Using WebRTC Session Controller JavaScript API
About the Default Messaging Mechanism Used by Your Applications
About Extending the WSC Namespace
Extending Objects Using the wsc.extend Method
Extending Sessions with wsc.ExtensibleSession Class
Extending and Overriding WebRTC Session Controller JavaScript API Object Methods
Handling Extended Call Sessions with CallPackage.onMessage
Preparing Custom Calls with CallPackage.prepareCall
Inserting Calls into a Session with CallPackage.putCall
Processing Custom Messages for a Call with Call.onMessage
Extending Headers in Call Messages
Handling Custom Message Notifications
Handling Extensions to Notifications with MessageAlertPackage.onMessage
Handling Additional Headers in Messages
About Additional Headers in Messages
Handling Additional Headers
Managing Calls with Additional Headers
Working with wsc.ExtensibleSession
Creating an Extensible Session in Your Application
Creating Custom Packages Using the ExtensibleSession Object
Saving Your Custom Session
Sending And Receiving Custom Messages
About the API Classes Used to Create Custom Message
wsc.Message
wsc.Message#control
wsc.Message#header
wsc.Message#payload
Managing Custom Message Data Flows
Sending a Custom Message to Signaling Engine
Processing an Incoming Custom Message
Customizing Your Applications by Extending the Package Objects
Working with Extended CallPackage Objects
Creating an Extended Call Package
Registering the Extended Package with the Session
Extending the Methods and Event Handlers in the Extended Call Package
Working with Extended Calls
Working with Extended MessageAlertPackage Objects
Extending the Methods and Event Handlers
Extending the MessageAlertPackage to Support Other Message Events
9
WebRTC Session Controller JavaScript API Error Codes and Errors
About wsc.ERRORCODE
About the Error Codes
Using wsc.ErrorInfo
About the Error Handlers
Handling Errors Related to Sessions
Handling Errors Related to Calls
Handling Errors Related to Data Transfers
Handling Errors Related to Subscriptions
10
Sample Audio Call Application
About the Sample Audio Call Application
The Sample Audio Call Application Code
Scripting on this page enhances content navigation, but does not change the content in any way.