Capi Sdk Components; Code Files; Documentation - Polycom ReadiVoice Developer's Manual

CAPI SDK Components

Proprietary & Confidential
The heart of CAPI is a set of events that provide functionality. The CAPI
product, however, has far more than just the schema. Polycom provides a set
of tools to make development far quicker and easier—and more reliable—than
simply writing all your code from scratch.
CAPI provides this in the form of a robust set of teleconferencing events in an
XML schema, Java versions of those events already generated for you, plus
Java code that takes care of the complex networking tasks for you such as
networking connections and other tasks.
Note: This guide assumes that you will be writing your application in Java,
using the provided utility and communication files. If you will not be, refer to
use the schema and the detailed event documentation to develop your
application.

Code Files

The new CAPI SDK contains the following components.
• An XML schema defining conferencing events, composing the XML layer
of the API.
• Four types of Java files, built on top of the XML layer, composing the Java
layer of the API.
— Core communication files, which interact with CACS and the core
utility files.
— Core utility files, which interact with the core communication files.
— Castor utility files, which interact with the event files and implement
the core utility files.
— Castor event files, generated from the CAPI schema using the Castor
program. (To learn more about Castor, see www.castor.org.)

Documentation

CAPI also provides a complete set of technical documentation.
• This guide includes procedures for common tasks like logging into the
system, creating a conference, and dialing participants, with sequence
diagrams and explanations of key points.
• Javadocs for the CAPI Java files.
• Simple example application.
Introducing CAPI
3