Class Meeting

Constructors

constructor

new Meeting(): Meeting
Returns Meeting

Properties

activePresenterId

activePresenterId: string

This indicates the participant ID of the user who is currently sharing their screen in the meeting. If no one is presenting, the value is null.

activeSpeakerId

activeSpeakerId: string

This indicates the participant ID of the user who is currently speaking. If no participant is actively speaking, the value is null.

hlsState

hlsState: "HLS_STOPPED" | "HLS_STARTING" | "HLS_STARTED" | "HLS_STOPPING"

This represents the current state of the HLS stream.

hlsUrls

hlsUrls: {
    downstreamUrl?: string;
    livestreamUrl?: string;
    playbackHlsUrl?: string;
}

This represents the URLs associated with the ongoing HLS stream.

playbackHlsUrl – URL used for playback.
livestreamUrl – URL used for live streaming.
~~downstreamUrl~~ – Deprecated. Use playbackHlsUrl or livestreamUrl instead.

Note

downstreamUrl is deprecated and should no longer be used.

id

id: string

This represents the unique ID of the meeting that the participant has joined.

isE2EEEnabled

isE2EEEnabled: boolean

This represents whether End-to-End Encryption (E2EE) is enabled for the meeting.

livestreamState

livestreamState:
    | "LIVESTREAM_STOPPED"
    | "LIVESTREAM_STARTING"
    | "LIVESTREAM_STARTED"
    | "LIVESTREAM_STOPPING"

This represents the current state of the livestream.

localParticipant

localParticipant: Participant

This represents the local participant (you) who joined the meeting.

mainParticipantId

mainParticipantId: string

This represents the participant ID of the main participant in the meeting.

participants

participants: Map<string, Participant>

This represents a map of all remote participants currently in the meeting.

The key represents the participant ID.
The value represents the corresponding Participant instance.

This map does not include the local participant.

pinnedParticipants

pinnedParticipants: Map<string, { cam: boolean; share: boolean }>

This represents a map of all participants currently pinned in the meeting.

The key represents the participant ID.
The value represents the pin state, indicating whether the participant’s camera (cam) and/or screen share (share) is pinned.

pubSub

pubSub: pubSub

It allows access to the pubSub functionality.

realtimeStore

realtimeStore: realtimeStore

It allows access to the realtimeStore functionality.

recordingState

recordingState:
    | "RECORDING_STOPPED"
    | "RECORDING_STARTING"
    | "RECORDING_STARTED"
    | "RECORDING_STOPPING"

This represents the current state of the meeting recording.

selectedCameraDevice

selectedCameraDevice: CameraDeviceInfo

This represents the currently selected camera device used during the meeting,returned as a CameraDeviceInfo object containing details about the active camera.

selectedMicrophoneDevice

selectedMicrophoneDevice: MicrophoneDeviceInfo

This represents the currently selected microphone device used during the meeting,returned as a MicrophoneDeviceInfo object containing details about the active microphone.

transcriptionState

transcriptionState:
    | "TRANSCRIPTION_STARTING"
    | "TRANSCRIPTION_STARTED"
    | "TRANSCRIPTION_STOPPING"
    | "TRANSCRIPTION_STOPPED"

This represents the current state of real-time transcription.

Methods

changeMic

changeMic(object: string | MediaStream): void
- This method can be used to change the active microphone device.
- If multiple microphones are available, this method allows switching between them dynamically during the meeting.
Parameters
- object: string | MediaStream
  Either:
  
  A deviceId string of the microphone to switch to, or
  
  A MediaStream to be used as the audio input source.
Returns void
Example
```
let meeting;

// Initialize Meeting
meeting = VideoSDK.initMeeting({
  // ...
});

const mics = await meeting?.getMics();

const { deviceId, label } = mics[0];

meeting?.changeMic(deviceId);
```
- Defined in meeting.d.ts:1055

changeMode

changeMode(mode: "SEND_AND_RECV" | "SIGNALLING_ONLY" | "RECV_ONLY"): void
- This method can be used to change the local participant's mode.
- You can switch between the following modes: modes.
Info

Important changes introduced in JavaScript SDK v0.1.4:
- CONFERENCE has been replaced with SEND_AND_RECV
- VIEWER has been replaced with SIGNALLING_ONLY
Events associated with changeMode():
- The participant receives a participant-mode-changed event when the mode is successfully updated.
Parameters
- mode: "SEND_AND_RECV" | "SIGNALLING_ONLY" | "RECV_ONLY"
Returns void
Example
```
let meeting;

// Initialize Meeting
meeting = VideoSDK.initMeeting({
  // ...
});

meeting?.changeMode(VideoSDK.Constants.modes.SEND_AND_RECV);
```
- Defined in meeting.d.ts:196

changeWebcam

