CAF: Working With Call Legs - Revision history

Abrassard: Adding link to the "leg resync" page

2012-10-19T11:09:41Z

Adding link to the "leg resync" page

Cbilodeau: fix links

2012-05-08T19:39:15Z

fix links

Abrassard at 14:29, 17 January 2012

2012-01-17T14:29:33Z

Abrassard at 14:32, 7 April 2011

2011-04-07T14:32:20Z

Abrassard at 14:30, 7 April 2011

2011-04-07T14:30:32Z

Show changes

Abrassard: /* Using timers */

2011-03-03T14:44:03Z

Using timers

Abrassard: /* CTBCMCTimer class */

2011-03-03T14:39:48Z

CTBCMCTimer class

Abrassard: /* Unjoin */

2011-03-03T14:22:46Z

Unjoin

Cboulanger: /* Playing and Collecting Digits */

2010-11-25T15:32:07Z

Playing and Collecting Digits

Atremblay: /* Playing and Collecting Tones */ Added reference to Tones definitions article

2010-07-14T20:15:50Z

Playing and Collecting Tones: Added reference to Tones definitions article

← Older revision		Revision as of 11:09, 19 October 2012
Line 23:		Line 23:

	[[CAF:_Working_With_Caf_Call_Legs\|Working with CAF Call Legs and behaviors]]		[[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]]

@@ Line 10: / Line 10: @@
 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
