CometChat Pro Documentation

You'll find comprehensive guides and documentation to help you start working with CometChat as quickly as possible. Let's jump right in!

Default Calling

This section will provide information on how a complete calling workflow can be set up using CometChat. We've built the complete workflow to help your users make calls, receive calls as well as accept/reject calls.

Let us assume Alex to be the call initiator and Bob is the receiver.

  1. Alex initiates the call to Bob using the initiateCall() method.
  2. Bob now has two choices:
    -> Accept the call from Alex using the acceptCall() method.
    -> Reject the call from Alex using the rejectCall("rejected") method passing the status as rejected.
  3. In the meantime, Alex has the option to cancel the call he initiated to Bob using the
    rejectCall("cancelled") method passing the status as cancelled.
  4. If Bob accepts the call from Alex, both Alex and Bob need to call the startCall() method. Alex in the onOutgoingCallAccepted() method of the CallListener and Bob in the success obtained from the acceptCall() method and both will be connected to each other.

Initiate Call

The initiateCall() method sends a call request to a user or a group.

var receiverID = "UID";
var callType = CometChat.CALL_TYPE.VIDEO;
var receiverType = CometChat.RECEIVER_TYPE.USER;

var call = new CometChat.Call(receiverID, callType, receiverType);

CometChat.initiateCall(call).then(
  outGoingCall => {
    console.log("Call initiated successfully:", outGoingCall);
    // perform action on success. Like show your calling screen.
  },
  error => {
    console.log("Call initialization failed with exception:", error);
  }
);
var receiverID = "GUID";
var callType = CometChat.CALL_TYPE.VIDEO;
var receiverType = CometChat.RECEIVER_TYPE.GROUP;

var call = new CometChat.Call(receiverID, callType, receiverType);

CometChat.initiateCall(call).then(
  outGoingCall => {
    console.log("Call initiated successfully:", outGoingCall);
    // perform action on success. Like show your calling screen.
  },
  error => {
    console.log("Call initialization failed with exception:", error);
  }
);

This method takes an object of the Call class. The constructor for Call class takes the following parameters:

Parameter

Description

receiverID

The UID or GUID of the recipient

receiverType

The type of the receiver viz.
1.CometChat.RECEIVER_TYPE.USER
2.CometChat.RECEIVER_TYPE.GROUP

callType

The type of call viz.
1.CometChat.CALL_TYPE.AUDIO
2.CometChat.CALL_TYPE.VIDEO

On successful initialization, a Call object is returned with the details of the call including a unique session ID for the call.

Receive Calls

Wherever you wish to receive the call events in, you need to register the CallListener listener using the addCallListener() method.

var listnerID = "UNIQUE_LISTENER_ID";
CometChat.addCallListener(
  listnerID,
  new CometChat.CallListener({
    onIncomingCallReceived(call) {
      console.log("Incoming call:", call);
      // Handle incoming call
    },
    onOutgoingCallAccepted(call) {
      console.log("Outgoing call accepted:", call);
      // Outgoing Call Accepted
    },
    onOutgoingCallRejected(call) {
      console.log("Outgoing call rejected:", call);
      // Outgoing Call Rejected
    },
    onIncomingCallCancelled(call) {
      console.log("Incoming call calcelled:", call);
    }
  })
);

Parametrer

Description

listenerID

An ID that uniquely identifies that listener. We recommend using the activity or fragment name

We recommend you remove the listener once the activity or fragment is not in use.

var listenerID = "UNIQUE_LISTENER_ID";

CometChat.removeCallListener(listenerID);

As mentioned in the Overview section, Once the call is initiated, there are three options that can be possible:

  1. The receiver of the call accepts the call.
  2. The receiver of the call rejects the call.
  3. The initiator of the call cancels the call.

Please find below how these three scenarios can be implemented:

Accept the Incoming Call

Once you have received an incoming call from a user or in any group, to accept the call using the acceptCall() method.

var sessionID = "SESSION_ID";

CometChat.acceptCall(sessionID).then(
  call => {
    console.log("Call accepted successfully:", call);
    // start the call using the startCall() method
  },
  error => {
    console.log("Call acceptance failed with error", error);
    // handle exception
  }
);

Parameter

Description

sessionID

The unique session ID available in the Call object

Reject the Incoming Call

To reject the incoming call once it is received using the rejectCall() method.

var sessionID = "SESSION_ID";
var status = CometChat.CALL_STATUS.REJECTED;

CometChat.rejectCall(sessionID, status).then(
  call => {
    console.log("Call rejected successfully", call);
  },
  error => {
    console.log("Call rejection failed with error:", error);
  }
);

Parameter

Description

sessionID

The unique session ID available in the Call object

status

Reason for rejection of the call

Here the status needs to be set as CometChatConstants.CALL_STATUS_REJECTED as the call is being rejected by the receiver of the call.

Cancel the Outgoing Call

In the case where the initiator wishes to cancel the call, use the same above rejectCall() method and just pass the status to the rejectCall() method as CometChatConstants.CALL_STATUS_CANCELLED

Start a Call

Once the call request is sent and the receiver has accepted the call, both the initiator and the receiver need to call the startCall() method.

You need to call this method for two scenarios:

  1. After you accept an incoming call i.e. in the onSuccess() callback of the acceptCall() method.
  2. After the recipient accepts an outgoing call i.e. in the onOutgoingCallAccepted() callback of the CallListener listener.
/**
        * You can get the call Object from the success of acceptCall() or from the onOutgoingCallAccepted() callback of the CallListener.
        */