changeWebcam(object: string | MediaStream): void
- This method can be used to change the active webcam device.
- If multiple cameras are connected, this method allows switching between them dynamically during the meeting.
Parameters
- object: string | MediaStream
  Either:
  
  A deviceId of the webcam to switch to, or
  
  A MediaStream to be used as the video source.
Returns void
Example
```
let meeting;

// Initialize Meeting
meeting = VideoSDK.initMeeting({
  // ...
});

const webcams = await meeting?.getWebcams();

const { deviceId, label } = webcams[0];

meeting?.changeWebcam(deviceId);
```
- Defined in meeting.d.ts:1082

disableAdaptiveSubscription

disableAdaptiveSubscription(): void
- This method can be used to disable Adaptive Subscription.
- When disabled, all video streams remain subscribed regardless of visibility or network conditions.
Returns void
Example
```
let meeting;

// Initialize Meeting
meeting = VideoSDK.initMeeting({
  // ...
});

meeting?.disableAdaptiveSubscription();
```
- Defined in meeting.d.ts:892

disableScreenShare

disableScreenShare(): void
- This method can be used to disable screen sharing for the local participant.
Events associated with disableScreenShare():
- A stream-disabled event is emitted with the corresponding Stream object.
- A presenter-changed event is emitted with null as the presenter.
Returns void
Example
```
let meeting;

// Initialize Meeting
meeting = VideoSDK.initMeeting({
  // ...
});

meeting?.disableScreenShare();
```
- Defined in meeting.d.ts:334

disableWebcam

disableWebcam(): void
- This method can be used to disable the local participant’s webcam.
Events associated with disableWebcam():
- A stream-disabled event is emitted with the corresponding Stream object.
Returns void
Example
```
let meeting;

// Initialize Meeting
meeting = VideoSDK.initMeeting({
  // ...
});

meeting?.disableWebcam();
```
- Defined in meeting.d.ts:286

enableAdaptiveSubscription

enableAdaptiveSubscription(): void
- This method can be used to enable Adaptive Subscription.
- Adaptive Subscription dynamically adjusts which video streams are subscribed to, based on participant visibility and current network conditions.
Returns void
Example
```
let meeting;

// Initialize Meeting
meeting = VideoSDK.initMeeting({
  // ...
});

meeting?.enableAdaptiveSubscription();
```
- Defined in meeting.d.ts:874

enableScreenShare

enableScreenShare(customScreenSharingTrack?: MediaStream): void
- This method can be used to enable screen sharing for the local participant.
Events associated with enableScreenShare():
- A stream-enabled event is emitted with the corresponding Stream object.
- A presenter-changed event is emitted with the presenterId.
Parameters
- OptionalcustomScreenSharingTrack: MediaStream
  An optional custom screen share track to be used instead of the default one.
  
  To learn more checkout this reference
Returns void
Example
```
let meeting;

// Initialize Meeting
meeting = VideoSDK.initMeeting({
  // ...
});

meeting?.enableScreenShare();
```
- Defined in meeting.d.ts:360

enableWebcam

enableWebcam(customVideoTrack?: MediaStream): void
- This method can be used to enable the local participant’s webcam.
Events associated with enableWebcam():
- A stream-enabled event is emitted with the corresponding Stream object.
Parameters
- OptionalcustomVideoTrack: MediaStream
  An optional custom video track to be used instead of the default one.
  
  To learn more, checkout this reference
Returns void
Example
```
let meeting;

// Initialize Meeting
meeting = VideoSDK.initMeeting({
  // ...
});

meeting?.enableWebcam();
```
- Defined in meeting.d.ts:312

end

end(): void
- This method can be used to end the current meeting session for all participants.
- Calling end() removes all participants, including the local participant, and permanently terminates the meeting.
Events associated with end():
- All participants receive the meeting-left event.
Returns void
Example
```
let meeting;

// Initialize Meeting
meeting = VideoSDK.initMeeting({
  // ...
});

meeting?.end();
```
- Defined in meeting.d.ts:218

fetchBase64File

fetchBase64File(options: { token: string; url: string }): Promise<string>
- This method can be used to retrieve a previously uploaded file from VideoSDK's temporary storage.
- The returned value is a Base64-encoded string.
Parameters
- options: { token: string; url: string }
  - token: string
    VideoSDK authentication token.
  - url: string
    The file URL returned by uploadBase64File().
Returns Promise<string>
A Base64-encoded string of the requested file.
Example
```
let meeting;

// Initialize Meeting
meeting = VideoSDK.initMeeting({
  // ...
});

const base64 = await meeting.fetchBase64File({
  url: "<FILE_URL>", // Provide fileUrl which is returned by uploadBase64File(),
  token: "<VIDEOSDK_TOKEN>",
});

console.log("Base64:", base64);
```
- Defined in meeting.d.ts:1209