-[[http://docs.telcobridges.com/mediawiki/index.php/CAF:_Working_With_Cmc_Call_Legs Working with CMC Call Legs]]
+[[CAF:_Working_With_Cmc_Call_Legs|Working with CMC Call Legs]]
 == CAF API layer ==
@@ Line 22: / Line 22: @@
 The following page explains how to work with CAF Call leg framework (CTBCAFCallLeg, CTBCAFCallFlow, CTBCAFCallBehavior, etc...)
-[[http://docs.telcobridges.com/mediawiki/index.php/CAF:_Working_With_Caf_Call_Legs Working with CAF Call Legs and behaviors]]
+[[CAF:_Working_With_Caf_Call_Legs|Working with CAF Call Legs and behaviors]]

@@ Line 1: / Line 1: @@
-This page has been split into two pages:
+TelcoBridges Toolpack framework offers two API layers to manipulate call legs and audio mixers (conferences).
 The following page explains how to work with CAF Call leg framework (CTBCAFCallLeg, CTBCAFCallFlow, CTBCAFCallBehavior, etc...)
 [[http://docs.telcobridges.com/mediawiki/index.php/CAF:_Working_With_Caf_Call_Legs Working with CAF Call Legs and behaviors]]

@@ Line 4: / Line 4: @@
 The following page explains how to work with CAF Call leg framework (CTBCAFCallLeg, CTBCAFCallFlow, CTBCAFCallBehavior, etc...)
-[[http://docs.telcobridges.com/mediawiki/index.php/CAF:_Working_With_Caf_Call_Legs|Working with CAF Call Legs and behaviors]]
+[[http://docs.telcobridges.com/mediawiki/index.php/CAF:_Working_With_Caf_Call_Legs Working with CAF Call Legs and behaviors]]
 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
-[[http://docs.telcobridges.com/mediawiki/index.php/CAF:_Working_With_Cmc_Call_Legs|Working with CMC Call Legs]]
+[[http://docs.telcobridges.com/mediawiki/index.php/CAF:_Working_With_Cmc_Call_Legs Working with CMC Call Legs]]

@@ Line 368: / Line 368: @@
 ''CTBCMCTimer'' class can be used to attach timers to call legs, and get an event upon timer expiry.
 Documentation can be found here:
-yyy
+[[CAF:_CTBCMCTimer|Working with CTBCMCTimer]]

@@ Line 366: / Line 366: @@
 == Using timers ==
-=== CTBCMCTimer class ===
+''CTBCMCTimer'' class can be used to attach timers to call legs, and get an event upon timer expiry.
-The CTBCMCTimer class is used to spawn timers attached to call legs.
+Documentation can be found here:

← Older revision		Revision as of 14:22, 3 March 2011
Line 364:		Line 364:
	[[category:CAF]]		[[category:CAF]]
	[[category:Needs revising]]		[[category:Needs revising]]
		+
		+	== Using timers ==
		+	=== CTBCMCTimer class ===
		+	The CTBCMCTimer class is used to spawn timers attached to call legs.

@@ Line 125: / Line 125: @@
 You can play digits by calling [https://docs.telcobridges.com/mediawiki/autodoc/class_c_t_b_c_m_c_leg.html#CTBCMCLeg::PlayDigit '''PlayDigit()'''] on a leg. Toolpack will receive the request and play the digits. Once digits are played, the leg will receive [https://docs.telcobridges.com/mediawiki/autodoc/class_c_t_b_c_m_c_leg.html#CTBCMCLeg::OnDigitPlayingDone '''OnDigitPlayingDone()'''] event.
-<br> You can also configure a leg to collect digits played. To start the digit collection, you have to call [https://docs.telcobridges.com/mediawiki/autodoc/class_c_t_b_c_m_c_leg.html#CTBCMCLeg::StartDigitCollection '''StartDigitCollection()'''] on the leg. To stop the digit collection, you have to call [https://docs.telcobridges.com/mediawiki/autodoc/class_c_t_b_c_m_c_leg.html#CTBCMCLeg::StopDigitCollection '''StopDigitCollection()''']. A leg will receive [https://docs.telcobridges.com/mediawiki/autodoc/class_c_t_b_c_m_c_leg.html#CTBCMCLeg::OnDigitCollected '''OnDigitCollected()'''] event when there will be a match between the asked string and the digits collected.
+<br> You can also configure a leg to collect digits played. To start the digit collection, you have to call [https://docs.telcobridges.com/mediawiki/autodoc/class_c_t_b_c_m_c_leg.html#CTBCMCLeg::StartDigitCollection '''StartDigitCollection()'''] on the leg. To stop the digit collection, you have to call [https://docs.telcobridges.com/mediawiki/autodoc/class_c_t_b_c_m_c_leg.html#CTBCMCLeg::StopDigitCollection '''StopDigitCollection()''']. A leg will receive [https://docs.telcobridges.com/mediawiki/autodoc/class_c_t_b_c_m_c_leg.html#CTBCMCLeg::OnDigitCollected '''OnDigitCollected()'''] event when there will be a match between the asked string and the digits collected.  The syntax used to described the digit mask is based on the [http://www.ietf.org/rfc/rfc3435.txt RFC3435] in section 2.1.5 "Digit Maps".
 <br> Here are examples how to play and collect digit.
@@ Line 151: / Line 151: @@
 	ptrIncomingLeg-&gt;StartDigitCollection( "5|3xxxxxx|[4-7]55xxxx" );
+}
 </pre>
 === Playing and Collecting Tones ===
 Tones are defined as events, this is why to play and collect tones, you have to use general event functions. You can add tones you want to play by using [https://docs.telcobridges.com/mediawiki/autodoc/class_c_t_b_c_m_c___e_v_e_n_t___a_t_t_r_i_b_u_t_e.html#CTBCMC_EVENT_ATTRIBUTE::AddToneString '''AddToneString()'''] available in [https://docs.telcobridges.com/mediawiki/autodoc/class_c_t_b_c_m_c___e_v_e_n_t___a_t_t_r_i_b_u_t_e.html CTBCMC_EVENT_ATTRIBUTE] class.

← Older revision		Revision as of 20:15, 14 July 2010
Line 157:		Line 157:


−	Two kinds of string can be passed to '''AddToneString()''' to play a tone. The first type is to play well known tones such as dtmf and fax tone. The syntax is really simple and is based on H248 package and signal ids. The first component of the string is the package id and the second is the signal id, both formated in string. So, to play dtmf 0, you have to format the following string: "dg/d0", where "dg" is for package "dtmf generation" and "d0" is for "dtmf 0".	+	Two kinds of string can be passed to '''AddToneString()''' to play a tone. The first type is to play well known tones such as dtmf and fax tone. The syntax is really simple and is based on H248 package and signal ids. The first component of the string is the package id and the second is the signal id, both formated in string. So, to play dtmf 0, you have to format the following string: "dg/d0", where "dg" is for package "dtmf generation" and "d0" is for "dtmf 0". A comprehensive list of all the available well known tones is available in the [[Tone_definitions#Available_tones\|Tone definitions article]].

	===== Play Tone with Signal Id String =====		===== Play Tone with Signal Id String =====