Skip to main content

VideoSDKMeeting Class

The entry point into real-time communication prebuilt SDK.

The VideoSDKMeeting Class#

The VideoSDKMeeting Class includes properties, methods and events to control user interface and experience of prebuilt.

Methods#

init()#

Javascript
const meeting = new VideoSDKMeeting();
meeting.init({  name: "John Doe",  apiKey: "YOUR API KEY", // generated from app.videosdk.live  meetingId: "milkyway", // enter your meeting id
  containerId: null,  redirectOnLeave: "https://www.videosdk.live/",
  micEnabled: true,  webcamEnabled: true,  participantCanToggleSelfWebcam: true,  participantCanToggleSelfMic: true,
  chatEnabled: true,  screenShareEnabled: true,  pollEnabled: true,  whiteBoardEnabled: true,  raiseHandEnabled: true,
  recordingEnabled: true,  recordingWebhookUrl: "https://www.videosdk.live/callback",  participantCanToggleRecording: true,
  brandingEnabled: true,  brandLogoURL: "https://picsum.photos/200",  brandName: "Awesome startup",  poweredBy: true,
  participantCanLeave: true, // if false, leave button won't be visible
  // Live stream meeting to youtube  livestream: {    autoStart: true,    outputs: [      {        url: "rtmp://x.rtmp.youtube.com/live2",        streamKey: "<STREAM KEY FROM YOUTUBE>",      },    ],  },
  permissions: {    askToJoin: false, // Ask joined participants for entry in meeting    toggleParticipantMic: true, // Can toggle other participant's mic    toggleParticipantWebcam: true, // Can toggle other participant's webcam  },
  joinScreen: {    visible: true, // Show the join screen ?    title: "Daily scrum", // Meeting title    meetingUrl: window.location.href, // Meeting joining url  },});

Parameters#

  • __namedParametersrequiredobject

      Properties
    • micEnabledrequiredboolean

    • webcamEnabledrequiredboolean

    • namerequiredstring

    • meetingIdrequiredstring

    • redirectOnLeaverequiredstring

      Redirection URL
    • chatEnabledrequiredboolean

    • screenShareEnabledrequiredboolean

    • pollEnabledrequiredboolean

    • whiteBoardEnabledrequiredboolean

    • participantCanToggleSelfWebcamrequiredboolean

    • participantCanToggleSelfMicrequiredboolean

    • raiseHandEnabledrequiredboolean

    • apiKeyrequiredstring

    • containerIdrequiredstring

      Specify id of the container where you want to display prebuilt UI or keep it null
    • recordingEnabledoptionalboolean

    • recordingWebhookUrloptionalstring

    • participantCanToggleRecordingoptionalboolean

    • brandingEnabledoptionalboolean

    • brandLogoURLoptionalstring

    • brandNameoptionalstring

    • poweredByoptionalboolean

    • participantCanLeaveoptionalboolean

    • livestreamoptionalobject

      • autoStartoptionalboolean

      • outputsoptionalArray<{url: string, streamKey: string}>

    • permissionsoptionalobject

      • askToJoinoptionalboolean

      • toggleParticipantMicoptionalboolean

      • toggleParticipantWebcamoptionalboolean

    • joinScreenoptionalobject

      • visibleoptionalboolean

      • titleoptionalstring

      • meetingUrloptionalstring