var sessionId = call.sessionId;
var callType = call.type;
var callSettings = new CometChat.CallSettingsBuilder()
                                    .setSessionID(sessionId)
                                    .enableDefaultLayout(true)
                                    .setIsAudioOnlyCall(callType == 'audio' ? true : false)
                                    .build();
CometChat.startCall(
  callSettings,
  document.getElementById("callScreen"),
  new CometChat.OngoingCallListener({
    onUserJoined: user => {
      /* Notification received here if another user joins the call. */
      console.log("User joined call:", user);
      /* this method can be use to display message or perform any actions if someone joining the call */
    },
    onUserLeft: user => {
      /* Notification received here if another user left the call. */
      console.log("User left call:", user);
      /* this method can be use to display message or perform any actions if someone leaving the call */
    },
    onCallEnded: call => {
      /* Notification received here if current ongoing call is ended. */
      console.log("Call ended:", call);
      /* hiding/closing the call screen can be done here. */
    },
    onError: error => {
      console.log("Error :", error);
      /* hiding/closing the call screen can be done here. */
    }
  })
);

📘

Please Note:

The current startCall() method which takes the sessionId, view, Ongoing Call Listener to load the call view is deprecated and will be replaced in the future versions. It will continue to work on this version but we suggest moving to the new method as shown above using the object of the CallSettings class as the parameter.

Parameter

Description

callSettings

Object of CallSettings class.

callScreen

DOM element where you want show the call UI.

OngoingCallListener

CometChat.OngoingCallListener where the real-time events will be received.

The OngoingCallListener listener provides you with the below callback methods:

Callback Method

Description

onUserJoined(User user)

This method is called when any other user joins the call. The user details can be obtained from the User object provided.

onUserLeft(User user)

This method is called when a user leaves the call. The details of the user can be obtained from the provided User object.

onError()

This method is called when there is some error in establishing the call.

onCallEnded()

This method is called when the call is successfully ended. The call details can be obtained from the Call object provided.

Settings

The CallSettings class is the most important class when it comes to the implementation of the Calling feature. This is the class that allows you to customize the overall calling experience. The properties for the call/conference can be set using the CallSettingsBuilder class. This will eventually give you an object of the CallSettings class which you can pass to the startCall() method to start the call.

The mandatory parameters that are required to be present for any call/conference to work are:

  1. sessionId - The unique session Id for the call/conference session.

The options available for customization of calls are:

Setting

Description

enableDefaultLayout(defaultLayout: boolean)

If set to true enables the default layout for handling the call operations.

If set to false it hides the button layout and just displays the Call View

Default value = true

showEndCallButton(showEndCallButton: boolean)

If set to true it displays the EndCallButton in Button Layout.

if set to false it hides the EndCallButton in Button Layout

Default value = true

showPauseVideoButton(showPauseVideoButton: boolean)

If set to true it displays the PauseVideoButton in Button Layout.

if set to false it hides the PauseVideoButton in Button Layout

Default value = true

showMuteAudioButton(showMuteAudioButton: boolean)

If set to true it displays the MuteAudioButton in Button Layout.

if set to false it hides the MuteAudioButton in Button Layout

Default value = true

showScreenShareButton(showScreenShareButton: boolean)

If set to true it displays the ShareScreenButton in Button Layout.

if set to false it hides the ShareScreenButton in Button Layout

Default value = true

setIsAudioOnlyCall(audioOnly: boolean)

If set to true, the call will be strictly an audio call. If ser to false, the call will be an audio-video call.

Default value = false

setMode(mode: string)

CometChat provides 3 options for the calling UI.

  1. CometChat.CALL_MODE.DEFAULT
  2. CometChat.CALL_MODE.SPOTLIGHT
  3. CometChat.CALL_MODE.SINGLE

Default value = CometChat.CALL_MODE.DEFAULT

In case you wish to achieve a completely customized UI for the Calling experience, you can do so by embedding default android buttons to the screen as per your requirement and then use the below methods to achieve different functionalities for the embedded buttons.

For the use case where you wish to align your own custom buttons and not use the default layout provided by CometChat, you can embed the buttons in your layout and use the below methods to perform the corresponding operations:

Mute Audio

You can call muteAudio(mute: boolean) Method to mute your Audio Stream to the end-user.

let callController = CometChat.CallController.getInstance();
callController.muteAudio(true);

if set to true the Audio Stream is muted and if set tofalse Audio Stream is transmitted.

Pause Video

You can call pauseVideo(pause: boolean) Method to pause Video Stream to the end-user.

let callController = CometChat.CallController.getInstance();
callController.pauseVideo(true);

if set to true the Video Stream is muted and if set tofalse Video Stream is transmitted.

Start Screen Share

You can call startScreenShare() to set the output of the audio stream.

let callController = CometChat.CallController.getInstance();
callController.startScreenShare();

Stop Screen Share

You can call stopScreenShare() to set the output of the audio stream.

let callController = CometChat.CallController.getInstance();
callController.stopScreenShare();

End Call

You can use the CometChat.endCall() method of the CometChat class to end the call.

CometChat.endCall("SESSION_ID_FOR_THE_CALL").then(
    call => {
        console.log('call ended', call);
    }, error => {
        console.log('error', error);
    }
);

Active Call

CometChat provides a method to get the details of the call that is currently active. The CometChat.getActiveCall() will return an object of the Call class containing the details of the ongoing call. If there is no ongoing call this method will return null.

let activeCall = CometChat.getActiveCall();

📘

Important

The getActiveCall() method will only return the details of the active call for the ongoing session in which the call has been started. If the app is restarted, the data will be lost.

Updated 5 days ago


Default Calling


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.