CAF: Working With Caf Call Legs - Revision history

Allyntree at 14:42, 6 September 2022

2022-09-06T14:42:17Z

Abrassard: Minor example code fix

2016-07-04T19:03:07Z

Minor example code fix

← Older revision		Revision as of 15:03, 4 July 2016
Line 156:		Line 156:
	CTBCMC_EVENT_ATTRIBUTE Event;		CTBCMC_EVENT_ATTRIBUTE Event;
	Event.AddToneString( "telcofax/eof" );		Event.AddToneString( "telcofax/eof" );
	GetIncomingActiveLeg()->StartEventCollection( ~~in_EventMask~~, NULL, TBX_FALSE /* Don't suppress tones */ );		GetIncomingActiveLeg()->StartEventCollection( Event, NULL, TBX_FALSE /* Don't suppress tones */ );

	// Call base class to forward event to next behavior		// Call base class to forward event to next behavior

Abrassard: /* Creating the CTBCAFCallFlow object, its legs and mixers */

2016-02-24T11:26:18Z

Creating the CTBCAFCallFlow object, its legs and mixers

← Older revision		Revision as of 07:26, 24 February 2016
Line 144:		Line 144:

	// Create an audio mixer		// Create an audio mixer
	pCallFlow->~~MixerCreate~~( ptrMixerAttribute );		pCallFlow->AddMixer( ptrMixerAttribute );

	// Initialize the call (this actually creates the call legs)		// Initialize the call (this actually creates the call legs)

Abrassard: /* Join/Unjoin API */

2014-03-05T14:27:25Z

Join/Unjoin API

← Older revision		Revision as of 10:27, 5 March 2014
Line 413:		Line 413:


	=== Join/Unjoin API ===		=== Mixer Join/Unjoin API ===
	Joining with mixers is made by using the mixer's functions ''MixerJoin()''		Joining with mixers is made by using the mixer's functions ''MixerJoin()''
	TBX_RESULT CTBCMCMixer::MixerJoin		TBX_RESULT CTBCMCMixer::MixerJoin

Abrassard: Doc for joining mixers

2014-03-05T14:27:04Z

Doc for joining mixers

@@ Line 400: / Line 400: @@
 * pLegB->Join( pLegC );
 ** ==> Error!
 == Re-synchronizing with [[Toolpack_Application:toolpack_engine|toolpack_engine]] ==

Abrassard: /* Scenario: Audio forking */

2014-03-05T14:12:20Z

Scenario: Audio forking

← Older revision		Revision as of 10:12, 5 March 2014
Line 379:		Line 379:
	* pLegA->Join( pLegB );		* pLegA->Join( pLegB );
	** ==> CallFlow::OnLegJoinDone( pLegA, pLegB, [fd] )		** ==> CallFlow::OnLegJoinDone( pLegA, pLegB, [fd] )
	* pLegA->Join( pLegC, NULL, TBX_FALSE, &HdJoin);		* pLegA->Join( pLegC, NULL, TBX_FALSE, &HdJoin );
	** ==> CallFlow::OnLegJoinDone( pLegA, pLegC, [hd] )		** ==> CallFlow::OnLegJoinDone( pLegA, pLegC, [hd] )
	* pLegA->Join( pLegD, NULL, TBX_FALSE, &HdJoin);		* pLegA->Join( pLegD, NULL, TBX_FALSE, &HdJoin );
	** ==> CallFlow::OnLegJoinDone( pLegA, pLegD, [hd] )		** ==> CallFlow::OnLegJoinDone( pLegA, pLegD, [hd] )
	* pLegB->Join( pLegE, NULL, TBX_FALSE, &HdJoin);		* pLegB->Join( pLegE, NULL, TBX_FALSE, &HdJoin );
	** ==> CallFlow::OnLegJoinDone( pLegB, pLegE, [hd] )		** ==> CallFlow::OnLegJoinDone( pLegB, pLegE, [hd] )
	* pLegA->TerminateCall()		* pLegA->TerminateCall()
