Class AgentParticipant

Hierarchy (View Summary)

Participant
- AgentParticipant

Constructors

constructor

new AgentParticipant(): AgentParticipant

Returns AgentParticipant

Inherited from Participant.constructor

Properties

agentId

agentId: string

This represents the agent ID of the agentParticipant.

`Readonly`agentState

agentState: string

This represents the current state of the agentParticipant (for example, LISTENING, SPEAKING).

Possible values: AgentState

displayName

displayName: string

This represents display name of the agentParticipant.

id

id: string

This represents unique ID of the agentParticipant who joined the meeting.

isAgent

isAgent: boolean

This represents whether the participant is an agent.

local

local: boolean

This indicates whether this participant is the local user.

true → Local participant (you)
false → Remote participant

metaData

metaData: object

This represents agentParticipant’s metadata provided while initializing the meeting

micOn

micOn: boolean

This indicates whether the agentParticipant’s microphone is currently enabled.

mode

mode: "SEND_AND_RECV" | "SIGNALLING_ONLY" | "RECV_ONLY"

This represents the agentParticipant’s current mode.

pinState

pinState: { cam: boolean; share: boolean }

This represents the current pin state of the agentParticipant.

quality

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

This represents the current quality level of the participant’s video stream.

screenShareAudioOn

screenShareAudioOn: boolean

This indicates whether the participant’s screenshare audio is currently enabled.

screenShareOn

screenShareOn: boolean

This indicates whether the participant’s screenShare is currently enabled.

screenShareQuality

screenShareQuality: "low" | "med" | "high"

This represents the quality level of the participant’s screen-sharing stream.

streams

streams: Map<string, Stream>

This represents all media streams associated with the agentParticipant. Streams could be audio or video.

webcamOn

webcamOn: boolean

This indicates whether the agentParticipant’s webcam is currently enabled.

Methods

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.
Throws
- Errors.ERROR_WEBCAM_NOT_ENABLED — participant's webcam is off (no video stream to capture)
- Errors.ERROR_CAPTURE_IMAGE_FAILED — draw / encode failed while capturing the frame
Example
```
let meeting;

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

const participant = Array.from(meeting.participants.values())[0];
try {
  // captureImage returns a Base64 string
  const base64Data = await participant.captureImage();
  console.log("base64", base64Data);
} catch (err) {
  console.log("Error in captureImage", err);
}
```
Inherited from Participant.captureImage
- Defined in participant.d.ts:516

consumeMicStreams

consumeMicStreams(): Promise<void>
- This method can be used to start consuming the agentParticipant's microphone audio stream when autoConsume was set to false in initMeeting().
Returns Promise<void>
Throws
- Errors.ERROR_ACTION_PERFORMED_BEFORE_MEETING_JOINED — called before meeting is joined
- Errors.ERROR_MEETING_RECONNECTING — meeting is reconnecting
- Errors.CONSUME_MIC_STREAMS_FAILED — server rejected the consume request
Example
```
let meeting;

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

const agentParticipant = Array.from(meeting.participants.values()).find(
  (p) => p.isAgent
);

try {
  await agentParticipant.consumeMicStreams();
} catch (err) {
  console.log("Error in consumeMicStreams", err);
}
```
Overrides Participant.consumeMicStreams
- Defined in agentParticipant.d.ts:404

consumeWebcamStreams

consumeWebcamStreams(): Promise<void>
- This method can be used to start consuming the agentParticipant's webcam video stream when autoConsume was set to false in initMeeting().
Returns Promise<void>
Throws
- Errors.ERROR_ACTION_PERFORMED_BEFORE_MEETING_JOINED — called before meeting is joined
- Errors.ERROR_MEETING_RECONNECTING — meeting is reconnecting
- Errors.CONSUME_WEBCAM_STREAMS_FAILED — server rejected the consume request
Example
```
let meeting;

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

const agentParticipant = Array.from(meeting.participants.values()).find(
  (p) => p.isAgent
);

try {
  await agentParticipant.consumeWebcamStreams();
} catch (err) {
  console.log("Error in consumeWebcamStreams", err);
}
```
Overrides Participant.consumeWebcamStreams
- Defined in agentParticipant.d.ts:434

