Call

Deprecated

Call

Deprecated

A Call represents a one-to-one call with another browser, a SIP endpoint, or even a phone number. The Call object supports both audio and video.

Properties

Name	Type	Description
`id`	`string`	The identifier of the call.
`direction`	`string`	The direction of the call. Can be either `inbound` or `outbound`.
`state`	`string`	The state of the call. See State for all the possible call states.
`prevState`	`string`	The previous state of the call. See State for all the possible call states.
`localStream`	`MediaStream`	The local stream of the call. This can be used in a video/audio element to play the local media.
`remoteStream`	`MediaStream`	The remote stream of the call. This can be used in a video/audio element to play the remote media.

State

The state and prevState properties of a Call have the following values:

Value	Description
`new`	New Call has been created in the client.
`trying`	You are attempting to call someone.
`requesting`	Your outbound call is being sent to the server.
`recovering`	Your previous call is recovering after the page refresh. If you refresh the page during a call, you will automatically be joined with the latest call.
`ringing`	Someone is attempting to call you.
`answering`	You are attempting to answer the inbound Call.
`early`	You received the media before the Call has been answered.
`active`	Call has become active.
`held`	Call has been held.
`hangup`	Call has ended.
`destroy`	Call has been destroyed.
`purge`	Call has been purged.

Methods

answer

Start the process to answer the incoming Call.

Parameters

None

Returns

None

Example

1 call.answer()

deaf

Turn off the audio input track.

Example

1 call.deaf()

dtmf

Send a Dual Tone Multi Frequency (DTMF) string to RELAY.

Parameters

Name	Type	Required	Description
`string`	`string`	required	`DTMF` to send.

Returns

None

Examples

1 call.dtmf('0')

hangup

Hangs up the call.

Parameters

None

Returns

None

Examples

1 call.hangup()

hold

Holds the call.

Parameters

None

Returns

None

Examples

1 call.hold()

muteAudio

Turn off the audio output track.

Example

1 call.muteAudio()

muteVideo

Turn off the video output track.

Example

1 call.muteVideo()

setAudioInDevice

Change the audio input device used for the Call.

Example

1 // within an async function ..
2 const success = await call.setAudioInDevice('d346d0f78627e3b808cdf0c2bc0b25b4539848ecf852ff03df5ac7545f4f5398')
3 if (success) {
4   // The Call audio input has been set to the device 'd346d0f78627e3b808cdf0c2bc0b25b4539848ecf852ff03df5ac7545f4f5398'
5 } else {
6   // The browser does not support the .setSinkId() API..
7 }

setAudioOutDevice

Change the audio output device used for the Call.

Example

1 // within an async function ..
2 const success = await call.setAudioOutDevice('d346d0f78627e3b808cdf0c2bc0b25b4539848ecf852ff03df5ac7545f4f5398')
3 if (success) {
4   // The Call audio has been redirect to the device 'd346d0f78627e3b808cdf0c2bc0b25b4539848ecf852ff03df5ac7545f4f5398'
5 } else {
6   // The browser does not support the .setSinkId() API..
7 }

setVideoDevice

Change the video output device used for the Call.

Example

1 // within an async function ..
2 const success = await call.setVideoDevice('d346d0f78627e3b808cdf0c2bc0b25b4539848ecf852ff03df5ac7545f4f5398')
3 if (success) {
4   // The Call video has been redirect to the device 'd346d0f78627e3b808cdf0c2bc0b25b4539848ecf852ff03df5ac7545f4f5398'
5 } else {
6   // The browser does not support the .setSinkId() API..
7 }

toggleAudioMute

Toggle the audio output track.

Example

1 call.toggleAudioMute()

toggleHold

Toggles the hold state of the call.

Parameters

None

Returns

None

Examples

1 call.toggleHold()

toggleVideoMute

Toggle the video output track.

Example

1 call.toggleVideoMute()

undeaf

Turn on the audio input track.

Example

1 call.undeaf()

unhold

Un-holds the call.

Parameters

None

Returns

None

Examples

1 call.unhold()

unmuteAudio

Turn on the audio output track.

Example

1 call.unmuteAudio()

unmuteVideo

Turn on the video output track.

Example

1 call.unmuteVideo()

A Call represents a one-to-one call with another browser, a SIP endpoint, or even a phone number. The Call object supports both audio and video.

Properties

Name	Type	Description
`id`	`string`	The identifier of the call.
`direction`	`string`	The direction of the call. Can be either `inbound` or `outbound`.
`state`	`string`	The state of the call. See State for all the possible call states.
`prevState`	`string`	The previous state of the call. See State for all the possible call states.
`localStream`	`MediaStream`	The local stream of the call. This can be used in a video/audio element to play the local media.
`remoteStream`	`MediaStream`	The remote stream of the call. This can be used in a video/audio element to play the remote media.

State

