Room Class Methods - Flutter

join()

• After creating the instance of VideoSDK Room, you can join VideoSDK Room by calling join() method.

Events associated with join():

• Local Participant will receive a roomJoined event, when successfully joined.
• Remote Participant will receive a participantJoined event with the newly joined Participant object from the event handler.

Participant having ask_join permission inside token

• If a token contains the permission ask_join, then the participant will not join the room directly after calling join(), but an event will be emitted to the participant having the permission allow_join called entryRequested.

• After the decision from the remote participant, an event will be emitted to participant called entryResponded. This event will contain the decision made by the remote participant.

Participant having allow_join permission inside token

• If a token containing the permission allow_join, then the participant will join the room directly after calling join().

Returns

• void

---

leave()

• It is used to leave the current running room session.

Events associated with leave():

• Local participant will receive a roomLeft event.
• All remote participants will receive a participantLeft event with participantId string from the event handler.

Returns

• void

---

end()

• It is used to end the current running room session.
• By calling end(), all joined participants including localParticipant of that session will leave the room.

Events associated with end():

• All participants and localParticipant, will receive roomLeft event.

Returns

• void

---

enableCam()

• It is used to enable camera device.
• streamEnabled event will be emitted with stream object from the event handler, inside that participant object.

Returns

• void

---

disableCam()

• It is used to disable camera device.
• streamDisabled event will be emitted with stream object from the event handler, inside that participant object.

Returns

• void

---

unmuteMic()

• It is used to enable microphone device.
• streamEnabled event will be emitted with stream object from the event handler, inside that participant object.

Returns

• void

---

muteMic()

• It is used to disable microphone device.
• streamDisabled event will be emitted with stream object from the event handler, inside that participant object.

Returns

• void

---

enableScreenShare()

• it is used to enable screen-sharing.
• streamEnabled event will be emitted with stream object from the event handler, inside that participant object.
• presenterChanged will also receive a callback with the presenterId.

Returns

• void

---

disableScreenShare()

• It is used to disable screen-sharing.
• streamDisabled event will be emitted with stream object from the event handler, inside that participant object.
• presenterChanged will also receive a callback with the null.

Returns

• void

---

changeMode()

• It is used to change the mode fo the participant from SEND_AND_RECV to SIGNALLING_ONLY and vice-versa.
• participantModeChange event will be emitted with participantId and mode of the participant

Parameters

• requestedMode: Mode.SEND_AND_RECV | Mode.SIGNALLING_ONLY

Returns

• void

Example

room.changeMode(Mode.SEND_AND_RECV);

---

startRecording()

• It is used to start room recording.

• All participants and localParticipant, will receive recordingStarted event.

• webhookUrl will be triggered when the recording is completed and stored into server. Read more about webhooks here.

Parameters

• webhookUrl: String

• awsDirPath: String

• 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"

Returns

• void

Example

const webhookUrl = "https://webhook.your-api-server.com";

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

---

stopRecording()

• It is used to stop room recording.
• All participants and localParticipant, will receive recordingStopped event.

Returns

• void

Example

room.stopRecording();

---

startLivestream()

• It is used to start room livestreaming.
• You will be able to start livestream the room to another platforms such as Youtube, Facebook, etc. that supports rtmp streaming.
• All participants and localParticipant, will receive liveStreamStarted event.

Parameters

• outputs: List<Map<String, String>> [{ url: String, streamKey: String }]

• config:

  • layout:
    • type: "GRID" | "SPOTLIGHT" | "SIDEBAR"
    • priority: "SPEAKER" | "PIN"
    • gridSize: Number `max 4`
  • theme: "DARK" | "LIGHT" | "DEFAULT"

Returns

• void

Example

var outputs = [
  {
    url: "rtmp://a.rtmp.youtube.com/live2",
    streamKey: "<STREAM_KEY>",
  },
  {
    url: "rtmps://",
    streamKey: "<STREAM_KEY>",
  },
];
var liveStreamConfig =  {
  'layout': {
    'type': 'GRID',
    'priority': 'SPEAKER',
    'gridSize': 4,
  },
  'theme': "LIGHT",
};
room.startLivestream(outputs, config: livestreamConfig);

---

stopLivestream()

• It is used to stop room livestreaming.
• All participants and localParticipant, will receive livestreamStopped event.

Returns

• void

Example

room.stopLivestream();

---

startHls()

• It is used to start HLS.
• All participants and localParticipant, will receive hlsStarted event with the playbackHlsUrl and liveStreamUrl of the HLS feed.

Parameters

• config:
  • layout:
    • type: "GRID" | "SPOTLIGHT" | "SIDEBAR"
    • priority: "SPEAKER" | "PIN"
    • gridSize: Number `max 25`
  • theme: "DARK" | "LIGHT" | "DEFAULT"
  • mode: "video-and-audio" | "audio"
  • quality: "low" | "med" | "high"
  • oreintation: "landscape" | "portrait"

Returns

• void

Example

room.startHls(config: {
  'layout': {
    'type': 'GRID',
    'priority': 'SPEAKER',
    'gridSize': 4,
  },
  'theme': "LIGHT",
  "mode": "video-and-audio"
});

---

stopHls()

• It is used to stop HLS.
• All participants and localParticipant, will receive hlsStopped event.

Returns

• void

Example

room.stopHls();

---

getCameras()

• It will return all connected camera devices.

Returns

• List< MediaDeviceInfo >

Example

List<MediaDeviceInfo> cams = room.getCameras();
print(cams);

---

changeCam()

• It is used to change the camera device.
• If multiple camera devices are connected, by using changeCam(), one can change the camera device with camera device id.
• You can get list of connected video devices using VideoSDK.mediaDevices

Parameters

• deviceId: String

Returns

• void

Example

room.changeCam(deviceId);

---

getAudioOutputDevices()

• It will return all the available audio output devices.

Returns

• List< MediaDeviceInfo >

Example

List<MediaDeviceInfo> audioOutputDevices = room.getAudioOutputDevices();
print(audioOutputDevices);

---

switchAudioDevice()

• It is used to change the audio output device.
• You can get list of connected audio output devices using getAudioOutputDevices

Parameters

• device: MediaDeviceInfo

Returns

• void

Example

room.switchAudioDevice(device);

---

on()

• It is used to listen Room related events.

Parameters

• event

  • type: Events
  • This will specify the event to be listened.

• eventHandler

  • type: Function
  • This will be invoked whenever, specified event occurred.

Returns

• void

Example

room.on(Events.roomJoined, () {
  // do something
});