disableMic

disableMic(): Promise<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 Promise<void>
Throws
- Errors.ERROR_ACTION_PERFORMED_BEFORE_MEETING_JOINED — called before meeting is joined
- Errors.ERROR_MEETING_RECONNECTING — meeting is reconnecting
- Errors.DISABLE_PARTICIPANT_MIC_FAILED — server rejected the request
Example
```
let meeting;

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

const participant = Array.from(meeting.participants.values())[0];
try {
  await participant.disableMic();
} catch (err) {
  console.log("Error in disableMic", err);
}
```
Inherited from Participant.disableMic
- Defined in participant.d.ts:163

disableWebcam

disableWebcam(): Promise<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 Promise<void>
Throws
- Errors.ERROR_ACTION_PERFORMED_BEFORE_MEETING_JOINED — called before meeting is joined
- Errors.ERROR_MEETING_RECONNECTING — meeting is reconnecting
- Errors.DISABLE_PARTICIPANT_WEBCAM_FAILED — server rejected the request
Example
```
let meeting;

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

const participant = Array.from(meeting.participants.values())[0];
try {
  await participant.disableWebcam();
} catch (err) {
  console.log("Error in disableWebcam", err);
}
```
Inherited from Participant.disableWebcam
- Defined in participant.d.ts:227

enableMic

enableMic(): Promise<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 Promise<void>
Throws
- Errors.ERROR_ACTION_PERFORMED_BEFORE_MEETING_JOINED — called before meeting is joined
- Errors.ERROR_MEETING_RECONNECTING — meeting is reconnecting
- Errors.ENABLE_PARTICIPANT_MIC_FAILED — server rejected the request
Example
```
let meeting;

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

const participant = Array.from(meeting.participants.values())[0];
try {
  await participant.enableMic();
} catch (err) {
  console.log("Error in enableMic", err);
}
```
Inherited from Participant.enableMic
- Defined in participant.d.ts:131

enableWebcam

enableWebcam(): Promise<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 Promise<void>
Throws
- Errors.ERROR_ACTION_PERFORMED_BEFORE_MEETING_JOINED — called before meeting is joined
- Errors.ERROR_MEETING_RECONNECTING — meeting is reconnecting
- Errors.ENABLE_PARTICIPANT_WEBCAM_FAILED — server rejected the request
Example
```
let meeting;

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

const participant = Array.from(meeting.participants.values())[0];
try {
  await participant.enableWebcam();
} catch (err) {
  console.log("Error in enableWebcam", err);
}
```
Inherited from Participant.enableWebcam
- Defined in participant.d.ts:196

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 agentParticipant'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 agentParticipant = Array.from(meeting.participants.values()).find(
  (p) => p.isAgent
);

try {
  const audioStats = await agentParticipant.getAudioStats();
} catch (err) {
  console.log("Error in getAudioStats", err);
}
```
Overrides Participant.getAudioStats
- Defined in agentParticipant.d.ts:364

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({
  // ...
});

try {
  const shareAudioStats = await meeting.localParticipant.getShareAudioStats();
} catch (err) {
  console.log("Error in getShareAudioStats", err);
}
```
Inherited from Participant.getShareAudioStats
- Defined in participant.d.ts:666

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({
  // ...
});

try {
  const shareStats = await meeting.localParticipant.getShareStats();
} catch (err) {
  console.log("Error in getShareStats", err);
}
```
Inherited from Participant.getShareStats
- Defined in participant.d.ts:613

getTransportStats

getTransportStats(): Promise<
    {
        receive: { incomingBitrate: number; totalReceivedBytes: number };
        send: { outgoingBitrate: number; totalSentBytes: number };
    },
>
- This method can be used to get the transport-level statistics for this participant.
- These metrics provide an overview of the total bandwidth and bytes transferred for sending and receiving media at the transport layer.
Returns Promise<
    {
        receive: { incomingBitrate: number; totalReceivedBytes: number };
        send: { outgoingBitrate: number; totalSentBytes: number };
    },
>
An object with two nested objects, or null:
- send.outgoingBitrate – The total outgoing bitrate (in kbps) across all media streams sent by this participant. Returns 0 or null when the value is unavailable.
- send.totalSentBytes – The total number of bytes sent by this participant across all media streams. Returns 0 or null when the value is unavailable.
- receive.incomingBitrate – The total incoming bitrate (in kbps) across all media streams received by this participant. Returns 0 or null when the value is unavailable.
- receive.totalReceivedBytes – The total number of bytes received by this participant across all media streams. Returns 0 or null when the value is unavailable.
Example
```
let meeting;

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