The state and prevState properties of a Call have the following values:

Value	Description
`new`	New Call has been created in the client.
`trying`	You are attempting to call someone.
`requesting`	Your outbound call is being sent to the server.
`recovering`	Your previous call is recovering after the page refresh. If you refresh the page during a call, you will automatically be joined with the latest call.
`ringing`	Someone is attempting to call you.
`answering`	You are attempting to answer the inbound Call.
`early`	You received the media before the Call has been answered.
`active`	Call has become active.
`held`	Call has been held.
`hangup`	Call has ended.
`destroy`	Call has been destroyed.
`purge`	Call has been purged.

Methods

answer

Start the process to answer the incoming Call.

Parameters

None

Returns

None

Example

1 call.answer()

deaf

Turn off the audio input track.

Example

1 call.deaf()

dtmf

Send a Dual Tone Multi Frequency (DTMF) string to RELAY.

Parameters

Name	Type	Required	Description
`string`	`string`	required	`DTMF` to send.

Returns

None

Examples

1 call.dtmf('0')

hangup

Hangs up the call.

Parameters

None

Returns

None

Examples

1 call.hangup()

hold

Holds the call.

Parameters

None

Returns

None

Examples

1 call.hold()

muteAudio

Turn off the audio output track.

Example

1 call.muteAudio()

muteVideo

Turn off the video output track.

Example

1 call.muteVideo()

setAudioInDevice

Change the audio input device used for the Call.

Example

1 // within an async function ..
2 const success = await call.setAudioInDevice('d346d0f78627e3b808cdf0c2bc0b25b4539848ecf852ff03df5ac7545f4f5398')
3 if (success) {
4   // The Call audio input has been set to the device 'd346d0f78627e3b808cdf0c2bc0b25b4539848ecf852ff03df5ac7545f4f5398'
5 } else {
6   // The browser does not support the .setSinkId() API..
7 }

setAudioOutDevice

Change the audio output device used for the Call.

Example

1 // within an async function ..
2 const success = await call.setAudioOutDevice('d346d0f78627e3b808cdf0c2bc0b25b4539848ecf852ff03df5ac7545f4f5398')
3 if (success) {
4   // The Call audio has been redirect to the device 'd346d0f78627e3b808cdf0c2bc0b25b4539848ecf852ff03df5ac7545f4f5398'
5 } else {
6   // The browser does not support the .setSinkId() API..
7 }

setVideoDevice

Change the video output device used for the Call.

Example

1 // within an async function ..
2 const success = await call.setVideoDevice('d346d0f78627e3b808cdf0c2bc0b25b4539848ecf852ff03df5ac7545f4f5398')
3 if (success) {
4   // The Call video has been redirect to the device 'd346d0f78627e3b808cdf0c2bc0b25b4539848ecf852ff03df5ac7545f4f5398'
5 } else {
6   // The browser does not support the .setSinkId() API..
7 }

toggleAudioMute

Toggle the audio output track.

Example

1 call.toggleAudioMute()

toggleHold

Toggles the hold state of the call.

Parameters

None

Returns

None

Examples

1 call.toggleHold()

toggleVideoMute

Toggle the video output track.

Example

1 call.toggleVideoMute()

undeaf

Turn on the audio input track.

Example

1 call.undeaf()

unhold

Un-holds the call.

Parameters

None

Returns

None

Examples

1 call.unhold()

unmuteAudio

Turn on the audio output track.

Example

1 call.unmuteAudio()

unmuteVideo

Turn on the video output track.

Example

1 call.unmuteVideo()

1	// within an async function ..
2	const success = await call.setAudioInDevice('d346d0f78627e3b808cdf0c2bc0b25b4539848ecf852ff03df5ac7545f4f5398')
3	if (success) {
4	// The Call audio input has been set to the device 'd346d0f78627e3b808cdf0c2bc0b25b4539848ecf852ff03df5ac7545f4f5398'
5	} else {
6	// The browser does not support the .setSinkId() API..
7	}

1	// within an async function ..
2	const success = await call.setAudioOutDevice('d346d0f78627e3b808cdf0c2bc0b25b4539848ecf852ff03df5ac7545f4f5398')
3	if (success) {
4	// The Call audio has been redirect to the device 'd346d0f78627e3b808cdf0c2bc0b25b4539848ecf852ff03df5ac7545f4f5398'
5	} else {
6	// The browser does not support the .setSinkId() API..
7	}

1	// within an async function ..
2	const success = await call.setVideoDevice('d346d0f78627e3b808cdf0c2bc0b25b4539848ecf852ff03df5ac7545f4f5398')
3	if (success) {
4	// The Call video has been redirect to the device 'd346d0f78627e3b808cdf0c2bc0b25b4539848ecf852ff03df5ac7545f4f5398'
5	} else {
6	// The browser does not support the .setSinkId() API..
7	}