Class Participant

constructor

• new Participant(): Participant

  Returns Participant

displayName

id

local

metaData

micOn

mode

pinState

quality

screenShareAudioOn

screenShareOn

screenShareQuality

streams

webcamOn

captureImage

• captureImage(options?: { height?: number; width?: number }): Promise<string>
  • This method can be used to capture an image from the participant’s current video stream.
  • The captured image is returned as a Base64-encoded string.

  Parameters

  • Optionaloptions: { height?: number; width?: number }

    • Optionalheight?: number

      Desired height of the captured image.

    • Optionalwidth?: number

      Desired width of the captured image.

  Returns Promise<string>

  A Base64-encoded string representing the captured image, or null if the image could not be captured.

  Example

  let meeting;
  
  // Initialize Meeting
  meeting = VideoSDK.initMeeting({
    // ...
  });
  
  const participant = Array.from(meeting.participants.values())[0];
  // captureImage returns a Base64 string
  const base64Data = await participant.captureImage();
  console.log("base64", base64Data);
  Copy

disableMic

• disableMic(): void
  • This method can be used to disable the remote participant’s microphone.

  Events associated with disableMic():

  • All participants receive a stream-disabled event containing the corresponding stream object.

  Returns void

  Example

  let meeting;
  
  // Initialize Meeting
  meeting = VideoSDK.initMeeting({
    // ...
  });
  
  const participant = Array.from(meeting.participants.values())[0];
  participant.disableMic();
  Copy

disableWebcam

• disableWebcam(): void
  • This method can be used to disable the remote participant’s webcam.

  Events associated with disableWebcam():

  • All participants receive a stream-disabled event containing the corresponding stream object.

  Returns void

  Example

  let meeting;
  
  // Initialize Meeting
  meeting = VideoSDK.initMeeting({
    // ...
  });
  
  const participant = Array.from(meeting.participants.values())[0];
  participant.disableWebcam();
  Copy

enableMic

• enableMic(): void
  • This method can be used to enable the remote participant’s microphone.

  Events associated with enableMic():

  • The participant first receives a mic-requested event. Once the request is accepted, the microphone is enabled.
  • All participants receive a stream-enabled even containing the corresponding stream object.

  Returns void

  Example

  let meeting;
  
  // Initialize Meeting
  meeting = VideoSDK.initMeeting({
    // ...
  });
  
  const participant = Array.from(meeting.participants.values())[0];
  participant.enableMic();
  Copy

enableWebcam

• enableWebcam(): void
  • This method can be used to enable the remote participant’s webcam.

  Events associated with enableWebcam():

  • The participant first receives a webcam-requested event. Once the request is accepted, the webcam is enabled.

  • All participants receive a stream-enabled event containing the corresponding stream object.

  Returns void

  Example

  let meeting;
  
  // Initialize Meeting
  meeting = VideoSDK.initMeeting({
    // ...
  });
  
  const participant = Array.from(meeting.participants.values())[0];
  participant.enableWebcam();
  Copy

getAudioStats

• getAudioStats(): Promise<
      {
          bitrate: number;
          codec: string;
          jitter: number;
          network: string;
          packetsLost: number;
          rtt: number;
          totalPackets: number;
      }[],
  >
  • This method can be used to get detailed statistics about the participant’s audio stream.
  • These metrics provide insights into stream quality, network conditions, and transmission performance at the time the method is called.

  Returns Promise<
      {
          bitrate: number;
          codec: string;
          jitter: number;
          network: string;
          packetsLost: number;
          rtt: number;
          totalPackets: number;
      }[],
  >

  An array of objects containing the following metrics:

  • jitter – Represents variation in packet arrival time (stream instability).
  • bitrate – The bitrate at which the audio stream is being transmitted.
  • totalPackets – Total number of packets transmitted for the stream.
  • packetsLost – Total number of packets lost during transmission.
  • rtt – Round-trip time (in milliseconds) between the client and server.
  • codec – Codec used for encoding the audio stream.
  • network – Network type used for transmitting the stream.

  Info

  If the rtt value exceeds 300ms, consider switching to a region closer to the user for improved performance. Learn more visit here.

  Example

  let meeting;
  
  // Initialize Meeting
  meeting = VideoSDK.initMeeting({
    // ...
  });
  
  const audioStats = await meeting.localParticipant.getAudioStats();
  Copy

