Interface IMultiInitialState

Optional initial state for IMultiCallControl.

Used to set the initial state if the device was changed in the middle of a call, or to recover the state after device disconnections.

interface IMultiInitialState {
    muted?: boolean;
    ongoingCalls: number;
    onHold?: boolean;
}

Properties

muted?: boolean

true to mute the device and false to unmute.

Can only be set to true if IMultiInitialState.ongoingCalls is a positive integer (greater than zero).

ongoingCalls: number

Determines the number of ongoing calls at the time of initialization. When set to 0, no ongoing calls are happening.

If set to 0, subsequent arguments for IMultiInitialState.muted and IMultiInitialState.onHold will be ignored (setting mute or hold state on an idle device is not supported).

onHold?: boolean

true to hold the device and false to not hold the device.

Can only be set to true if IMultiInitialState.ongoingCalls is a positive integer (greater than zero).