Actions

CAF: Caf Call Leg Actions: Difference between revisions

m (typos)
No edit summary
 
Line 1: Line 1:
{{DISPLAYTITLE:ASR}}
{{DISPLAYTITLE:CAF: Caf Call Leg Actions}}


== Actions on call legs ==
== Actions on call legs ==

Latest revision as of 10:21, 6 September 2022


Actions on call legs

The call flow (and its behaviors) can perform various actions on each of its call legs. Here is a list of the actions available on the CTBCAFCallLeg objects (please refer to the header file CTBCMCLeg.hpp for more information on each of these functions):

Controlling call flow:

- AcceptCall()
- AlertCall()
- AnswerCall()
- ProgressCall()
- SendCallSuppInfo()
- TerminateCall()
- CallTransferRequest()
- CallTransferProgress()
- CallTransferResponse()

Controlling media flow between two call legs

- Join()
- Unjoin()

Playing/recording audio

- PlayStream()
- RecordStream()
- PauseStream()
- ResumeStream()
- StopStream()

Digits (tone) and events:

- PlayDigit()
- StartDigitCollection()
- StopDigitCollection()
- PlayEvent()
- CancelEvent()
- StartEventCollection()
- StopEventCollection()

Controlling profile or stats:

- SetProfile()
- ChangeProfile()
- GetStats()


States can be queried instantly:

- IsTerminating()
- IsAccepted()
- IsAlerted()
- IsAnswered()
- IsSynchronized()
- IsPlayingStream()
- IsRecordingStream()
- IsPlayingDigit()
- IsPlayingEvent()
- IsJoined()

Call information can be queried instantly:

- GetLegId()
- GetLinkId()
- GetAttributes()
- GetProfile()
- GetJoinedLegs()
- GetJoinedLegAttributes()
- GetJoinAttributes()
- GetListenerMixer()
- GetSpeakerMixers()