Actions

CAF: Caf Mixer Actions: Difference between revisions

mNo edit summary
 
(4 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{DISPLAYTITLE:CAF: Caf Mixer Actions}}
== Actions on mixers ==
== Actions on mixers ==
The call flow (and it's behaviors) can perform various actions on each of it's mixers. Here is a list of the actions available on the CTBCAFMixer objects (please refer to the header file CTBCMCMixer.hpp for more information on each of these functions):
The call flow (and its behaviors) can perform various actions on each of its mixers. Here is a list of the actions available on the CTBCAFMixer objects (please refer to the header file CTBCMCMixer.hpp for more information on each of these functions):
    
    
=== Controlling creation, modification and destruction in Toolpack system: ===
=== Controlling creation, modification and destruction in Toolpack system: ===
Line 17: Line 18:
  - MixerResumeStream()
  - MixerResumeStream()
  - MixerStopStream()
  - MixerStopStream()
=== Digits (tone) and events: ===
- MixerPlayDigit()
- MixerPlayEvent()
- MixerCancelEvent()


=== States can be queried instantly: ===
=== States can be queried instantly: ===
Line 34: Line 29:
=== Mixer information can be queried instantly: ===
=== Mixer information can be queried instantly: ===
  - GetMixerId()
  - GetMixerId()
  - GetAttributes()
  - GetMixerAttributes()
  - GetLegs()
  - GetJoinedLegs()
- GetJoinedMixers()
- GetJoinedLegAttributes()
- GetJoinedMixerAttributes()

Latest revision as of 10:23, 6 September 2022

Actions on mixers

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

Controlling creation, modification and destruction in Toolpack system:

- MixerCreate()
- MixerTerminate()
- MixerSetAttribute()

Inserting / removing call legs (or other mixers) from the mixer

- MixerJoin()
- MixerUnjoin()

Playing/recording audio

- MixerPlayStream()
- MixerRecordStream()
- MixerPauseStream()
- MixerResumeStream()
- MixerStopStream()

States can be queried instantly:

- IsTerminating()
- IsSynchronized()
- IsPlayingStream()
- IsRecordingStream()
- IsPlayingDigit()
- IsPlayingEvent()

Mixer information can be queried instantly:

- GetMixerId()
- GetMixerAttributes()
- GetJoinedLegs()
- GetJoinedMixers()
- GetJoinedLegAttributes()
- GetJoinedMixerAttributes()