getMics

getMics(): Promise<{ deviceId: string; label: string }[]>
- This method can be used to retrieve all available microphone devices connected to the system.
Returns Promise<{ deviceId: string; label: string }[]>
Example
```
let meeting;

// Initialize Meeting
meeting = VideoSDK.initMeeting({
  // ...
});

const handleGetMics = async () => {
  const mics = await meeting?.getMics();
  console.log(mics);
};

handleGetMics();
```
- Defined in meeting.d.ts:821

getWebcams

getWebcams(): Promise<
{ deviceId: string; facingMode: "environment"
| "front"; label: string }[],
>
- This method can be used to retrieve all available camera devices connected to the system.
Returns Promise<
{ deviceId: string; facingMode: "environment"
| "front"; label: string }[],
>
Example
```
let meeting;

// Initialize Meeting
meeting = VideoSDK.initMeeting({
  // ...
});

const handleGetWebcams = async () => {
  const webcams = await meeting?.getWebcams();
  console.log(webcams);
};

handleGetWebcams();
```
- Defined in meeting.d.ts:850

join

join(): void
- This method can be used to join the meeting.
- After initializing a meeting using initMeeting(), calling join() is required to enter the meeting.
Events associated with join():
- The local participant receives a meeting-joined event once the meeting is successfully joined.
- Remote participants receive a participant-joined event containing the newly joined participant.
Returns void
Example
```
let meeting;

// Initialize Meeting
meeting = VideoSDK.initMeeting({
  // ...
});

meeting?.join();
```
- Defined in meeting.d.ts:146

leave

leave(): void
- This method can be used to leave the currently joined meeting.
Events associated with leave():
- The local participant receives a meeting-left event.
- All remote participants receive a participant-left event containing the participant ID of the user who left.
Returns void
Example
```
let meeting;

// Initialize Meeting
meeting = VideoSDK.initMeeting({
  // ...
});

meeting?.leave();
```
- Defined in meeting.d.ts:168

muteMic

muteMic(): void
- This method can be used to disable the local participant’s microphone.
Events associated with muteMic():
- A stream-disabled event is emitted with the corresponding Stream object.
Returns void
Example
```
let meeting;

// Initialize Meeting
meeting = VideoSDK.initMeeting({
  // ...
});

meeting?.muteMic();
```
- Defined in meeting.d.ts:239

off

off(
    eventType:
        | "participant-joined"
        | "participant-left"
        | "participant-mode-change"
        | "speaker-changed"
        | "presenter-changed"
        | "main-participant-changed"
        | "entry-requested"
        | "entry-responded"
        | "recording-state-changed"
        | "livestream-state-changed"
        | "hls-state-changed"
        | "whiteboard-started"
        | "whiteboard-stopped"
        | "meeting-joined"
        | "meeting-left"
        | "mic-requested"
        | "webcam-requested"
        | "pin-state-changed"
        | "meeting-state-changed"
        | "error"
        | "transcription-state-changed"
        | "transcription-text"
        | "paused-all-streams"
        | "resumed-all-streams"
        | "media-relay-started"
        | "media-relay-stopped"
        | "media-relay-error"
        | "media-relay-request-response"
        | "media-relay-request-received",
    listener: (data: any) => void,
): void
Removes an event listener that was previously registered.
Parameters
- eventType:
      | "participant-joined"
      | "participant-left"
      | "participant-mode-change"
      | "speaker-changed"
      | "presenter-changed"
      | "main-participant-changed"
      | "entry-requested"
      | "entry-responded"
      | "recording-state-changed"
      | "livestream-state-changed"
      | "hls-state-changed"
      | "whiteboard-started"
      | "whiteboard-stopped"
      | "meeting-joined"
      | "meeting-left"
      | "mic-requested"
      | "webcam-requested"
      | "pin-state-changed"
      | "meeting-state-changed"
      | "error"
      | "transcription-state-changed"
      | "transcription-text"
      | "paused-all-streams"
      | "resumed-all-streams"
      | "media-relay-started"
      | "media-relay-stopped"
      | "media-relay-error"
      | "media-relay-request-response"
      | "media-relay-request-received"
  Event name to which you want to unsubscribe.
- listener: (data: any) => void
  Callback function which was passed while subscribing to the event
  
  To view the complete list of available events and their details, refer to MeetingEvent.
Returns void
- Defined in meeting.d.ts:1262

on

