Recording (Beta)

This section will guide you to implement call recording feature for the voice and video calls.

Implementation

Once you have decided to implement Default Calling or Direct Calling calling and followed the steps to implement them. Just few additional listeners and methods will help you quickly implement call recording in your app.

You need to make changes in the CometChat.startCall method and add the required listeners for recording. Please make sure your callSettings is configured accordingly for Default Calling or Direct Calling.

A basic example of how to make changes to implement recording for a direct call/ a default call:

Default Calling - Javascript

// Add listeners onRecordingStarted and onRecordingStopped to the startCall method
let sessionId = "SESSION_ID";
let audioOnly = false;
let defaultLayout = true;
let showRecordingButton = true;

let callSettings = new CometChat.CallSettingsBuilder()
  .enableDefaultLayout(defaultLayout)
  .showRecordingButton(showRecordingButton)
  .setSessionID(sessionId)
  .setIsAudioOnlyCall(audioOnly)
  .build();

CometChat.startCall(
  callSettings,
  document.getElementById("callScreen"),
  new CometChat.OngoingCallListener({
      onRecordingStarted: recordingStartedBy => {
          // This event will work in JS SDK v3.0.2-beta1 & later.
          console.log("Listener => onRecordingStarted:", recordingStartedBy);
      },
      onRecordingStopped: recordingStoppedBy => {
          // This event will work in JS SDK v3.0.2-beta1 & later.
          console.log("Listener => onRecordingStopped:", recordingStoppedBy);
      },
  })
);  

Direct Calling - Javascript

// Add listeners onRecordingStarted and onRecordingStopped to the startCall method
let sessionId = "SESSION_ID";
let audioOnly = false;
let defaultLayout = true;
let showRecordingButton = true;

var callSettings = new CometChat.CallSettingsBuilder()
  .enableDefaultLayout(defaultLayout)
  .showRecordingButton(showRecordingButton)
  .setSessionID(sessionId)
  .setIsAudioOnlyCall(audioOnly)
  .build();

CometChat.startCall(
  callSettings,
  document.getElementById("callScreen"),
  new CometChat.OngoingCallListener({
      onRecordingStarted: recordingStartedBy => {
          // This event will work in JS SDK v3.0.2-beta1 & later.
          console.log("Listener => onRecordingStarted:", recordingStartedBy);
      },
      onRecordingStopped: recordingStoppedBy => {
          // This event will work in JS SDK v3.0.2-beta1 & later.
          console.log("Listener => onRecordingStopped:", recordingStoppedBy);
      },
  })
); 

Default Calling (Typescript)

// Add listeners onRecordingStarted and onRecordingStopped to the startCall method.
let sessionId = "SESSION_ID";
let audioOnly = false;
let defaultLayout = true;
let showRecordingButton = true;

let callSettings = new CometChat.CallSettingsBuilder()
  .enableDefaultLayout(defaultLayout)
  .showRecordingButton(showRecordingButton)
  .setSessionID(sessionId)
  .setIsAudioOnlyCall(audioOnly)
  .build();

CometChat.startCall(
  callSettings,
  document.getElementById("callScreen"),
  new CometChat.OngoingCallListener({
      onRecordingStarted: (recordingStartedBy: CometChat.User) => {
          // This event will work in JS SDK v3.0.2-beta1 & later.
          console.log("Listener => onRecordingStarted:", recordingStartedBy);
      },
      onRecordingStopped: (recordingStoppedBy: CometChat.User) => {
          // This event will work in JS SDK v3.0.2-beta1 & later.
          console.log("Listener => onRecordingStopped:", recordingStoppedBy);
      },
  })
);

Direct Calling (Typescript)

// Add listeners onRecordingStarted and onRecordingStopped to the startCall method
let sessionId = "SESSION_ID";
let audioOnly = false;
let defaultLayout = true;
let showRecordingButton = true;

var callSettings = new CometChat.CallSettingsBuilder()
  .enableDefaultLayout(defaultLayout)
  .showRecordingButton(showRecordingButton)
  .setSessionID(sessionId)
  .setIsAudioOnlyCall(audioOnly)
  .build();

CometChat.startCall(
  callSettings,
  document.getElementById("callScreen"),
  new CometChat.OngoingCallListener({
      onRecordingStarted: (recordingStartedBy: CometChat.User) => {
          // This event will work in JS SDK v3.0.2-beta1 & later.
          console.log("Listener => onRecordingStarted:", recordingStartedBy);
      },
      onRecordingStopped: (recordingStoppedBy: CometChat.User) => {
          // This event will work in JS SDK v3.0.2-beta1 & later.
          console.log("Listener => onRecordingStopped:", recordingStoppedBy);
      },
  })
);

Settings for call recording

The CallSettingsclass allows you to customise the overall calling experience. The properties for the call/conference can be set using the CallSettingsBuilder class. This will eventually give you and 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 recording of calls are:

Setting	Description
showRecordingButton(showRecordingButton: boolean)	If set to true it displays the Recording button in the button Layout. if set to false it hides the Recording button in the button Layout. Default value = false
startRecordingOnCallStart(startRecordingOnCallStart: boolean)	If set to true call recording will start as soon as the call is started. if set to false call recording will not start as soon as the call is started. Default value = false

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:

Start Recording

You can use the startRecording() method to start call recording.

Start Recording

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

Typescript

let callController: CometChat.CallController = CometChat.CallController.getInstance();
callController.startRecording();

Stop Recording

You can use the stopRecording() method to stop call recording.

Stop Recording

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

Typescript

let callController: CometChat.CallController = CometChat.CallController.getInstance();
callController.stopRecording();