Line 390:		Line 390:
	** ==> CallFlow::OnLegUnjoinDone( pLegA, pLegD, [hd] )		** ==> CallFlow::OnLegUnjoinDone( pLegA, pLegD, [hd] )
	** ==> CallFlow::OnCallLegTerminated( pLegA )		** ==> CallFlow::OnCallLegTerminated( pLegA )

			=== Scenario: Illegal join ===
			LegA ---> LegB
			LegB <--> LegC *** Illegal

			A join operation that would make a leg receive audio from more than one source would be illegal.
			* pLegA->Join( pLegB, NULL, TBX_FALSE, &HdJoin );
			** ==> CallFlow::OnLegJoinDone( pLegA, pLegB, [hd] )
			* pLegB->Join( pLegC );
			** ==> Error!

	== Re-synchronizing with [[Toolpack_Application:toolpack_engine\|toolpack_engine]] ==		== Re-synchronizing with [[Toolpack_Application:toolpack_engine\|toolpack_engine]] ==

Abrassard: /* Scenario: Changing from hald-duplex to full-duplex */

2014-03-05T14:09:19Z

Scenario: Changing from hald-duplex to full-duplex

← Older revision		Revision as of 10:09, 5 March 2014
Line 360:		Line 360:
	** ==> CallFlow::OnLegUnjoinDone( pLegB, pLegA, [hd] )		** ==> CallFlow::OnLegUnjoinDone( pLegB, pLegA, [hd] )

	=== Scenario: Changing from ~~hald~~-duplex to full-duplex ===		=== Scenario: Changing from half-duplex to full-duplex ===
	''LegA ---> LegB'' ===> ''LegA <---> LegB''<br/><br/>		''LegA ---> LegB'' ===> ''LegA <---> LegB''<br/><br/>
	A ''Join'' operation on two legs already joined together will override the join attributes.		A ''Join'' operation on two legs already joined together will override the join attributes.

Abrassard: /* Scenario: Changing from hald-duplex to full-duplex */

2014-03-05T14:08:10Z

Scenario: Changing from hald-duplex to full-duplex

← Older revision		Revision as of 10:08, 5 March 2014
Line 363:		Line 363:
	''LegA ---> LegB'' ===> ''LegA <---> LegB''<br/><br/>		''LegA ---> LegB'' ===> ''LegA <---> LegB''<br/><br/>
	A ''Join'' operation on two legs already joined together will override the join attributes.		A ''Join'' operation on two legs already joined together will override the join attributes.
	* CTBCMC_JOIN_ATTRIBUTE HdJoin;
	* HdJoin.IsFullDuplex() = TBX_FALSE;
	* pLegA->Join( pLegB, NULL, TBX_FALSE, &HdJoin);		* pLegA->Join( pLegB, NULL, TBX_FALSE, &HdJoin);
	** ==> CallFlow::OnLegJoinDone( pLegA, pLegB, [hd] )		** ==> CallFlow::OnLegJoinDone( pLegA, pLegB, [hd] )

Abrassard: /* Joining call legs */

2014-03-05T14:07:41Z

Joining call legs

← Older revision		Revision as of 10:07, 5 March 2014
Line 343:		Line 343:
	When joined half-duplex, each source leg sends audio to destination leg, but not the opposite.		When joined half-duplex, each source leg sends audio to destination leg, but not the opposite.

	* CTBCMC_JOIN_ATTRIBUTE ~~JoinAttribute~~;		* CTBCMC_JOIN_ATTRIBUTE HdJoin;
	* ~~JoinAttribute~~.IsFullDuplex() = TBX_FALSE;		* HdJoin.IsFullDuplex() = TBX_FALSE;
	* pLegA->Join( pLegB, NULL, TBX_FALSE, &~~JoinAttribute~~ );		* pLegA->Join( pLegB, NULL, TBX_FALSE, &HdJoin );
	** ==> CallFlow::OnLegJoinDone( pLegA, pLegB, [hd] )		** ==> CallFlow::OnLegJoinDone( pLegA, pLegB, [hd] )
	* pLegA->Unjoin( pLegB );		* pLegA->Unjoin( pLegB );