on(
    eventType:
        | "participant-joined"
        | "participant-left"
        | "participant-mode-change"
        | "speaker-changed"
        | "presenter-changed"
        | "main-participant-changed"
        | "entry-requested"
        | "entry-responded"
        | "recording-state-changed"
        | "livestream-state-changed"
        | "hls-state-changed"
        | "whiteboard-started"
        | "whiteboard-stopped"
        | "meeting-joined"
        | "meeting-left"
        | "mic-requested"
        | "webcam-requested"
        | "pin-state-changed"
        | "meeting-state-changed"
        | "error"
        | "transcription-state-changed"
        | "transcription-text"
        | "paused-all-streams"
        | "resumed-all-streams"
        | "media-relay-started"
        | "media-relay-stopped"
        | "media-relay-error"
        | "media-relay-request-response"
        | "media-relay-request-received",
    listener: (data: any) => void,
): void
Registers an event listener.
Parameters
- eventType:
      | "participant-joined"
      | "participant-left"
      | "participant-mode-change"
      | "speaker-changed"
      | "presenter-changed"
      | "main-participant-changed"
      | "entry-requested"
      | "entry-responded"
      | "recording-state-changed"
      | "livestream-state-changed"
      | "hls-state-changed"
      | "whiteboard-started"
      | "whiteboard-stopped"
      | "meeting-joined"
      | "meeting-left"
      | "mic-requested"
      | "webcam-requested"
      | "pin-state-changed"
      | "meeting-state-changed"
      | "error"
      | "transcription-state-changed"
      | "transcription-text"
      | "paused-all-streams"
      | "resumed-all-streams"
      | "media-relay-started"
      | "media-relay-stopped"
      | "media-relay-error"
      | "media-relay-request-response"
      | "media-relay-request-received"
  Event name to which you want to subscribe.
- listener: (data: any) => void
  Callback function which will be triggered when the event happens
  
  To view the complete list of available events and their details, refer to MeetingEvent.
Returns void
- Defined in meeting.d.ts:1221

pauseAllStreams

pauseAllStreams(kind?: "audio" | "video" | "share" | "shareAudio" | "all"): void
- This method can be used to pause active media streams in the meeting.
- The local participant will receive the paused-all-streams event.
Parameters
- Optionalkind: "audio" | "video" | "share" | "shareAudio" | "all"
  Specifies which type of media stream should be paused. If not provided, all media streams (audio, video, and screen share) will be paused.
Returns void
Example
```
let meeting;

// Initialize Meeting
meeting = VideoSDK.initMeeting({
  // ...
});

meeting?.pauseAllStreams("video");
```
- Defined in meeting.d.ts:1003

requestMediaRelay

requestMediaRelay(
    options: {
        destinationMeetingId: string;
        kinds?: ("audio" | "video" | "share")[];
        token?: string;
    },
): Promise<void>
- This method can be used to start relaying selected media streams from the current meeting to another destination meeting.
- Once the relay is successfully initiated, the local participant receives the media-relay-started event.
Parameters
- options: {
      destinationMeetingId: string;
      kinds?: ("audio" | "video" | "share")[];
      token?: string;
  }
  Configuration for media relay.
  - destinationMeetingId: string
    The ID of the destination meeting where media will be relayed.
  - Optionalkinds?: ("audio" | "video" | "share")[]
    Specifies which media tracks should be relayed.
  - Optionaltoken?: string
    Authentication token for the destination meeting.
Returns Promise<void>
A promise that resolves once the relay request is successfully processed.
Example
```
let meeting;

// Initialize Meeting
meeting = VideoSDK.initMeeting({
  // ...
});

meeting?.requestMediaRelay({
  destinationMeetingId: "destination-meeting-id",
  token: "auth-token",
  kinds: ["audio", "video"],
});
```
- Defined in meeting.d.ts:957

resumeAllStreams

resumeAllStreams(
kind?: "audio" | "video" | "share" | "shareAudio" | "all",
): void
- This method can be used to resume media streams that were previously paused.
- The local participant will receive the resumed-all-streams event.
Parameters
- Optionalkind: "audio" | "video" | "share" | "shareAudio" | "all"
  Specifies which type of media stream should be resumed.If not provided, all media streams (audio, video, and screen share) will be resumed.
Returns void
Example
```
let meeting;

// Initialize Meeting
meeting = VideoSDK.initMeeting({
  // ...
});

meeting?.resumeAllStreams("video");
```
- Defined in meeting.d.ts:1026

send

send(
payload: string | Blob | ArrayBuffer | ArrayBufferView<ArrayBufferLike>,
options?: { reliability?: "RELIABLE" | "UNRELIABLE" },
): Promise<boolean>
- This method can be used to send a message to all participants in the meeting using the data channel.
Parameters
- payload: string | Blob | ArrayBuffer | ArrayBufferView<ArrayBufferLike>
  The data to be sent.
  
  Supported types: string, Blob, ArrayBuffer, ArrayBufferView
  
  Maximum allowed size: 15 KiB