getShareAudioStats

• getShareAudioStats(): Promise<
      {
          bitrate: number;
          codec: string;
          jitter: number;
          network: string;
          packetsLost: number;
          rtt: number;
          totalPackets: number;
      }[],
  >
  • This method can be used to get detailed statistics about the participant’s screen share audio stream.
  • These metrics provide insights into stream quality, network conditions, and transmission performance at the time the method is called.

  Returns Promise<
      {
          bitrate: number;
          codec: string;
          jitter: number;
          network: string;
          packetsLost: number;
          rtt: number;
          totalPackets: number;
      }[],
  >

  An array of objects containing the following metrics:

  • jitter – Represents variation in packet arrival time (stream instability).
  • bitrate – The bitrate at which the audio stream is being transmitted.
  • totalPackets – Total number of packets transmitted for the stream.
  • packetsLost – Total number of packets lost during transmission.
  • rtt – Round-trip time (in milliseconds) between the client and server.
  • codec – Codec used for encoding the audio stream.
  • network – Network type used for transmitting the stream.

  Info

  If the rtt value exceeds 300ms, consider switching to a region closer to the user for improved performance. Learn more visit here.

  Example

  let meeting;
  
  // Initialize Meeting
  meeting = VideoSDK.initMeeting({
    // ...
  });
  
  const shareAudioStats = await meeting.localParticipant.getShareAudioStats();
  Copy

getShareStats

• getShareStats(): Promise<
      {
          bitrate: number;
          codec: string;
          currentSpatialLayer: number;
          currentTemporalLayer: number;
          jitter: number;
          limitation: any;
          network: string;
          packetsLost: number;
          preferredSpatialLayer: number;
          preferredTemporalLayer: number;
          rtt: number;
          size: any;
          totalPackets: number;
      }[],
  >
  • This method can be used to get detailed statistics about the participant’s screen share video stream.
  • These metrics provide insights into stream quality, network conditions, and transmission performance at the time the method is called.

  Returns Promise<
      {
          bitrate: number;
          codec: string;
          currentSpatialLayer: number;
          currentTemporalLayer: number;
          jitter: number;
          limitation: any;
          network: string;
          packetsLost: number;
          preferredSpatialLayer: number;
          preferredTemporalLayer: number;
          rtt: number;
          size: any;
          totalPackets: number;
      }[],
  >

  An array of objects containing the following metrics:

  • jitter – Represents variation in packet arrival time (stream instability).
  • bitrate – The bitrate at which the video stream is being transmitted.
  • totalPackets – Total number of packets transmitted for the stream.
  • packetsLost – Total number of packets lost during transmission.
  • rtt – Round-trip time (in milliseconds) between the client and server.
  • codec – Codec used for encoding the video stream.
  • network – Network type used for transmitting the stream.
  • limitation – Indicates any limitations affecting stream quality.
  • size – Resolution or size information related to the stream.

  Info

  If the rtt value exceeds 300ms, consider switching to a region closer to the user for improved performance. Learn more visit here.

  Example

  let meeting;
  
  // Initialize Meeting
  meeting = VideoSDK.initMeeting({
    // ...
  });
  
  const shareStats = await meeting.localParticipant.getShareStats();
  Copy

getVideoStats