Line 353:		Line 353:
	''LegA ---> LegB'' ===> ''LegB ---> LegA''<br/><br/>		''LegA ---> LegB'' ===> ''LegB ---> LegA''<br/><br/>
	Joining A--->B then B--->A is not creating a full-duplex connection, it's actually inverting the direction of the connection.		Joining A--->B then B--->A is not creating a full-duplex connection, it's actually inverting the direction of the connection.
	* CTBCMC_JOIN_ATTRIBUTE JoinAttribute;		* pLegA->Join( pLegB, NULL, TBX_FALSE, &HdJoin );
	* JoinAttribute.IsFullDuplex() = TBX_FALSE;
	* pLegA->Join( pLegB, NULL, TBX_FALSE, &~~JoinAttribute~~ );
	** ==> CallFlow::OnLegJoinDone( pLegA, pLegB, [hd] )		** ==> CallFlow::OnLegJoinDone( pLegA, pLegB, [hd] )
	* pLegB->Join( pLegA, NULL, TBX_FALSE, &~~JoinAttribute~~ );		* pLegB->Join( pLegA, NULL, TBX_FALSE, &HdJoin );
	** ==> CallFlow::OnLegJoinDone( pLegB, pLegA, [hd] ) // This confirms that join direction has been inverted		** ==> CallFlow::OnLegJoinDone( pLegB, pLegA, [hd] ) // This confirms that join direction has been inverted
	* pLegB->Unjoin( pLegA );		* pLegB->Unjoin( pLegA );

Abrassard: /* Scenario: Changing from hald-duplex to full-duplex */

2014-03-05T14:05:15Z

Scenario: Changing from hald-duplex to full-duplex

← Older revision		Revision as of 10:05, 5 March 2014
Line 363:		Line 363:

	=== Scenario: Changing from hald-duplex to full-duplex ===		=== Scenario: Changing from hald-duplex to full-duplex ===
	''LegA ---> LegB'' ===> ''~~LegB~~ <---> ~~LegA~~''<br/><br/>		''LegA ---> LegB'' ===> ''LegA <---> LegB''<br/><br/>
	A ''Join'' operation on two legs already joined together will override the join attributes.		A ''Join'' operation on two legs already joined together will override the join attributes.
	* CTBCMC_JOIN_ATTRIBUTE ~~JoinAttribute~~;		* CTBCMC_JOIN_ATTRIBUTE HdJoin;
	* ~~JoinAttribute~~.IsFullDuplex() = TBX_FALSE;		* HdJoin.IsFullDuplex() = TBX_FALSE;
	* pLegA->Join( pLegB, NULL, TBX_FALSE, &~~JoinAttribute~~ );		* pLegA->Join( pLegB, NULL, TBX_FALSE, &HdJoin);
	** ==> CallFlow::OnLegJoinDone( pLegA, pLegB, [hd] )		** ==> CallFlow::OnLegJoinDone( pLegA, pLegB, [hd] )
	* pLegA->Join( pLegB ); // NULL attributes default to full-duplex		* pLegA->Join( pLegB ); // NULL attributes default to full-duplex
Line 373:		Line 373:
	* pLegA->Unjoin( pLegB );		* pLegA->Unjoin( pLegB );
	** ==> CallFlow::OnLegUnjoinDone( pLegA, pLegB, [hd] )		** ==> CallFlow::OnLegUnjoinDone( pLegA, pLegB, [hd] )

			=== Scenario: Audio forking ===
			LegA <---> LegB
			---> LegC
			---> LegD
			LegB ---> LegE

			There is no limit on audio forking, as long as all legs receive audio from at most one source.
			* pLegA->Join( pLegB );
			** ==> CallFlow::OnLegJoinDone( pLegA, pLegB, [fd] )
			* pLegA->Join( pLegC, NULL, TBX_FALSE, &HdJoin);
			** ==> CallFlow::OnLegJoinDone( pLegA, pLegC, [hd] )
			* pLegA->Join( pLegD, NULL, TBX_FALSE, &HdJoin);
			** ==> CallFlow::OnLegJoinDone( pLegA, pLegD, [hd] )
			* pLegB->Join( pLegE, NULL, TBX_FALSE, &HdJoin);
			** ==> CallFlow::OnLegJoinDone( pLegB, pLegE, [hd] )
			* pLegA->TerminateCall()
			** ==> CallFlow::OnLegUnjoinDone( pLegA, pLegB, [fd] )
			** ==> CallFlow::OnLegUnjoinDone( pLegA, pLegC, [hd] )
			** ==> CallFlow::OnLegUnjoinDone( pLegA, pLegD, [hd] )
			** ==> CallFlow::OnCallLegTerminated( pLegA )

	== Re-synchronizing with [[Toolpack_Application:toolpack_engine\|toolpack_engine]] ==		== Re-synchronizing with [[Toolpack_Application:toolpack_engine\|toolpack_engine]] ==