- Optionaloptions: { reliability?: "RELIABLE" | "UNRELIABLE" }
  - Optionalreliability?: "RELIABLE" | "UNRELIABLE"
    Determines how the message is delivered:
    
    reliabilityMode.RELIABLE — Guarantees delivery and preserves order (may introduce latency).
    
    reliabilityMode.UNRELIABLE — Faster delivery but messages may be dropped under poor network conditions.
Returns Promise<boolean>
Example
```
let meeting;

// Initialize Meeting
meeting = VideoSDK.initMeeting({
  // ...
});

meeting?.send("Hello everyone!", {
  reliability: VideoSDK.Constants.reliabilityMode.UNRELIABLE,
});
```
- Defined in meeting.d.ts:393

setWebcamQuality

setWebcamQuality(quality: "low" | "med" | "high"): void
- This method can be used to set the webcam video quality for the local participant.
- This method allows you to dynamically adjust the outgoing webcam video quality during the meeting.
Parameters
- quality: "low" | "med" | "high"
  Specifies the desired webcam quality.
  
  Allowed values:
  
  "low" – Low video quality
  
  "med" – Medium video quality
  
  "high" – High video quality
Returns void
Example
```
let meeting;

// Initialize Meeting
meeting = VideoSDK.initMeeting({
  // ...
});

meeting?.setWebcamQuality("high");
```
- Defined in meeting.d.ts:1108

startHls

startHls(
    config?: {
        layout?: {
            gridSize?: number;
            priority?: "SPEAKER" | "PIN";
            type?: "GRID" | "SPOTLIGHT" | "SIDEBAR";
        };
        mode?: "video-and-audio"
        | "audio";
        quality?: "low" | "med" | "high";
        recording?: { enabled: boolean };
        theme?: "DARK" | "LIGHT" | "DEFAULT";
    },
    transcription?: {
        enabled: boolean;
        summary?: { enabled: boolean; prompt?: string };
    },
): Promise<void>
- This method can be used to start HLS streaming for the meeting.
- This allows participants and viewers to watch the meeting via HLS playback.
- All participants, including the local participant, will receive the HLS_STARTING event state in the hls-state-changed event.
Parameters
- Optionalconfig: {
      layout?: {
          gridSize?: number;
          priority?: "SPEAKER" | "PIN";
          type?: "GRID" | "SPOTLIGHT" | "SIDEBAR";
      };
      mode?: "video-and-audio"
      | "audio";
      quality?: "low" | "med" | "high";
      recording?: { enabled: boolean };
      theme?: "DARK" | "LIGHT" | "DEFAULT";
  }
  Configuration used to control the HLS stream.
  - Optionallayout?: {
        gridSize?: number;
        priority?: "SPEAKER" | "PIN";
        type?: "GRID" | "SPOTLIGHT" | "SIDEBAR";
    }
    OptionalgridSize?: number
    Specifies the maximum number of participants shown in the grid.
    
    Optionalpriority?: "SPEAKER" | "PIN"
    Determines participant priority when composing the layout.
    
    Optionaltype?: "GRID" | "SPOTLIGHT" | "SIDEBAR"
    Defines the layout used in the HLS stream.
  - Optionalmode?: "video-and-audio" | "audio"
    Determines whether the stream includes video and audio or audio only.
  - Optionalquality?: "low" | "med" | "high"
    Defines the output video quality of the HLS stream.
  - Optionalrecording?: { enabled: boolean }
    This can be used to enable or disable recording.
  - Optionaltheme?: "DARK" | "LIGHT" | "DEFAULT"
    Defines the visual theme of the HLS stream.
- Optionaltranscription: { enabled: boolean; summary?: { enabled: boolean; prompt?: string } }
  Configuration for post-meeting transcription and summary generation.
  - enabled: boolean
    Enables or disables transcription.
  - Optionalsummary?: { enabled: boolean; prompt?: string }
    enabled: boolean
    Enables or disables summary generation.
    
    Optionalprompt?: string
    Custom prompt used for generating the summary.
Returns Promise<void>
Example
```
let meeting;

// Initialize Meeting
meeting = VideoSDK.initMeeting({
  // ...
});

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

const transcription = {
  enabled: true,
  summary: {
    enabled: true,
  },
};

meeting?.startHls(config, transcription);
```
- Defined in meeting.d.ts:758

startLivestream

startLivestream(
    outputs: { streamKey: string; url: string }[],
    config?: {
        layout?: {
            gridSize?: number;
            priority?: "SPEAKER" | "PIN";
            type?: "GRID" | "SPOTLIGHT" | "SIDEBAR";
        };
        recording?: { enabled: boolean };
        theme?: "DARK" | "LIGHT" | "DEFAULT";
    },
): void
- This method can be used to start live streaming the meeting.
- This allows you to stream the meeting to external platforms such as YouTube, Facebook, or any service that supports RTMP.
- All participants, including the local participant, will receive the LIVESTREAM_STARTING state in the livestream-state-changed event.
Parameters
- outputs: { streamKey: string; url: string }[]
  An array of RTMP output destinations where the livestream will be broadcast.
