Events

VoxImplant.Events.AuthResult

Event dispatched after login , loginWithOneTimeKey, requestOneTimeLoginKey or loginWithCode function call.

Properties
  • code: Number

    Auth error code, possible values are: 301 - code for 'code' auth type was sent, 302 - key for 'onetimekey' auth type received, 401 - invalid password, 404 - invalid username, 403 - user account is frozen, 500 - internal error.

  • displayName: String

    Authorized user's display name

  • key: String

    This parameter is used to calculate hash parameter for loginWithOneTimeKey method. AuthEvent with the key dispatched after requestOneTimeLoginKey method was called.

  • options: Object

    Application options

  • result: Boolean

    True in case of successful authorization, false - otherwise.

VoxImplant.Events.ConnectionClosed

Event dispatched if connection to VoxImplant Cloud was closed because of network problems. See connect function.

VoxImplant.Events.ConnectionEstablished

Event dispatched after connection to VoxImplant Cloud was established successfully. See connect function.

VoxImplant.Events.ConnectionFailed

Event dispatched if connection to VoxImplant Cloud couldn't be established. See connect function.

Properties
  • message: String

    Failure reason description

VoxImplant.Events.IncomingCall

Event dispatched when there is a new incoming call to current user.

Properties

VoxImplant.Events.MicAccessResult

Event dispatched after user interacted with mic access dialog.

Properties
  • result: Boolean

    True is access was allowed, false - otherwise.

  • stream: MediaStream

    MediaStream object (WebRTC only)

VoxImplant.Events.NetStatsReceived

Event dispatched when packet loss data received from VoxImplant servers

Properties

VoxImplant.Events.PlaybackFinished

Event dispatched after sound playback was stopped. See playToneScript and stopPlayback functions.

VoxImplant.Events.RTCStatsReceived

Event dispatched to notify about WebRTC stats collected by browser

Properties
  • stats: Object

    RTC stats object

VoxImplant.Events.SDKReady

Event dispatched after SDK was successfully initialized after init function call

Properties
  • version: String

    SDK version

VoxImplant.Events.SourcesInfoUpdated

Event dispatched when the info about available audio and video recording / playback devices received. See audioSources, videoSources and audioOutputs for details.