try {
  const transportStats = await meeting.localParticipant.getTransportStats();
  if (transportStats) {
    console.log("Outgoing bitrate:", transportStats.send.outgoingBitrate, "kbps");
    console.log("Total sent bytes:", transportStats.send.totalSentBytes);
    console.log("Incoming bitrate:", transportStats.receive.incomingBitrate, "kbps");
    console.log("Total received bytes:", transportStats.receive.totalReceivedBytes);
  }
} catch (err) {
  console.log("Error in getTransportStats", err);
}
```
Inherited from Participant.getTransportStats
- Defined in participant.d.ts:759

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 agentParticipant'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 agentParticipant = Array.from(meeting.participants.values()).find(
  (p) => p.isAgent
);

try {
  const videoStats = await agentParticipant.getVideoStats();
} catch (err) {
  console.log("Error in getVideoStats", err);
}
```
Overrides Participant.getVideoStats
- Defined in agentParticipant.d.ts:307

off

off(
    eventType:
        | "stream-enabled"
        | "stream-disabled"
        | "media-status-changed"
        | "agent-state-changed"
        | "agent-transcription-received"
        | "agent-metrics",
    listener: (data: any) => void,
): void
Removes an event listener that was previously registered.
Parameters
- eventType:
      | "stream-enabled"
      | "stream-disabled"
      | "media-status-changed"
      | "agent-state-changed"
      | "agent-transcription-received"
      | "agent-metrics"
  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 AgentParticipantEvent.
Returns void
Overrides Participant.off
- Defined in agentParticipant.d.ts:522

on

on(
    eventType:
        | "stream-enabled"
        | "stream-disabled"
        | "media-status-changed"
        | "agent-state-changed"
        | "agent-transcription-received"
        | "agent-metrics",
    listener: (data: any) => void,
): void
Registers an event listener.
Parameters
- eventType:
      | "stream-enabled"
      | "stream-disabled"
      | "media-status-changed"
      | "agent-state-changed"
      | "agent-transcription-received"
      | "agent-metrics"
  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 AgentParticipantEvent.
Returns void
Overrides Participant.on
- Defined in agentParticipant.d.ts:503

pin(type: "SHARE_AND_CAM" | "CAM" | "SHARE"): Promise<void>
- This method can be used to pin the agentParticipant’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
Returns Promise<void>
Throws
- Errors.ERROR_INVALID_PARAMETER — unknown pin type
- Errors.ERROR_ACTION_PERFORMED_BEFORE_MEETING_JOINED — called before meeting is joined
- Errors.ERROR_MEETING_RECONNECTING — meeting is reconnecting
- Errors.PIN_FAILED — server rejected the pin request
Example
```
let meeting;

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

const agentParticipant = Array.from(meeting.participants.values()).find(
  (p) => p.isAgent
);

try {
  await agentParticipant.pin("CAM");
} catch (err) {
  console.log("Error in pin", err);
}
```
Overrides Participant.pin
- Defined in agentParticipant.d.ts:126

remove