- Optionalconfig: {
      layout?: {
          gridSize?: number;
          priority?: "SPEAKER" | "PIN";
          type?: "GRID" | "SPOTLIGHT" | "SIDEBAR";
      };
      recording?: { enabled: boolean };
      theme?: "DARK" | "LIGHT" | "DEFAULT";
  }
  Configuration options for the RTMP livestream.
  - Optionallayout?: {
        gridSize?: number;
        priority?: "SPEAKER" | "PIN";
        type?: "GRID" | "SPOTLIGHT" | "SIDEBAR";
    }
    OptionalgridSize?: number
    Specifies the maximum number of participants displayed in the grid.
    
    Optionalpriority?: "SPEAKER" | "PIN"
    Determines participant priority when composing the livestream layout.
    
    Optionaltype?: "GRID" | "SPOTLIGHT" | "SIDEBAR"
    Defines the layout used for the livestream.
  - Optionalrecording?: { enabled: boolean }
    This can be used to enable or disable recording.
  - Optionaltheme?: "DARK" | "LIGHT" | "DEFAULT"
    Defines the color theme of the livestream.
Returns void
Example
```
let meeting;

// Initialize Meeting
meeting = VideoSDK.initMeeting({
  // ...
});

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",
  recording: {
    enabled: true,
  },
};

meeting?.startLivestream(outputs, config);
```
- Defined in meeting.d.ts:651

startRecording

startRecording(
    config?: {
        layout?: {
            gridSize?: number;
            priority?: "SPEAKER" | "PIN";
            type?: "GRID" | "SPOTLIGHT" | "SIDEBAR";
        };
        mode?: "video-and-audio"
        | "audio";
        quality?: "low" | "med" | "high";
        theme?: "DARK" | "LIGHT" | "DEFAULT";
    },
    webhookUrl?: string,
    awsDirPath?: string,
    transcription?: {
        enabled: boolean;
        summary?: { enabled: boolean; prompt?: string };
    },
): void
- This method can be used to start recording the meeting.
- All participants, including the local participant, will receive the RECORDING_STARTING event state in the recording-state-changed event.
Parameters
- Optionalconfig: {
      layout?: {
          gridSize?: number;
          priority?: "SPEAKER" | "PIN";
          type?: "GRID" | "SPOTLIGHT" | "SIDEBAR";
      };
      mode?: "video-and-audio"
      | "audio";
      quality?: "low" | "med" | "high";
      theme?: "DARK" | "LIGHT" | "DEFAULT";
  }
  Recording configuration options.
  - Optionallayout?: {
        gridSize?: number;
        priority?: "SPEAKER" | "PIN";
        type?: "GRID" | "SPOTLIGHT" | "SIDEBAR";
    }
    Defines how participants are arranged in the recording.
    
    OptionalgridSize?: number
    Maximum number of participants displayed simultaneously.
    
    Optionalpriority?: "SPEAKER" | "PIN"
    Determines participant prioritization.
    
    Optionaltype?: "GRID" | "SPOTLIGHT" | "SIDEBAR"
    Layout type for the recording.
  - Optionalmode?: "video-and-audio" | "audio"
    Defines whether the recording includes video or audio only.
  - Optionalquality?: "low" | "med" | "high"
    Controls the output quality of the recording.
  - Optionaltheme?: "DARK" | "LIGHT" | "DEFAULT"
    Visual theme applied to the recording.
- OptionalwebhookUrl: string
  Webhook URL triggered when the recording state changes.
- OptionalawsDirPath: string
  Path to the directory in your S3 bucket where recordings are stored.
- Optionaltranscription: { enabled: boolean; summary?: { enabled: boolean; prompt?: string } }
  Configuration for post-recording transcription and summary generation.
  - enabled: boolean
    Enables or disables transcription.
  - Optionalsummary?: { enabled: boolean; prompt?: string }
    enabled: boolean
    Enables or disables summary generation.
    
    Optionalprompt?: string
    Custom prompt used for generating transcription summaries.
Returns void
Example
```
let meeting;

// Initialize Meeting
meeting = VideoSDK.initMeeting({
  // ...
});

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

const awsDirPath = "/meeting-recordings/";

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

const transcription = {
  enabled: true,
  summary: {
    enabled: true,
  },
};

meeting?.startRecording(config, webhookUrl, awsDirPath, transcription);
```
- Defined in meeting.d.ts:549

startTranscription

