Start and Stop - Android

This guide will provide an overview of how to implement start and stop Meeting Recording.

startRecording()

startRecording() can be used to start a recording of the meeting which can be accessed from the Meeting class. This method accepts four parameters:

• 1. webhookUrl: This would the webhook URL where you would like to listen to event happening for the recording like starting and stopping of recording. It will be triggered when the recording is completed and stored into server. Read more about webhooks here

• 2. awsDirPath: This parameter accepts the path for the your S3 bucket where you want to store recordings to. To allow us to store recording in your S3 bucket, you will need to fill this form by providing the required values. (VideoSDK Cloud (AWS S3, Azure Blob or GCP ) Integration)

• 3. config: This parameter will define how the meeting should be recorded.

• 4. transcription: This parameter lets you start post transcription for the recording.

note

If you don't have a value for webhookUrl,awsDirPath or config, you should pass null in place of the missing value. If you pass null in awsDirPath parameter then by default recordings will be store on the VideoSDK's storage.

Kotlin

val config = JSONObject()

// Layout Configuration
val layout = JSONObject()
JsonUtils.jsonPut(layout, "type", "GRID") // "SPOTLIGHT" | "SIDEBAR",  Default : "GRID"
JsonUtils.jsonPut(layout, "priority", "SPEAKER") // "PIN", Default : "SPEAKER"
JsonUtils.jsonPut(layout, "gridSize", 4) // MAX : 4
JsonUtils.jsonPut(config, "layout", layout)

// Theme of recording
JsonUtils.jsonPut(config, "theme", "DARK") //  "LIGHT" | "DEFAULT"

// `mode` is used to either record video & audio both or only audio.
JsonUtils.jsonPut(config, "mode", "video-and-audio") // "audio", Default : "video-and-audio"

// Quality of recording and is only applicable to `video-and-audio` type mode.
JsonUtils.jsonPut(config, "quality", "high") // "low" | "med",  Default : "med"

// This mode refers to orientation of recording.
// landscape : Record the meeting in horizontally
// portrait : Record the meeting in vertically (Best for mobile view)
JsonUtils.jsonPut(config, "orientation", "portrait") // "landscape",  Default : "landscape"

// Post Transcription Configuration
val prompt = "Write summary in sections like Title, Agenda, Speakers, Action Items, Outlines, Notes and Summary"
val summaryConfig = SummaryConfig(true, prompt)
val modelId = "raman_v1"
val transcription = PostTranscriptionConfig(true, summaryConfig, modelId)

meeting.startRecording(null, null, config, transcription)

Java

JSONObject config = new JSONObject();

// Layout Configuration
JSONObject layout = new JSONObject();
JsonUtils.jsonPut(layout, "type", "GRID"); // "SPOTLIGHT" | "SIDEBAR",  Default : "GRID"
JsonUtils.jsonPut(layout, "priority", "SPEAKER");  // "PIN", Default : "SPEAKER"
JsonUtils.jsonPut(layout, "gridSize", 4); // MAX : 4
JsonUtils.jsonPut(config, "layout", layout);

// Theme of recording
JsonUtils.jsonPut(config, "theme", "DARK"); //  "LIGHT" | "DEFAULT"

// `mode` is used to either record video & audio both or only audio.
JsonUtils.jsonPut(config, "mode", "video-and-audio"); // "audio", Default : "video-and-audio"

// Quality of recording and is only applicable to `video-and-audio` type mode.
JsonUtils.jsonPut(config, "quality", "high"); // "low" | "med",  Default : "med"

// This mode refers to orientation of recording.
// landscape : Record the meeting in horizontally
// portrait : Record the meeting in vertically (Best for mobile view)
JsonUtils.jsonPut(config, "orientation", "portrait"); // "landscape",  Default : "landscape"

// Post Transcription Configuration
String prompt = "Write summary in sections like Title, Agenda, Speakers, Action Items, Outlines, Notes and Summary";
SummaryConfig summaryConfig = new SummaryConfig(true, prompt);
String modelId = "raman_v1";
PostTranscriptionConfig transcription = new PostTranscriptionConfig(true, summaryConfig, modelId);

meeting.startRecording(null, null, config, transcription);

stopRecording()

• stopRecording() is used to stop the meeting recording which can be accessed from the Meeting class.

Example

Kotlin

// keep track of recording
val recording = false

findViewById<View>(R.id.btnRecording).setOnClickListener { view: View? ->
    if (!recording) {
      val config = JSONObject()
      val layout = JSONObject()
      JsonUtils.jsonPut(layout, "type", "GRID")
      JsonUtils.jsonPut(layout, "priority", "SPEAKER")
      JsonUtils.jsonPut(layout, "gridSize", 4)
      JsonUtils.jsonPut(config, "layout", layout)
      JsonUtils.jsonPut(config, "theme", "DARK")
      JsonUtils.jsonPut(config, "mode", "video-and-audio")
      JsonUtils.jsonPut(config, "quality", "high")
      JsonUtils.jsonPut(config, "orientation", "portrait")

      // Post Transcription Configuration
      val prompt = "Write summary in sections like Title, Agenda, Speakers, Action Items, Outlines, Notes and Summary"
      val summaryConfig = SummaryConfig(true, prompt)
      val modelId = "raman_v1"
      val transcription = PostTranscriptionConfig(true, summaryConfig, modelId)

      // Start Recording
      // If you don't have a `webhookUrl` or `awsDirPath`, you should pass null.
      // If you don't want to enable transcription, you can pass null as parameter.
      meeting!!.startRecording("YOUR WEB HOOK URL", "AWS Directory Path", config, transcription)
    } else {
      // Stop Recording
      meeting!!.stopRecording()
    }
}

Java

// keep track of recording
boolean recording = false;

findViewById(R.id.btnRecording).setOnClickListener(view -> {
    if (!recording) {
      JSONObject config = new JSONObject();
      JSONObject layout = new JSONObject();
      JsonUtils.jsonPut(layout, "type", "GRID");
      JsonUtils.jsonPut(layout, "priority", "SPEAKER");
      JsonUtils.jsonPut(layout, "gridSize", 4);
      JsonUtils.jsonPut(config, "layout", layout);
      JsonUtils.jsonPut(config, "theme", "DARK");
      JsonUtils.jsonPut(config, "mode", "video-and-audio");
      JsonUtils.jsonPut(config, "quality", "high");
      JsonUtils.jsonPut(config, "orientation", "portrait");

      // Post Transcription Configuration
      String prompt = "Write summary in sections like Title, Agenda, Speakers, Action Items, Outlines, Notes and Summary";
      SummaryConfig summaryConfig = new SummaryConfig(true, prompt);
      String modelId = "raman_v1";
      PostTranscriptionConfig transcription = new PostTranscriptionConfig(true, summaryConfig, modelId);

      // Start Recording
      // If you don't have a `webhookUrl` or `awsDirPath`, you should pass null.
      // If you don't want to enable transcription, you can pass null as parameter.
      meeting.startRecording("YOUR WEB HOOK URL", "AWS Directory Path", config, transcription);
    } else {
      // Stop Recording
      meeting.stopRecording();
    }
});

important

To initiate automatic recording at the beginning of a session, simply provide the autoStartConfig feature recording during room creation. For more information on configuring the autoStartConfig, please refer to the provided documentation here.

API Reference

The API references for all the methods utilised in this guide are provided below.

• startRecording()
• stopRecording()
• onRecordingStateChanged
• autoStartConfig