Enumeration CallEvents

Events dispatched by VoxImplant.Call instance.
Use VoxImplant.Call.addEventListener function to subscribe on any of these events.
Example:

Index

Enumeration members

Connected

Connected:

Event dispatched after a realible connection is established for the call. Depending on network conditions there can be a 2-3 secondd delay between first audio data and this event.

call

call: Call

Call that dispatched the event

Optional headers

headers: Object

Optional SIP headers are received with the message

Disconnected

Disconnected:

Event dispatched after a call was disconnected

call

call: Call

Call that dispatched the event

Optional headers

headers: Object

Optional SIP headers are received with the message

Optional params

params: boolean

Optional disconnecting flags

Failed

Failed:

Event dispatched after a call failure
Most frequent status codes:

Code Description
486 Destination number is busy
487 Request terminated
603 Call was rejected
404 Invalid number
480 Destination number is unavailable
402 Insufficient funds

call

call: Call

Call that dispatched the event

code

code: number

Call status code (i.e. 486)

Optional headers

headers: Object

Optional SIP headers are received with the message

reason

reason: string

Status message of a call failure (i.e. Busy Here)

ICECompleted

ICECompleted:

Event dispatched when ICE connection is complete

call

call: Call

Call that dispatched the event

ICETimeout

ICETimeout:

Event dispatched if connection was not established due to a network connection problem between 2 peers

call

call: Call

Call that dispatched the event

InfoReceived

InfoReceived:

Event dispatched when INFO message is received

body

body: string

Content of the message

call

call: Call

Call that dispatched the event

Optional headers

headers: Object

Optional SIP headers are received with the message

mimeType

mimeType: string

MIME type of INFO message

MediaElementCreated

MediaElementCreated:

Event dispatched when a new HTMLMediaElement for the call's media playback has been created

call

call: Call

Call that dispatched the event

element

element: HTMLMediaElement

Renderer element

type

type: string

Type of media

MessageReceived

MessageReceived:

Event dispatched when a text message is received

call

call: Call

Call that dispatched the event

text

text: string

Content of the message

PendingUpdate

PendingUpdate:

Event dispatched when user receives the call update from another side. For example, video added or removed on the remote side.

call

call: Call

Call that dispatched the event

ProgressToneStart

ProgressToneStart:

Event dispatched when a progress tone playback starts

call

call: Call

Call that dispatched the event

ProgressToneStop

ProgressToneStop:

Event dispatched when a progress tone playback stops

call

call: Call

Call that dispatched the event

RTCStatsReceived

RTCStatsReceived:

TransferComplete

TransferComplete:

Event dispatched when a call has been transferred successfully

call

call: Call

Call that dispatched the event

TransferFailed

TransferFailed:

Event dispatched when a call transfer failed

call

call: Call

Call that dispatched the event

UpdateFailed

UpdateFailed:

Event dispatched when multiple participants tried to update the same call simultaneously. For example, video added or removed on a local and remote side at the same time.

call

call: Call

Call that dispatched the event

code

code: number

Most frequent status codes:

Code Description

10 Timeout

11 Trying to hold call in wrong state

12 Trying change call in state UPDATING

13 Media access rejected

14 Trying change call state to the same state

20 Server reject

Updated

Updated:

Event dispatched when the call was updated. For example, video added or removed.

call

call: Call

Call that dispatched the event

result

result: boolean

True in case of successful renegotiation, false - otherwise

VideoPlaybackStarted

VideoPlaybackStarted: