CAF: Working With Call Legs

From TBwiki
(Difference between revisions)
Jump to: navigation, search
(Adding link to the "leg resync" page)
 
(259 intermediate revisions by 9 users not shown)
Line 1: Line 1:
= Introduction =
+
TelcoBridges Toolpack framework offers two API layers to manipulate call legs and audio mixers (conferences).
The main mechanism through which the customer application controls the Toolpack system, is via the management of call legs. The application creates a call leg (or more than one for conferencing and bridging) at the beginning of call, then control it through a simple, protocol-agnostic API. When a call is terminated, the call leg must
+
 
== Creating Call Legs ==
+
We recommend that developers use the CAF API layer, as it offers higher-level functionality which accelerate application development.
=== When Should Call Legs be Created ===
+
 
==== When Doing a Standalone Outgoing Call ====
+
 
==== When Bridging an Incoming Call ====
+
==  CMC API layer ==
==== When Creating a Media-only Leg ====
+
 
 +
The lower-level API is based on classes ''CTBCMCLeg'' and ''CTBCMCMixer''. These classes allow receiving leg or mixer events (answered, digit collected, terminating, etc.), and send requests to perform actions (answer, play, terminate, etc.).
 +
 
 +
The following page explains how to work with CTBCMCLeg directly, for lower-level applications that don't want the convenience of the CAF Call framework
 +
 
 +
[[CAF:_Working_With_Cmc_Call_Legs|Working with CMC Call Legs]]
 +
 
 +
== CAF API layer ==
 +
 
 +
A higher-level API uses the base classes ''CTBCMCLeg'' and ''CTBCMCMixer'', but adds the following functionalities:
 +
- Simplification of call legs creations through single functions (''AddIncoming'', ''AddOutgoing'', ''CreateMixer'')
 +
- Centralizing reception of events from call legs and mixers in to a single "Call Flow" (''CTBCAFCallFlow''), which deals with inter-relations between legs and mixers.
 +
- Auto-destruction of call legs (''CTBCMCLeg'') and mixers (''CTBCMCMixer'') through usage of "smart" pointers.
 +
- Auto-destruction of the call flow (''CTBCAFCallFlow'') upon destruction of last leg/mixer.
 +
 
 +
The following page explains how to work with CAF Call leg framework (CTBCAFCallLeg, CTBCAFCallFlow, CTBCAFCallBehavior, etc...)
 +
 
 +
[[CAF:_Working_With_Caf_Call_Legs|Working with CAF Call Legs and behaviors]]
 +
 
 +
The following page provides more details on call legs re-synchronization between toolpack_engine application and user "CAF" application:
 +
 
 +
[[CAF:_Call_Legs_Resync|Re-synchronizing CAF call legs]]

Latest revision as of 06:09, 19 October 2012

TelcoBridges Toolpack framework offers two API layers to manipulate call legs and audio mixers (conferences).

We recommend that developers use the CAF API layer, as it offers higher-level functionality which accelerate application development.


CMC API layer

The lower-level API is based on classes CTBCMCLeg and CTBCMCMixer. These classes allow receiving leg or mixer events (answered, digit collected, terminating, etc.), and send requests to perform actions (answer, play, terminate, etc.).

The following page explains how to work with CTBCMCLeg directly, for lower-level applications that don't want the convenience of the CAF Call framework

Working with CMC Call Legs

CAF API layer

A higher-level API uses the base classes CTBCMCLeg and CTBCMCMixer, but adds the following functionalities: - Simplification of call legs creations through single functions (AddIncoming, AddOutgoing, CreateMixer) - Centralizing reception of events from call legs and mixers in to a single "Call Flow" (CTBCAFCallFlow), which deals with inter-relations between legs and mixers. - Auto-destruction of call legs (CTBCMCLeg) and mixers (CTBCMCMixer) through usage of "smart" pointers. - Auto-destruction of the call flow (CTBCAFCallFlow) upon destruction of last leg/mixer.

The following page explains how to work with CAF Call leg framework (CTBCAFCallLeg, CTBCAFCallFlow, CTBCAFCallBehavior, etc...)

Working with CAF Call Legs and behaviors

The following page provides more details on call legs re-synchronization between toolpack_engine application and user "CAF" application:

Re-synchronizing CAF call legs

Personal tools