Skip to main content
Version: 0.0.x

Meeting Class Methods

join()

  • It is used to join a meeting.
  • After meeting initialization by initMeeting() it returns a new instance of Meeting. However, by default, it will not automatically join the meeting. Hence, to join the meeting you should call join().

Events associated with join():

Participant having ask_join permission inside token

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

  • After the decision from the remote participant, an event will be emitted to the participant called entry-responded. 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 meeting derectly after calling join().

Returns

  • void

leave()

  • It is used to leave the current meeting.

Events associated with leave():

Returns

  • void

end()

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

Events associated with end():

Returns

  • void

enableWebcam()

Returns

  • void

disableWebcam()

Returns

  • void

unmuteMic()

Returns

  • void

muteMic()

Returns

  • void

enableScreenShare()

Returns

  • void

disableScreenShare()

Returns

  • void

startRecording()

  • It is used to start meeting recording.

  • All participants and localParticipant, will receive recording-started event.

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

  • awsDirPath will be the path for your S3 bucket to which you want to store recordings. To allow us to store the recording in your S3 bucket, you will need to fill out this form by providing the required values. VideoSDK AWS S3 Integration

Parameters

  • webhookUrl: String
  • awsDirPath: String
  • config:
    • layout:
      • type: "GRID" | "SPOTLIGHT" | "SIDEBAR"
      • priority: "SPEAKER" | "PIN"
      • gridSize: Number max 25
    • theme: "DARK" | "LIGHT" | "DEFAULT"

Returns

  • void

Example

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

const awsDirPath = "/meeting-recordings/";

const config = {
layout: {
type: "SPOTLIGHT",
priority: "PIN",
gridSize: 9,
},
theme: "DEFAULT",
};

startRecording(webhookUrl, awsDirPath, config);

stopRecording()

Returns

  • void

startLivestream()

  • It is used to start meeting live streaming.
  • You will be able to start live stream meetings to other platforms such as Youtube, Facebook, etc. that support RTMP streaming.
  • All participants and localParticipant will receive the livestream-started event.

Parameters

  • outputs: Array<{ url: String, streamKey: String }>
  • config:
    • layout:
      • type: "GRID" | "SPOTLIGHT" | "SIDEBAR"
      • priority: "SPEAKER" | "PIN"
      • gridSize: Number max 25
    • theme: "DARK" | "LIGHT" | "DEFAULT"

Returns

  • void

Example

const outputs = [
{
url: "rtmp://a.rtmp.youtube.com/live2",
streamKey: "<STREAM_KEY>",
},
{
url: "rtmps://",
streamKey: "<STREAM_KEY>",
},
];

const config = {
layout: {
type: "SPOTLIGHT",
priority: "PIN",
gridSize: 9,
},
theme: "DEFAULT",
};

startLivestream(outputs, config);

stopLivestream()

Returns

  • void

startHls()

Parameters

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

Returns

  • void

Example

const config = {
layout: {
type: "SPOTLIGHT",
priority: "PIN",
gridSize: 9,
},
theme: "DEFAULT",
};

startHls(config);

stopHls()

Returns

  • void

getWebcams()

  • It will return all camera devices connected.

Returns

  • Promise<{ deviceId: string; lable: string }[]>

Example

const handleGetWebcams = async () => {
const webcams = await getWebcams();

console.log(webcams);
};

handleGetWebcams();

changeWebcam()

  • It is used to change the webcam device.
  • If multiple webcam devices are connected, by using changeWebcam() one can change the camera device.

Parameters

  • deviceId: String

Returns

  • void

setWebcamQuality()

  • It is used to set the webcam quality.
  • By using setWebcamQuality(), uploading of the webcam stream quality of localParticipant can be changed from low to high or vice versa.

Parameters

  • quality: "low" | "med" | "high"

Returns

  • void

getMics()

  • It will return all mic devices connected.

Returns

  • Promise<{ deviceId: string; lable: string }[]>

Example

const handleGetMics = async () => {
const mics = await getMics();

console.log(mics);
};

handleGetMics();

changeMic()

  • It is used to change the mic device.
  • If multiple mic devices are connected, by using changeMic() one can change the mic device.

Parameters

  • deviceId: String

Returns

  • void

connectTo()

  • This method is used for establishing the connection to other meetings.

Parameters

  • meetingId

    • type : String

    • meetingId of another meeting

  • payload

    • type : String

    • Any arbitrary payload data for the connection

Events associated with connectTo():

  • connection-open event of meeting class is triggered to all participants whenever meeting.connectTo() being called.

Returns

  • void

Example

//create connection to meeting B
meeting.connectTo({ meetingId: "meeting_B_ID", payload: "arbitraty text" });

// This event will be emitted to participants of both meetings, Meeting A & Meeting B
meeting.on("connection-open", (connection) => {
console.log("Connection", connection);
});

on()

Parameters

Returns

  • void

Example

//for meeting-any-event
meeting.on("meeting-any-event", listener);

off()

Parameters

Returns

  • void

Example

//for meeting-any-event
meeting.off("meeting-any-event", listener);