undefined

Video Calling

ConnectyCube Video Calling P2P API is built on top of WebRTC protocol and based on top of WebRTC Mesh architecture.

Max people per P2P call is 4.

Get started with SDK

Follow the Getting Started guide on how to connect ConnectyCube SDK and start building your first app.

Code samples

There are ready-to-go FREE code samples to help you better understand how to integrate video calling capabilities in your apps:

  • Video Chat code sample for React Native src code
  • Video Chat code sample for Cordova/PhoneGap - src code
  • Video Chat code sample for browser - src code

Preparations

ConnectyCube Chat API is used as a signaling transport for Video Calling API, so in order to start using Video Calling API you need to connect to Chat.

Create video session

In order to use Video Calling API you need to create a session object - choose your opponents with whom you will have a call and a type of session (VIDEO or AUDIO):

const calleesIds = [56, 76, 34]; // User's ids
const sessionType = ConnectyCube.videochat.CallType.VIDEO; // AUDIO is also possible
const additionalOptions = {};
const session = ConnectyCube.videochat.createNewSession(calleesIds, sessionType, additionalOptions);

Access local media stream

In order to have a video chat session you need to get an access to the user's devices (webcam / microphone):

const mediaParams = {
    audio: true,
    video: true,
    elementId: 'myVideoElementId' // ID of audio/video DOM element to attach a video stream to
};

// JS SDK v1
session.getUserMedia(mediaParams, (error, stream) => {});

// JS SDK v2
session
    .getUserMedia(mediaParams)
    .then(stream => {})
    .catch(error => {});

This method lets the browser ask the user for permission to use devices. You should allow this dialog to access the stream. Otherwise, the browser can't obtain access and will throw an error for getUserMedia callback function.

For more information about possible audio/video constraints, here is a good code sample from WebRTC team how to work with getUserMedia constraints: https://webrtc.github.io/samples/src/content/getusermedia/resolution/

Attach local media stream

You can also attach your local media stream to HTML video element, if you don't pass the elementId key in parameters to getUserMedia.

To do this use the following method:

session.attachMediaStream('myVideoElementId', stream);

Initiate a call

const extension = {};
session.call(extension, error => {});

The extension is used to pass any extra parameters in the request to your opponents.

After this, your opponents will receive a callback call:

ConnectyCube.videochat.onCallListener = function(session, extension) {};

Or if your opponents are offline or did not answer the call request:

ConnectyCube.videochat.onUserNotAnswerListener = function(session, userId) {};

Accept a call

To accept a call the following code snippet is used:

ConnectyCube.videochat.onCallListener = function(session, extension) {
    // here show some UI with 2 buttons - accept & reject, and by accept -> run the following code:
    const extension = {};
    session.accept(extension);
};

After this, your opponents will get a confirmation in the following callback:

ConnectyCube.videochat.onAcceptCallListener = function(session, userId, extension) {};

Also, both the caller and opponents will get a special callback with the remote stream:

ConnectyCube.videochat.onRemoteStreamListener = function(session, userID, remoteStream) {
    // attach the remote stream to DOM element
    session.attachMediaStream('remoteOpponentVideoElementId', remoteStream);
};

From this point, you and your opponents should start seeing each other.

Reject a call

const extension = {};
session.reject(extension);

After this, the caller will get a confirmation in the following callback:

ConnectyCube.videochat.onRejectCallListener = function(session, userId, extension) {};

End a call

const extension = {};
session.stop(extension);

After this, the opponents will get a confirmation in the following callback:

ConnectyCube.videochat.onStopCallListener = function(session, userId, extension) {};

Monitor session connections state

There is a callback function to track the session state:

ConnectyCube.videochat.onSessionConnectionStateChangedListener = function(session, userID, connectionState) {};

The possible values of connectionState are those of an enum of type ConnectyCube.videochat.SessionConnectionState:

  • ConnectyCube.videochat.SessionConnectionState.UNDEFINED
  • ConnectyCube.videochat.SessionConnectionState.CONNECTING
  • ConnectyCube.videochat.SessionConnectionState.CONNECTED
  • ConnectyCube.videochat.SessionConnectionState.FAILED
  • ConnectyCube.videochat.SessionConnectionState.DISCONNECTED
  • ConnectyCube.videochat.SessionConnectionState.CLOSED
  • ConnectyCube.videochat.SessionConnectionState.COMPLETED

Mute audio

session.mute('audio');
session.unmute('audio');

Mute video

session.mute('video');
session.unmute('video');

Switch video cameras

First of all you need to obtain all your device's available cameras:

let deviceInfo, deviceId, deviceLabel;

ConnectyCube.videochat
    .getMediaDevices('videoinput')
    .then(devices => {
        if (devices.length) {
            // here is a list of all available cameras
            for (let i = 0; i !== devices.length; ++i) {
                deviceInfo = devices[i];
                deviceId = deviceInfo.deviceId;
                deviceLabel = deviceInfo.label;
            }
        }
    })
    .catch(error => {});

Then you can choose some deviceId and switch the video stream to exact this device:

const constraints = { video: deviceId };

// JS SDK v1
session.switchMediaTracks(constraints, (error, stream) => {});

// JS SDK v2
session
    .switchMediaTracks(constraints)
    .then(stream => {})
    .catch(error => {});

Switch audio tracks

The same can be applied for audio tracks as well. Just replace a videoinput to audioinput in getMediaDevices and video to audio in constraints.

Group video calls

Because of Mesh architecture we use for multipoint where every participant sends and receives its media to all other participants, current solution supports group calls with up to 4 people.

Also ConnectyCube provides an alternative solution for up to 10 people. Please contact us via Contact form.