voximplant-websdk

Important notice: Flash support has been removed!

Documentation for legacy version of WebSDK

You can get online help and/or report bugs on special gitter room

Web SDK allows you to embed voice and video communication into your web applications.

Installation

Browser

To start using VoxImplant Web SDK of the latest version you need to add javascript library to your webpage:

Initialization

When Web SDK is loaded you can use VoxImplant.getInstance function to get VoxImplant.Client instance and initialize it using init function. See the example below:

After the completing of SDK initialization the SDKReady event will be triggered. It means that you can start using SDK functions. You have to use the connect function firstly to establish a connection with VoxImplant Cloud:

Changelog

  • 4.2.1 (2017-10-19)

    New

    - Client.getClientState function
    - Call.getCallDuration function

    Updated

    - Client.tokenRefresh now return a promise.
    - Call.stopSharingScreen now return a promise.

    Fixed

    - Client.setOperatorACDStatus a promise resolving fixed.
    - Call.shareScreen a promise resolving fixed.
    - Call.stopSharingScreen fixed on the peer-to-peer mode.
    - Call.sendVideo fixed video enabling in some cases.
    - CallEvents.MessageReceived fixed.
    - Exception on the "SendInfo" function.

  • 4.2.0 (2017-09-12)

    New

    - Apple's Safari 11 browser support
    - Audio and video calls support for MS Edge 16.16275+

    Updated

    - Client.addEventListener mark as deprecated
    - Client.removeEventListener mark as deprecated
    - Call.addEventListener mark as deprecated
    - Call.removeEventListener mark as deprecated
    - Auto restore mute state after updating call media

    Fixed

    - Fix for the problem in case if different H264first flag was specified in Client or Call config on caller and callee side.
    - CallEvents.RTCStatsReceived is now supported in Chrome 61+
    - Multiple fixes for Firefox 55+
    - IceTimeout Event fixed
    - Double progress tone fixed
    - Audio context error fixed
    - Messaging.Conversation.setCustomData fixed

  • 4.1.0 (2017-08-02)

    New

    - Screen sharing API. See "Screen Sharing in VoxImplant" at the Voximplant blog
    - Messenger API moved to Messaging module.
    - Add presence to the Messenger API. See Messenger.setStatus, Messenger.Subscribe and Messenger.Unsubscribe
    - Multiple bug fixes.

  • 4.0.6 (2017-04-10)

    New

    - VideoFlags structure for Client.call() asd Call.answer()
    - Client.setCallActive and Call.setActive return promise.

  • 4.0.5 (2017-01-27)

    New

    - New alias functions for add/remove event listeners Client.on(event,handler); Client.off(event,handler); Call.on(event,handler); Call.off(event,handler);
    - Video flag for incomingCall event and Call.answer function.
    - Messenger API.
    - SDKv4 published to NPM repository.
    - New media stream pipeline for Firefox.
    - Messenger API.
    - SDKv4 published to NPM repository.
    - New media stream pipeline for Firefox.

  • 4.0.4 (2017-01-02)

    New

    - Added token-based login method for logging in using stored auth data.
    - Callstats.io integration.

    Fix

    - Disable reconnect after manual disconnect.
    - Client.useAudioSource force attach microphone.
    - Disable logging by default.
    - Client.useAudioSource force attach microphone.
    - Disable logging by default.

  • 4.0.3 (2016-09-01)

    New

    - New Config.rtcStatsCollectionInterval – RTC stats collecting interval in ms (default 10000)

    Fix

    - Fix ICE timeout size to 20 sec.

  • 4.0.2 (2016-08-09)

    New

    - Updated event CallEvent.Failed has new parameter - reason instance of DisconnectingFlags object. DisconnectingFlags.answeredElsewhere display, if call answered elsewhere.
    - Updated a MediaStream processing for WebRTC audio/video sync.
    - Updated function Client.init returns a Promise with Events.SDKReady result.
    - Updated function Client.call now use instanse of the CallSettings object (Old Client.call function was saved, but deprecated)
    - New boolean flag H264first added to the Сonfig object. If set to TRUE - all new calls will use H.264 as a default preffered video codec.
    - New boolean flag H264first added to the CallSettings object. If set to TRUE - new call will use H.264 as a preffered video codec.
    - New method Call.sendVideo(bool) - enable/disable sending video for the current call on the fly.
    - New method Call.rearangeCodecs() - sort preffered codecs ussing a user-defined function.
    - New method Call.getLocalStream() - get a media streams from the call.
    - New method Сall.setLocalStream() - replace a media stream of the call.
    - New method Call.addLocalStream() - add aditional media streams to the call.
    - New support for audio-only calls in Microsoft Edge (ORTC)
    - New event CallEvent.ICECompleted - indicate, that ICE server connect was succesfull.
    - Added CallEvents.RendererCreated event for rendering screen sharing and multiple streams per PC.

    Fix

    - Fix handle webcam busy state, when another application use it (Windows)