voximplant-websdk

This is documentation of WebSDK v4 RC!

Important notice: Flash support has been removed!

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 you need to add javascript library to your webpage:

Initialization

After 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 SDK is initialized SDKReady event will be fired. You can start using SDK functions only after this event. Use connect function to establish connection with VoxImplant Cloud:

Changelog

  • 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)