Skip to main content

Home > @gnaudio/jabra-js > ICallControl

ICallControl interface#

Defines the necessary functionality for call control: - being able to start/end a call, - mute/unmute the microphone, - hold/resume a call, - start/stop the ringer on the device, - events for emitted signals from the device, and - the required call lock for executing all of these functions.

Signature:
interface ICallControl

Remarks#

All of this functionality is associated with a single physical device. For every connected Jabra headset, there is an additional instance of ICallControl that is used to manipulate its call-related state and functionality.

Properties#

PropertyTypeDescription
deviceISdkDeviceThe single physical device to which the call control functionalities are associated to.
deviceSignalsObservable<ICallControlSignal>Observable for signals emitted by the device.Whenever the device sends a new signal, this observable will be populated with ICallControlSignal instances for each emission.

Methods#

MethodDescription
hold(shouldHold)Tells the device whether an active call was put on hold or a held up call was resumed.
mute(shouldMute)Mutes or unmutes the microphone of the Jabra device.
offHook(isOffHook)Informs the Jabra device that there's a change in the call status.
releaseCallLock()Releases a previously acquired call lock.Releasing the call lock is the last step in performing call control operations so remember to execute it once you are done with the Jabra device.
ring(shouldRing)Starts or ends the "ring" effect on the Jabra device. Used to indicate an incoming call.
takeCallLock()Tries to acquire a call lock. The call lock is a unique, per-device lock, and is required in order to change the state of the device.Acquiring the call lock should always be the first step in performing call control operations.