Meeting Exchange Bridge Control API (BCAPI)

Last Release: 6.2 SP6 (Sept 2018)

Overview

Bridge Control API Status Announcement

Important BCAPI is now deprecated and is no longer supported by DevConnect. BCAPI resources remain available on the DevConnect portal as a courtesy to members who have legacy applications developed against Meeting Exchange Release 5.0 or earlier. BCAPI is a subset of the ACP API that replaces it. ACP API is a component of the Avaya Conferencing Provider Interface (ACPI). A BCAPI legacy adapter is available to help developers migrate Meeting Exchange 4.1 and 5.0 applications developed using BCAPI to ACPI.

About BCAPI

BCAPI supports a complete set of conference management capabilities. BCAPI allows developers to write applications that create, control and monitor active conferences on Meeting Exchange Audio Conferencing Servers.

BCAPI is written in Java. The API can be used by any ap plication that can make a Java call. BCAPI supports three Java objects: Bridge, Conference and Participant. A BridgeFactory object provides methods that create the connection to the bridge server and return a Bridge object. Conference and Participant objects can then be obtained through the Bridge object. Each object supports a set of parameters that define the state of the object and a set of methods that allow applications to control conference features associated with that object.

  • Bridge - The Bridge object is an abstraction of the physical bridge. It supports opening and closing conferences and maintains the state of active conferences the application is interested in. Applications register a BridgeListener with the Bridge object in order to receive events that occur on the bridge.
  • Conference - The Conference object allows applications to determine the state of a conference and control conference features. Examples of some of the features that are supported by the Conference object are retrieving participants, dialing out to a participant, muting/un-muting all participants except one moderator and locking and unlocking a conference to exclude new participants.
  • Participant - The Participant object allows applications to determine the state of a participant in a conference and control participant features. Examples of some of the features that are supported by the Participant object are placing a participant on hold/un-hold, muting and un-muting a participant and making a participant the moderator of a conference.

BCAPI SDK

The BCAPI SDK is a ZIP file that contains the BCAPI.jar file that needs to be included in the client application's classpath and the javadocs that fully define the objects and interfaces supported in BCAPI. In addition, there is a programmer's guide titled Meeting Exchange Bridge Control API (BCAPI) Guide included in the SDK ZIP file. The BCAPI SDK is only available with Meeting Exchange Release 5.0 and earlier.

Loading...