startTranscription(
    options?: {
        modelConfig?: object;
        summary?: { enabled: boolean; prompt?: string };
        webhookUrl?: string;
    },
): void
- This method can be used to start real-time transcription for the meeting.
- All participants, including the local participant, will receive the TRANSCRIPTION_STARTING state in the transcription-state-changed event.
Parameters
- Optionaloptions: {
      modelConfig?: object;
      summary?: { enabled: boolean; prompt?: string };
      webhookUrl?: string;
  }
  - OptionalmodelConfig?: object
    Optional model configuration used during transcription.
  - Optionalsummary?: { enabled: boolean; prompt?: string }
    Configuration for real-time transcription summary generation.
    
    enabled: boolean
    Enables or disables summary generation.
    
    Optionalprompt?: string
    Custom instructions used to guide summary generation.
  - OptionalwebhookUrl?: string
    A webhook URL that will be called whenever the transcription state changes.
Returns void
Example
```
let meeting;

// Initialize Meeting
meeting = VideoSDK.initMeeting({
  // ...
});

const config = {
  webhookUrl: "https://webhook.your-api-server.com",
  summary: {
    enabled: true,
    prompt: "Write summary in sections like Title, Agenda, Speakers, Action Items, and Notes",
  },
};

meeting?.startTranscription(config);
```
- Defined in meeting.d.ts:442

startWhiteboard

startWhiteboard(): Promise<void>
- This method can be used to start the whiteboard session.
- All participants, including the local participant, will receive the whiteboard-started event.
Returns Promise<void>
Example
```
let meeting;

// Initialize Meeting
meeting = VideoSDK.initMeeting({
  // ...
});

meeting?.startWhiteboard();
```
- Defined in meeting.d.ts:1126

stopHls

stopHls(): void
- This method can be used to stop the active HLS stream.
- All participants, including the local participant, will receive the HLS_STOPPING event state in the hls-state-changed event.
Returns void
Example
```
let meeting;

// Initialize Meeting
meeting = VideoSDK.initMeeting({
  // ...
});

meeting?.stopHls();
```
- Defined in meeting.d.ts:797

stopLivestream

stopLivestream(): void
- This method can be used to stop the ongoing livestream.
- All participants, including the local participant, will receive the LIVESTREAM_STOPPING state in the livestream-state-changed event.
Returns void
Example
```
let meeting;

// Initialize Meeting
meeting = VideoSDK.initMeeting({
  // ...
});

meeting?.stopLivestream();
```
- Defined in meeting.d.ts:685

stopMediaRelay

stopMediaRelay(destinationMeetingId: string): Promise<void>
- This method can be used to stop the ongoing media relay to a destination meeting.
- Once stopped, the local participant will receive the media-relay-stopped event.
Parameters
- destinationMeetingId: string
  The ID of the destination meeting where media relay should be stopped.
Returns Promise<void>
Example
```
let meeting;

// Initialize Meeting
meeting = VideoSDK.initMeeting({
  // ...
});

meeting?.stopMediaRelay("destination-meeting-id");
```
- Defined in meeting.d.ts:982

stopRecording

stopRecording(): void
- This method can be used to stop the ongoing meeting recording.
- All participants, including the local participant, will receive the RECORDING_STOPPING event state in the recording-state-changed event.
Returns void
Example
```
let meeting;

// Initialize Meeting
meeting = VideoSDK.initMeeting({
  // ...
});

meeting?.stopRecording();
```
- Defined in meeting.d.ts:588

stopTranscription

stopTranscription(): void
- This method can be used to stop the ongoing real-time transcription.
- All participants, including the local participant, will receive the TRANSCRIPTION_STOPPING state in the transcription-state-changed event.
Returns void
Example
```
let meeting;

// Initialize Meeting
meeting = VideoSDK.initMeeting({
  // ...
});

meeting?.stopTranscription();
```
- Defined in meeting.d.ts:468

stopWhiteboard

stopWhiteboard(): Promise<void>
- This method can be used to stop the ongoing whiteboard session.
- All participants, including the local participant, will receive the whiteboard-stopped event.
Returns Promise<void>
Example
```
let meeting;

// Initialize Meeting
meeting = VideoSDK.initMeeting({
  // ...
});

meeting?.stopWhiteboard();
```
- Defined in meeting.d.ts:1144

switchTo

switchTo(options: { meetingId: string; token?: string }): void
- This method can be used to switch the current session to another meeting without disconnecting.
- This allows a seamless transition between meetings while preserving the active session context.
Parameters
- options: { meetingId: string; token?: string }
  Configuration for switching meetings.
  - meetingId: string
    The ID of the meeting to switch to.
  - Optionaltoken?: string
    Authentication token for the destination meeting.
Returns void
Example
```
let meeting;

// Initialize Meeting
meeting = VideoSDK.initMeeting({
  // ...
});

meeting?.switchTo({
  meetingId: "new-meeting-id",
  token: "optional-auth-token",
});
```
- Defined in meeting.d.ts:921

