Start and Stop - Flutter

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 Room object. This method accepts four parameters:

• 1. webhookUrl (optional): 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 (optional): 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 (optional): This parameter will define how the recording should be recorded.

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

  Map<String, dynamic> config = {
    // Layout Configuration
    layout: {
      type: "GRID", // "SPOTLIGHT" | "SIDEBAR",  Default : "GRID"
      priority: "SPEAKER", // "PIN", Default : "SPEAKER"
      gridSize: 4, // MAX : 4
    },
  
    // Theme of recording
    theme: "DARK", //  "LIGHT" | "DEFAULT"
  
    // `mode` is used to either record video & audio both or only audio.
    mode: "video-and-audio", // "audio", Default : "video-and-audio"
  
    // Quality of recording and is only applicable to `video-and-audio` type mode.
    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)
    orientation: "landscape", // "portrait",  Default : "landscape"
  };
  
  // Post Transcription Configuration
  Map<String, dynamic> transcription = {
    "enabled": true, // Enables post transcription
    "summary": {
      "enabled": true,  // Enables summary generation
       // Guides summary generation
      "prompt":
          "Write summary in sections like Title, Agenda, Speakers, Action Items, Outlines, Notes and Summary",
    }
  };
  
  room.startRecording(config: config, transcription: transcription);

stopRecording()

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

Example

import 'package:flutter/material.dart';
import 'package:videosdk/videosdk.dart';

class MeetingScreen extends StatefulWidget {
  ...
}

class _MeetingScreenState extends State<MeetingScreen> {
  late Room _room;

  @override
  void initState() {
    ...
  }

  @override
  Widget build(BuildContext context) {
    return Column(
      children:[
        ElevatedButton(
          onPressed:(){
            Map<String, dynamic> config = {
              "layout": {
                "type": "GRID",
                "priority": "SPEAKER",
                "gridSize": 4,
              },
              "theme": "DARK",
              "mode": "video-and-audio",
              "quality": "high",
              "orientation": "portrait",
            };

            Map<String, dynamic> transcription = {
              "enabled": true,
              "summary": {
                "enabled": true,
                "prompt":
                    "Write summary in sections like Title, Agenda, Speakers, Action Items, Outlines, Notes and Summary",
              }
            };
            _room.startRecording(config: config, transcription: transcription);
          },
          child: const Text("Start Recording"),
        ),
        ElevatedButton(
          onPressed:(){
            _room.stopRecording();
          },
          child: const Text("Stop recording"),
        ),
      ]
    );
  }
}

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 utilized in this guide are provided below.

• startRecording
• stopRecording
• Events.recordingStateChanged
• autoStartConfig