Skip to main content
Version: 0.3.x

Basic Features - Prebuilt

apiKey​

meetingId​

  • type: String

  • Enter any arbitrary meetingId or an id generated with the reference of Create-Room

name​

  • type: String

  • Name of participant who will join the meeting.

region​

  • @discontinued

  • The region parameter has been discontinued; instead, the Video SDK's smart service will pick the best optimal servers for a conference, closest to your end-users' location. If you still need to hold your conferences in a specific region, i.e. Geo Fencing. Contact Us

containerId​

  • type: String

  • In the containerId you need to specify an id of your dom element which will help you rendering your meeting in that particular portion which could be your entire page or any element of a page.

  • If nothing provided, then the meeting will be rendered in full screen.

meeting.init({
  //othe params
  containerId: "meeting-container-id",
  //other params
});
<html>
  <body>
    <div id="meeting-container-id"></div>
  </body>
</html>

redirectOnLeave​

  • type: String

  • redirectOnLeave will redirect that participant to the specified url, when a participant leave the meeting.

micEnabled​

  • type: Boolean

  • If set to true micEnabled represents the initial state of mic when a participant join the meeting.

webcamEnabled​

  • type: Boolean

  • If set to true webcamEnabled represents the initial state of webcam when a participant join the meeting.

participantCanToggleSelfWebcam​

  • type: Boolean

  • When true, participant will be able to enable or disable self webcam.

participantCanToggleSelfMic​

  • type: Boolean

  • When true, participant will be able to enable or disable self mic.

participantCanLeave​

  • type: Boolean

  • If true, then leave button will be visible on topbar of meeting layout.

chatEnabled​

  • type: Boolean

  • If true, then participant will be able to chat during the meeting.

screenShareEnabled​

  • type: Boolean

  • If true, then participant will be able to share their screen in the meeting.

whiteboardEnabled​

  • type: Boolean

  • If true, then participant will be able to see the white board status.

raiseHandEnabled​

  • type: Boolean

  • if true then participant will be able to raise his/her hand in the meeting

joinScreen​

  • type: object

visible​

  • type: Boolean

  • joinScreen.visible. If set to true, then joinScreen will be visible to enter the meeting.

title​

  • type: String

  • joinScreen.title. Represents the title of the meeting.

meetingUrl​

  • type: String

  • joinScreen.meetingUrl. Represents meeting joining url.

meeting.init({
  //other params
  joinScreen: {
    visible: false, // Show the join screen ?
    title: "Recording Scaling Testing", // Meeting title
    meetingUrl: window.location.href, // Meeting joining url
  },
  //other params
});

participantTabPanelEnabled​

  • type: Boolean

  • Setting participantTabPanelEnabled to true will show an participant tab panel in the meeting.

maxResolution​

  • type: String

  • maxResolution, sets the max webcam resolution which can either be hd | sd

debug​

  • type: Boolean

  • Setting debug to true will show an error which may cause during the meeting.

participantId​

  • type: String

  • If participant wants to explicitly specify their id , then it can be managed using participantId.

joinWithoutUserInteraction​

  • type: Boolean

  • Participant can directly join the meeting if joinWithoutUserInteraction set to true.

maintainVideoAspectRatio​

  • type: Boolean

  • Participant videos will maintain the aspect ratio if true, so if the video stream is portrait it will be shown as portrait.

  • Default: true

moreOptionsEnabled​

  • type: Boolean

  • Setting moreOptionsEnabled to true or false will show or hide More Option tab panel in the meeting.

  • Default: true

participantNotificationAlertsEnabled​

  • type: Boolean

  • Setting participantNotificationAlertsEnabled to true will show notification when participant join or left the meeting.

  • Default: false

Got a Question? Ask us on discord

Last updated on by BhumiSalat

Was this helpful?