remove(): Promise<void>
- This method can be used to removes the remote agentParticipant from the meeting.
Returns Promise<void>
Throws
- Errors.ERROR_ACTION_PERFORMED_BEFORE_MEETING_JOINED — called before meeting is joined
- Errors.ERROR_MEETING_RECONNECTING — meeting is reconnecting
- Errors.ERROR_ACTION_NOT_SUPPORTED — participant id is missing
- Errors.REMOVE_PARTICIPANT_FAILED — server rejected the remove request
Example
```
let meeting;

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

const agentParticipant = Array.from(meeting.participants.values()).find(
  (p) => p.isAgent
);

try {
  await agentParticipant.remove();
} catch (err) {
  console.log("Error in remove", err);
}
```
Overrides Participant.remove
- Defined in agentParticipant.d.ts:93

renderAudio

renderAudio(options?: { type?: "audio" }): HTMLAudioElement
- This method creates and returns an HTMLAudioElement that can be used to play incoming audio streams in the DOM.
Parameters
- Optionaloptions: { type?: "audio" }
  - Optionaltype?: "audio"
    
    Type: `"audio"
    
    "audio" – Renders the agentParticipant's microphone audio stream.
Returns HTMLAudioElement
An HTMLAudioElement that plays the requested audio stream.
Example
```
const audioElement = agentParticipant.renderAudio({
  type: "audio",
});

document.body.appendChild(audioElement);
```
Overrides Participant.renderAudio
- Defined in agentParticipant.d.ts:256

renderVideo

renderVideo(
    options?: {
        containerStyle?: Partial<CSSStyleDeclaration>;
        maxQuality?: "low" | "med" | "high" | "auto";
        type?: "video";
        videostyle?: Partial<CSSStyleDeclaration>;
    },
): HTMLDivElement
- This method creates and returns a <div> element that internally manages the rendering of the agentParticipant’s video 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";
      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"
    
    Specifies which stream to render.
    
    Allowed value:
    
    "video" – Camera 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 = agentParticipant.renderVideo({
  type: "video",
  maxQuality: "high",
  videostyle: {
    objectFit: "cover",
    borderRadius: "8px",
  },
  containerStyle: {
    width: "300px",
    height: "200px",
  },
});

document.body.appendChild(videoElement);
```
Overrides Participant.renderVideo
- Defined in agentParticipant.d.ts:232

setQuality

setQuality(quality: "low" | "med" | "high"): Promise<void>
- This method can be used to set the incoming video quality of the remote participant.
Parameters
- quality: "low" | "med" | "high"
Returns Promise<void>
Throws
- Errors.ERROR_ACTION_NOT_SUPPORTED — called on the local participant, or no video stream available
- Errors.ERROR_ACTION_PERFORMED_BEFORE_MEETING_JOINED — called before meeting is joined
- Errors.ERROR_MEETING_RECONNECTING — meeting is reconnecting
- Errors.SET_QUALITY_FAILED — server rejected the request
Example
```
let meeting;

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

const participant = Array.from(meeting.participants.values())[0];
try {
  await participant.setQuality("low");
} catch (err) {
  console.log("Error in setQuality", err);
}
```
Inherited from Participant.setQuality
- Defined in participant.d.ts:255

setScreenShareQuality

setScreenShareQuality(quality: "low" | "med" | "high"): Promise<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 Promise<void>
Throws
- Errors.ERROR_ACTION_NOT_SUPPORTED — called on the local participant, or no screen-share stream available
- Errors.ERROR_ACTION_PERFORMED_BEFORE_MEETING_JOINED — called before meeting is joined
- Errors.ERROR_MEETING_RECONNECTING — meeting is reconnecting
- Errors.SET_QUALITY_FAILED — server rejected the request
Example
```
let meeting;

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

const participant = Array.from(meeting.participants.values())[0];
try {
  await participant.setScreenShareQuality("low");
} catch (err) {
  console.log("Error in setScreenShareQuality", err);
}
```
Inherited from Participant.setScreenShareQuality
- Defined in participant.d.ts:283

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);
```
Inherited from Participant.setViewPort
- Defined in participant.d.ts:307

stopConsumingMicStreams

stopConsumingMicStreams(): Promise<void>
- This method can be used to stop consuming the agentParticipant's microphone audio stream.
Returns Promise<void>
Throws
- Errors.ERROR_ACTION_PERFORMED_BEFORE_MEETING_JOINED — called before meeting is joined
- Errors.ERROR_MEETING_RECONNECTING — meeting is reconnecting
- Errors.STOP_CONSUMING_MIC_STREAMS_FAILED — server rejected the stop-consume request
Example
```
let meeting;

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