• getVideoStats(): Promise<
      {
          bitrate: number;
          codec: string;
          currentSpatialLayer: number;
          currentTemporalLayer: number;
          jitter: number;
          limitation: any;
          network: string;
          packetsLost: number;
          preferredSpatialLayer: number;
          preferredTemporalLayer: number;
          rtt: number;
          size: any;
          totalPackets: number;
      }[],
  >
  • This method can be used to get detailed statistics about the participant’s video stream.
  • These metrics provide insights into stream quality, network conditions, and transmission performance at the time the method is called.

  Returns Promise<
      {
          bitrate: number;
          codec: string;
          currentSpatialLayer: number;
          currentTemporalLayer: number;
          jitter: number;
          limitation: any;
          network: string;
          packetsLost: number;
          preferredSpatialLayer: number;
          preferredTemporalLayer: number;
          rtt: number;
          size: any;
          totalPackets: number;
      }[],
  >

  An array of objects containing the following metrics:

  • jitter – Represents variation in packet arrival time (stream instability).
  • bitrate – The bitrate at which the video stream is being transmitted.
  • totalPackets – Total number of packets transmitted for the stream.
  • packetsLost – Total number of packets lost during transmission.
  • rtt – Round-trip time (in milliseconds) between the client and server.
  • codec – Codec used for encoding the video stream.
  • network – Network type used for transmitting the stream.
  • limitation – Indicates any limitations affecting stream quality.
  • size – Resolution or size information related to the stream.

  Info

  If the rtt value exceeds 300ms, consider switching to a region closer to the user for improved performance. Learn more visit here.

  Example

  let meeting;
  
  // Initialize Meeting
  meeting = VideoSDK.initMeeting({
    // ...
  });
  
  const videoStats = await meeting.localParticipant.getVideoStats();
  Copy

off

• off(
      eventType:
          | "stream-enabled"
          | "stream-disabled"
          | "media-status-changed"
          | "video-quality-changed"
          | "stream-paused"
          | "stream-resumed"
          | "e2ee-state-change",
      listener: (data: any) => void,
  ): void

  Removes an event listener that was previously registered.

  Parameters

  • eventType:
        | "stream-enabled"
        | "stream-disabled"
        | "media-status-changed"
        | "video-quality-changed"
        | "stream-paused"
        | "stream-resumed"
        | "e2ee-state-change"

    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 ParticipantEvent.

  Returns void

on

• on(
      eventType:
          | "stream-enabled"
          | "stream-disabled"
          | "media-status-changed"
          | "video-quality-changed"
          | "stream-paused"
          | "stream-resumed"
          | "e2ee-state-change",
      listener: (data: any) => void,
  ): void

  Registers an event listener.

  Parameters

  • eventType:
        | "stream-enabled"
        | "stream-disabled"
        | "media-status-changed"
        | "video-quality-changed"
        | "stream-paused"
        | "stream-resumed"
        | "e2ee-state-change"

    Event name to which you want to subscribe.

  • listener: (data: any) => void

    A callback function that is executed when the specified event is emitted.

    To view the complete list of available events and their details, refer to ParticipantEvent.

  Returns void

pin

• pin(type: "SHARE_AND_CAM" | "CAM" | "SHARE"): void

  • This method can be used to pin the participant’s camera, screen share, or both.

  • Every participant receives a pin-state-changed event when the pin state is updated.

  Parameters

  • type: "SHARE_AND_CAM" | "CAM" | "SHARE"

    Specifies which stream to pin.

    Allowed values:

    • "SHARE_AND_CAM" – Pins both screen share and camera streams.
    • "CAM" – Pins only the camera stream.
    • "SHARE" – Pins only the screen-share stream.

    Default

    SHARE_AND_CAM
    Copy

  Returns void

  Example

  let meeting;
  
  // Initialize Meeting
  meeting = VideoSDK.initMeeting({
    // ...
  });
  
  const participant = Array.from(meeting.participants.values())[0];
  participant.pin("CAM");
  Copy

remove

• remove(): void
  • This method can be used to removes the remote participant from the meeting.

  Returns void

  Example

  let meeting;
  
  // Initialize Meeting
  meeting = VideoSDK.initMeeting({
    // ...
  });
  
  const participant = Array.from(meeting.participants.values())[0];
  participant.remove();
  Copy

renderAudio

• renderAudio(options?: { type?: "audio" | "shareAudio" }): HTMLAudioElement
  • This method creates and returns an HTMLAudioElement that can be used to play incoming audio streams in the DOM.

  Parameters

  • Optionaloptions: { type?: "audio" | "shareAudio" }

    • Optionaltype?: "audio" | "shareAudio"

      Type: "audio" | "shareAudio"

      • "audio" – Renders the participant’s microphone audio stream.
      • "shareAudio" – Renders the audio stream associated with screen sharing.

      Default

      "audio"
      Copy

  Returns HTMLAudioElement

  An HTMLAudioElement that plays the requested audio stream.

  Example

  const audioElement = participant.renderAudio({
    type: "audio",
  });
  
  document.body.appendChild(audioElement);
  Copy

renderVideo