unmuteMic

unmuteMic(customAudioTrack?: MediaStream): void
- This method can be used to enable the local participant’s microphone.
Events associated with unmuteMic():
- A stream-enabled event is emitted with the corresponding Stream object.
Parameters
- OptionalcustomAudioTrack: MediaStream
  An optional custom audio track to be used instead of the default one.
  
  To learn more, checkout this reference
Returns void
Example
```
let meeting;

// Initialize Meeting
meeting = VideoSDK.initMeeting({
  // ...
});

meeting?.unmuteMic();
```
- Defined in meeting.d.ts:265

uploadBase64File

uploadBase64File(
options: { base64Data: string; fileName: string; token: string },
): Promise<string>
- This method can be used to upload a file to VideoSDK's temporary storage.
- This method returns a fileUrl, which can later be used to retrieve the uploaded file.
Parameters
- options: { base64Data: string; fileName: string; token: string }
  - base64Data: string
    Base64-encoded representation of the file.
  - fileName: string
    Name of the file including its extension.
  - token: string
    VideoSDK authentication token. Learn more about tokens here.
Returns Promise<string>
Example
```
const fileUrl = await meeting.uploadBase64File({
  base64Data: "<BASE64_DATA>", // Convert your file to base64 and pass here
  token: "<VIDEOSDK_TOKEN>",
  fileName: "image.jpeg", // Provide name with extension here,
});

console.log("File URL:", fileUrl);
```
- Defined in meeting.d.ts:1172

Class Meeting

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Meeting

Properties

activePresenterId

activeSpeakerId

hlsState

hlsUrls

id

isE2EEEnabled

livestreamState

localParticipant

mainParticipantId

participants

pinnedParticipants

pubSub

realtimeStore

recordingState

selectedCameraDevice

selectedMicrophoneDevice

transcriptionState

Methods

changeMic

Parameters

Returns void

Example

changeMode

Parameters

Returns void

Example

changeWebcam

Parameters

Returns void

Example

disableAdaptiveSubscription

Returns void

Example

disableScreenShare

Returns void

Example

disableWebcam

Returns void

Example

enableAdaptiveSubscription

Returns void

Example

enableScreenShare

Parameters

Returns void

Example

enableWebcam

Parameters

Returns void

Example

end

Returns void

Example

fetchBase64File

Parameters

token: string

url: string

Returns Promise<string>

Example

getMics

Returns Promise<{ deviceId: string; label: string }[]>

Example

getWebcams

Returns Promise< { deviceId: string; facingMode: "environment" | "front"; label: string }[],>

Example

join

Returns void

Example

leave

Returns void

Example

Returns Promise<
{ deviceId: string; facingMode: "environment"
| "front"; label: string }[],
>

`Optional`kinds?: ("audio" | "video" | "share")[]

`Optional`token?: string

`Optional`reliability?: "RELIABLE" | "UNRELIABLE"

`Optional`layout?: {
gridSize?: number;
priority?: "SPEAKER" | "PIN";
type?: "GRID" | "SPOTLIGHT" | "SIDEBAR";
}

`Optional`gridSize?: number

`Optional`priority?: "SPEAKER" | "PIN"

`Optional`type?: "GRID" | "SPOTLIGHT" | "SIDEBAR"

`Optional`mode?: "video-and-audio" | "audio"

`Optional`quality?: "low" | "med" | "high"

`Optional`recording?: { enabled: boolean }

`Optional`theme?: "DARK" | "LIGHT" | "DEFAULT"

`Optional`summary?: { enabled: boolean; prompt?: string }

`Optional`prompt?: string

`Optional`layout?: {
gridSize?: number;
priority?: "SPEAKER" | "PIN";
type?: "GRID" | "SPOTLIGHT" | "SIDEBAR";
}

`Optional`gridSize?: number

`Optional`priority?: "SPEAKER" | "PIN"

`Optional`type?: "GRID" | "SPOTLIGHT" | "SIDEBAR"

`Optional`recording?: { enabled: boolean }

`Optional`theme?: "DARK" | "LIGHT" | "DEFAULT"

`Optional`layout?: {
gridSize?: number;
priority?: "SPEAKER" | "PIN";
type?: "GRID" | "SPOTLIGHT" | "SIDEBAR";
}

`Optional`gridSize?: number

`Optional`priority?: "SPEAKER" | "PIN"

`Optional`type?: "GRID" | "SPOTLIGHT" | "SIDEBAR"

`Optional`mode?: "video-and-audio" | "audio"

`Optional`quality?: "low" | "med" | "high"

`Optional`theme?: "DARK" | "LIGHT" | "DEFAULT"

`Optional`summary?: { enabled: boolean; prompt?: string }