const agentParticipant = Array.from(meeting.participants.values()).find(
  (p) => p.isAgent
);

try {
  await agentParticipant.stopConsumingMicStreams();
} catch (err) {
  console.log("Error in stopConsumingMicStreams", err);
}
```
Overrides Participant.stopConsumingMicStreams
- Defined in agentParticipant.d.ts:464

stopConsumingWebcamStreams

stopConsumingWebcamStreams(): Promise<void>
- This method can be used to stop consuming the agentParticipant's webcam video stream.
Returns Promise<void>
Throws
- Errors.ERROR_ACTION_PERFORMED_BEFORE_MEETING_JOINED — called before meeting is joined
- Errors.ERROR_MEETING_RECONNECTING — meeting is reconnecting
- Errors.STOP_CONSUMING_WEBCAM_STREAMS_FAILED — server rejected the stop-consume request
Example
```
let meeting;

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

const agentParticipant = Array.from(meeting.participants.values()).find(
  (p) => p.isAgent
);

try {
  await agentParticipant.stopConsumingWebcamStreams();
} catch (err) {
  console.log("Error in stopConsumingWebcamStreams", err);
}
```
Overrides Participant.stopConsumingWebcamStreams
- Defined in agentParticipant.d.ts:494

unpin

unpin(type: "SHARE_AND_CAM" | "CAM" | "SHARE"): Promise<void>
- This method can be used to unpin the agentParticipant’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"
Returns Promise<void>
Throws
- Errors.ERROR_INVALID_PARAMETER — unknown unpin type
- Errors.ERROR_ACTION_PERFORMED_BEFORE_MEETING_JOINED — called before meeting is joined
- Errors.ERROR_MEETING_RECONNECTING — meeting is reconnecting
- Errors.UNPIN_FAILED — server rejected the unpin request
Example
```
let meeting;

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

const agentParticipant = Array.from(meeting.participants.values()).find(
  (p) => p.isAgent
);

try {
  await agentParticipant.unpin("CAM");
} catch (err) {
  console.log("Error in unpin", err);
}
```
Overrides Participant.unpin
- Defined in agentParticipant.d.ts:170

Class AgentParticipant

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns AgentParticipant

Properties

agentId

ReadonlyagentState

displayName

id

isAgent

local

metaData

micOn

mode

pinState

quality

screenShareAudioOn

screenShareOn

screenShareQuality

streams

webcamOn

Methods

captureImage

Parameters

Optionalheight?: number

Optionalwidth?: number

Returns Promise<string>

Throws

Example

consumeMicStreams

Returns Promise<void>

Throws

Example

consumeWebcamStreams

Returns Promise<void>

Throws

Example

disableMic

Returns Promise<void>

Throws

Example

disableWebcam

Returns Promise<void>

Throws

Example

enableMic

Returns Promise<void>

Throws

Example

enableWebcam

Returns Promise<void>

Throws

Example

getAudioStats

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

Example

getShareAudioStats

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

Example

getShareStats

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; }[],>

Example

getTransportStats

Returns Promise< { receive: { incomingBitrate: number; totalReceivedBytes: number }; send: { outgoingBitrate: number; totalSentBytes: number }; },>

Example

getVideoStats

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; }[],>

Example

off

Parameters

Returns void

on

Parameters

Returns void

pin

`Readonly`agentState

`Optional`height?: number

`Optional`width?: number

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

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

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;
}[],
>

Returns Promise<
{
receive: { incomingBitrate: number; totalReceivedBytes: number };
send: { outgoingBitrate: number; totalSentBytes: number };
},
>

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;
}[],
>

`Optional`type?: "audio"

`Optional`containerStyle?: Partial<CSSStyleDeclaration>

`Optional`maxQuality?: "low" | "med" | "high" | "auto"

`Optional`type?: "video"

`Optional`videostyle?: Partial<CSSStyleDeclaration>