• renderVideo(
      options?: {
          containerStyle?: Partial<CSSStyleDeclaration>;
          maxQuality?: "low" | "med" | "high" | "auto";
          type?: "video" | "share";
          videostyle?: Partial<CSSStyleDeclaration>;
      },
  ): HTMLDivElement
  • This method creates and returns a <div> element that internally manages the rendering of the participant’s video or screen-share stream.
  • It allows you to control the rendered stream type, quality preference and styling of both the video element and its container.

  Parameters

  • Optionaloptions: {
        containerStyle?: Partial<CSSStyleDeclaration>;
        maxQuality?: "low" | "med" | "high" | "auto";
        type?: "video" | "share";
        videostyle?: Partial<CSSStyleDeclaration>;
    }

    Optional configuration for rendering the stream.

    • OptionalcontainerStyle?: Partial<CSSStyleDeclaration>

      CSS styles applied to the outer container <div>.

    • OptionalmaxQuality?: "low" | "med" | "high" | "auto"

      Sets the preferred maximum quality for the rendered stream.

      Allowed value:

      • "auto" – Automatically adapts quality based on network conditions (default)
      • "high" – Highest available quality
      • "med" – Medium quality
      • "low" – Low quality for bandwidth-constrained scenarios

    • Optionaltype?: "video" | "share"

      Specifies which stream to render.

      Allowed value:

      • "video" – Camera video stream (default)
      • "share" – Screen-share video stream

    • Optionalvideostyle?: Partial<CSSStyleDeclaration>

      CSS styles applied directly to the internal <video> element.

  Returns HTMLDivElement

  An HTMLDivElement containing the rendered video or screen-share stream.

  Example

  const videoElement = participant.renderVideo({
    type: "video",
    maxQuality: "high",
    videostyle: {
      objectFit: "cover",
      borderRadius: "8px",
    },
    containerStyle: {
      width: "300px",
      height: "200px",
    },
  });
  
  document.body.appendChild(videoElement);
  Copy

setQuality

• setQuality(quality: "low" | "med" | "high"): void
  • This method can be used to set the incoming video quality of the remote participant.

  Parameters

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

  Returns void

  Example

  let meeting;
  
  // Initialize Meeting
  meeting = VideoSDK.initMeeting({
    // ...
  });
  
  const participant = Array.from(meeting.participants.values())[0];
  participant.setQuality("low");
  Copy

setScreenShareQuality

• setScreenShareQuality(quality: "low" | "med" | "high"): void
  • This method can be used to set the quality of the incoming screen-share video of the remote participant.

  Parameters

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

  Returns void

  Example

  let meeting;
  
  // Initialize Meeting
  meeting = VideoSDK.initMeeting({
    // ...
  });
  
  const participant = Array.from(meeting.participants.values())[0];
  participant.setScreenShareQuality("low");
  Copy

setViewPort

• setViewPort(width: number, height: number): void
  • This method can be used to adjust the video quality of the remote participant based on the specified viewport dimensions.

  Parameters

  • width: number

    The width of the viewport used to determine the video quality.

  • height: number

    The height of the viewport used to determine the video quality.

  Returns void

  Example

  let meeting;
  
  // Initialize Meeting
  meeting = VideoSDK.initMeeting({
    // ...
  });
  
  const participant = Array.from(meeting.participants.values())[0];
  participant.setViewPort(300,300);
  Copy

unpin

• unpin(type: "SHARE_AND_CAM" | "CAM" | "SHARE"): void

  • This method can be used to unpin the participant’s camera, screen share, or both.

  • Every participant receives a pin-state-changed event when the pin state is updated.

  Parameters

  • type: "SHARE_AND_CAM" | "CAM" | "SHARE"

    Specifies which stream to unpin.

    Allowed values:

    • "SHARE_AND_CAM" – Unpins both screen share and camera streams.
    • "CAM" – Unpins only the camera stream.
    • "SHARE" – Unpins only the screen-share stream.

    Default

    "SHARE_AND_CAM"
    Copy

  Returns void

  Example

  let meeting;
  
  // Initialize Meeting
  meeting = VideoSDK.initMeeting({
    // ...
  });
  
  const participant = Array.from(meeting.participants.values())[0];
  participant.unpin("CAM");
  Copy