Voice and Video Overview

About the Voice and Video SDK

The Voice and Video SDK is a JQuery-based JavaScript toolkit that exposes methods and events to enable softphone control. The SDK uses a browser plugin that uses the same technology as all our Jabber clients and is supported by the major Windows and Mac OSX browsers.

The SDK provides the following components:

• VOIP SDK based on Cisco WebEx Social
• Web UC reference application that supports simultaneous use of CAXL, VOIP, and WebEx working together
• Reference application (and source code) that demonstrates the use and power of the Web UC SDK

Architecture Overview

The SDK itself contains the following components:

• Native browser plug-in, that provides call control and media termination within the browser
  • Available on Windows and Mac operating systems
  • Compatible with Internet Explorer, Firefox, Chrome and Safari
  • Support for soft phone mode (connects SIP with Unified Communications Manager, and uses the computer for audio) and deskphone mode (connects CTI with Unified Communications Manager, and uses a physical phone for audio)
• JavaScript API enables Cisco voice and video telephony from a web page
  • The cwic jQuery plugin accesses telephony features
• Optional server-side node that provides advanced features such as authentication and directory integration

The following diagram shows the high-level architecture of the SDK. This documentation describes the API exposed by the cwic jQuery plugin (cwic.js), which runs in the browser.

Design principles

The Jabber Voice and Video SDK depends on jQuery version 1.4 or later.  The API is available as a jQuery plugin called cwic.

Use of the cwic plug-in follows the standard jQuery style of selecting one or more HTML elements, and then calling a cwic operation on the selection to manage the softphone.

cwic relies on jQuery namespacing, custom events and data to provide telephony features to a web application. cwic uses the "cwic" namespace to name events, and data that is associated to HTML elements. For example, cwic triggers the "conversationStart.cwic" event when a new conversation starts.

cwic uses the DOM (Document Object Model) as much as possible, especially to raise events and store data. For example, to start a new conversation, the application selects an HTML element to act as the conversation container. cwic uses that same element to store the conversation real-time information, and to trigger events related to this particular conversation.