Methods returned by useParticipant Hook - React

enableMic()

• enableMic() is used to enable mic of participant.

Events associated with enableMic():

• First the participant will get a callback on onMicRequested() and once the participant accepts the request, mic will be enabled.

• Every Participant will receive a callback on onStreamEnabled() of the useParticipant() hook with Stream object.

---

disableMic()

• disableMic() is used to disable mic of participant.

Events associated with disableMic():

• Every Participant will receive a callback on onStreamDisabled() of the useParticipant() hook with Stream object.

---

enableWebcam()

• enableWebcam() is used to enable webcam of participant.

Events associated with enableWebcam():

• First the participant will get a callback on onWebcamRequested() and once the participant accepts the request, webcam will be enabled.

• Every Participant will receive a callback on onStreamEnabled() of the useParticipant() hook with Stream object.

---

disableWebcam()

• disableWebcam() is used to disable webcam of participant.

Events associated with disableWebcam():

• Every Participant will receive a callback on onStreamDisabled() of the useParticipant() hook with Stream object.

---

pin()

• It is used to set pin state of the participant. You can use it to pin the screen share, camera or both of the participant. It accepts a optional paramter of type String. Default SHARE_AND_CAM

Parameters

• pinType: SHARE_AND_CAM | CAM | SHARE

---

unpin()

• It is used to unpin participant. You can use it to unpin the screen share, camera or both of the participant. It accepts a optional paramter of type String. Default is SHARE_AND_CAM

Parameters

• pinType: SHARE_AND_CAM | CAM | SHARE

---

remove()

• It is used to remove a participant from the meeting

---

setQuality()

• setQuality() is used to set the quality of participants video.

Parameter

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

---

captureImage()

• It is used to capture image of local participant's current videoStream.

• It will return image in a form of base64.

Parameters

• height: number
• width: number

---

getVideoStats()

• getVideoStats() will return an object which will contain details regarding the participant's critical video metrics such as Jitter, Packet Loss, Quality Score etc.

Returns

• object
  • jitter : It represents the distortion in the stream.
  • bitrate : It represents the bitrate of the stream which is being transmitted.
  • totalPackets : It represents the total packet count which were transmitted for that particiular stream.
  • packetsLost : It represents the total packets lost during the transimission of the stream.
  • rtt : It represents the time between the stream being reached to client from the server in milliseconds(ms).
  • codec: It represents the codec used for the stream.
  • network: It represents the network used to transmit the stream
  • size: It is object containing the height, width and frame rate of the stream.

note

getVideoStats() will return the metrics for the participant at that given point of time and not average data of the complete meeting.

To view the metrics for the complete meeting using the stats API documented here.

info

If you are getting rtt greater than 300ms, try using a different region which is nearest to your user. To know more about changing region visit here.

---

getAudioStats()

• getAudioStats() will return an object which will contain details regarding the participant's critical audio metrics such as Jitter, Packet Loss, Quality Score etc.

Returns

• object
  • jitter : It represents the distortion in the stream.
  • bitrate : It represents the bitrate of the stream which is being transmitted.
  • totalPackets : It represents the total packet count which were transmitted for that particiular stream.
  • packetsLost : It represents the total packets lost during the transimission of the stream.
  • rtt : It represents the time between the stream being reached to client from the server in milliseconds(ms).
  • codec: It represents the codec used for the stream.
  • network: It represents the network used to transmit the stream

note

getAudioStats() will return the metrics for the participant at that given point of time and not average data of the complete meeting.

To view the metrics for the complete meeting using the stats API documented here.

info

If you are getting rtt greater than 300ms, try using a different region which is nearest to your user. To know more about changing region visit here.

getShareStats()

• getShareStats() will return an object which will contain details regarding the participant's critical video metrics such as Jitter, Packet Loss, Quality Score etc.

Returns

• object
  • jitter : It represents the distortion in the stream.
  • bitrate : It represents the bitrate of the stream which is being transmitted.
  • totalPackets : It represents the total packet count which were transmitted for that particiular stream.
  • packetsLost : It represents the total packets lost during the transimission of the stream.
  • rtt : It represents the time between the stream being reached to client from the server in milliseconds(ms).
  • codec: It represents the codec used for the stream.
  • network: It represents the network used to transmit the stream
  • size: It is object containing the height, width and frame rate of the stream.

note

getShareStats() will return the metrics for the participant at that given point of time and not average data of the complete meeting.

To view the metrics for the complete meeting using the stats API documented here.

info

If you are getting rtt greater than 300ms, try using a different region which is nearest to your user. To know more about changing region visit here.

---

getShareAudioStats()

• getShareAudioStats() will return an object which will contain details regarding the participant's critical screen share audio metrics such as Jitter, Packet Loss, Quality Score etc.

Returns

• object
  • jitter : It represents the distortion in the stream.
  • bitrate : It represents the bitrate of the stream which is being transmitted.
  • totalPackets : It represents the total packet count which were transmitted for that particiular stream.
  • packetsLost : It represents the total packets lost during the transimission of the stream.
  • rtt : It represents the time between the stream being reached to client from the server in milliseconds(ms).
  • codec: It represents the codec used for the stream.
  • network: It represents the network used to transmit the stream

note

getShareAudioStats() will return the metrics for the participant at that given point of time and not average data of the complete meeting.

To view the metrics for the complete meeting using the stats API documented here.

info

If you are getting rtt greater than 300ms, try using a different region which is nearest to your user. To know more about changing region visit here.