CAF: Working With Call Legs - Revision history

Allyntree at 14:44, 6 September 2022

2022-09-06T14:44:14Z

← Older revision		Revision as of 10:44, 6 September 2022
Line 1:		Line 1:
			{{DISPLAYTITLE:CAF: Working With Call Legs}}
	TelcoBridges Toolpack framework offers two API layers to manipulate call legs and audio mixers (conferences).		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.		We recommend that developers use the CAF API layer, because it offers higher-level functionality, which accelerates application development.


	== CMC API layer ==		== 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 lower-level API is based on classes ''CTBCMCLeg'' and ''CTBCMCMixer''. These classes allow receiving leg or mixer events (answered, digit collected, terminating, etc.), and sending 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		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

Abrassard: Adding link to the "leg resync" page

2012-10-19T11:09:41Z

Adding link to the "leg resync" page

← Older revision		Revision as of 07: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]]

Cbilodeau: fix links

2012-05-08T19:39:15Z

fix links

← Older revision		Revision as of 15:39, 8 May 2012
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		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 ==		== CAF API layer ==
Line 22:		Line 22:
	The following page explains how to work with CAF Call leg framework (CTBCAFCallLeg, CTBCAFCallFlow, CTBCAFCallBehavior, etc...)		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]]

Abrassard at 14:29, 17 January 2012

2012-01-17T14:29:33Z

@@ 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]]

Abrassard at 14:32, 7 April 2011

2011-04-07T14:32:20Z

← Older revision		Revision as of 10:32, 7 April 2011
Line 4:		Line 4:
	The following page explains how to work with CAF Call leg framework (CTBCAFCallLeg, CTBCAFCallFlow, CTBCAFCallBehavior, etc...)		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		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]]

Abrassard at 14:30, 7 April 2011

2011-04-07T14:30:32Z

Show changes

Abrassard: /* Using timers */

2011-03-03T14:44:03Z

Using timers

← Older revision		Revision as of 10:44, 3 March 2011
Line 368:		Line 368:
	''CTBCMCTimer'' class can be used to attach timers to call legs, and get an event upon timer expiry.		''CTBCMCTimer'' class can be used to attach timers to call legs, and get an event upon timer expiry.
	Documentation can be found here:		Documentation can be found here:
	~~yyy~~		[[CAF:_CTBCMCTimer\|Working with CTBCMCTimer]]

Abrassard: /* CTBCMCTimer class */

2011-03-03T14:39:48Z

CTBCMCTimer class

← Older revision		Revision as of 10:39, 3 March 2011
Line 366:		Line 366:

	== Using timers ==		== 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:
			yyy

Abrassard: /* Unjoin */

2011-03-03T14:22:46Z

Unjoin

← Older revision		Revision as of 10: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.

Cboulanger: /* Playing and Collecting Digits */

2010-11-25T15:32:07Z

Playing and Collecting Digits

← Older revision		Revision as of 11:32, 25 November 2010
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.		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.		<br> Here are examples how to play and collect digit.
Line 151:		Line 151:
	ptrIncomingLeg->StartDigitCollection( "5\|3xxxxxx\|[4-7]55xxxx" );		ptrIncomingLeg->StartDigitCollection( "5\|3xxxxxx\|[4-7]55xxxx" );
	}		}
	</pre>		</pre>

	=== Playing and Collecting Tones ===		=== 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.		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.