Skip to main content
Version: 1.0.x

Record Room

Record room allows participants to record video & audio during the room. The recording files are available in developer dashboard. Any participant can start / stop recording any time during the room.

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

  1. Start Recording - By using startRecording() function, a participant can start room recording.

Parameters

  • webhookUrl:

    • type: String
    • required: false
    • It will be webhook url where you want to get teh status of the recording.
  • awsDirPath:

    • type: String
    • required: false
    • It will be path for your AWS storage specifing where to store the recording file.
  • config:

    • type: Object
      • config:
        • layout:
          • type: "GRID" | "SPOTLIGHT" | "SIDEBAR"
          • priority: "SPEAKER" | "PIN"
          • gridSize: Number `max 4`
        • theme: "DARK" | "LIGHT" | "DEFAULT"
        • mode: "video-and-audio" | "audio"
        • quality: "low" | "med" | "high"
        • orientation: "landscape" | "portrait"
    • required: false
    • It will be config for the layout of the recording you can to use.
  1. Stop Recording - By using stopRecording() function, a participant can stop room recording.

Start And Stop Recording

// Start Recording
room.startRecording(config: {
'layout': {
'type': 'GRID',
'priority': 'SPEAKER',
'gridSize': 4,
},
'theme': "LIGHT",
"mode": "video-and-audio".
'quality':'high'
});

// Stop Recording
room.stopRecording(),

Events

  • recordingStateChanged - Whenever meeting recording state changes, then recordingStateChanged event will trigger.
room.on(Events.recordginStateChanged, (String status) {

// Status can have values -
// RECORDING_STARTING -- Recording is starting
// RECORDING_STARTED -- Recording is started
// RECORDING_STOPPING -- Recording is stopping
// RECORDING_STOPPED -- Recording is stopped

toastMsg("Meeting recording status : $status");
});