Skip to main content
Version: 0.1.x

Participant Class Methods - Android

enableWebcam()​

  • enableWebcam() is used to enable participant's camera.

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 streamEnabled event of ParticipantEventListener Class with stream object.

Returns​

  • void

disableWebcam()​

  • disableWebcam() is used to disable participant camera.

Events associated with disableWebcam() :​

  • Every Participant will receive a streamDisabled event of ParticipantEventListener Class with stream object.

Returns​

  • void

enableMic()​

  • enableMic() is used to enable participant microphone.

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 streamEnabled event of ParticipantEventListener Class with stream object.

Returns​

  • void

disableMic()​

  • disableMic() is used to disable participant microphone.

Events associated with disableMic():​

  • Every Participant will receive a streamDisabled event of ParticipantEventListener Class with stream object.

Returns​

  • void

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 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 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 the participant's video stream.

Parameters​

  • quality: low | med | high

Returns​

  • void

setViewPort()​

  • setViewPort() is used to set the quality of the participant's video stream based on the viewport height and width.

Parameters​

  • width: int
  • height: int

Returns​

  • void
info

MultiStream is not supported by the Android SDK. Use customTrack rather than setQuality() and setViewPort() if you want to change participant's quality who joined using our Android SDK.

To know more about customTrack visit here

remove()​

  • remove() is used to remove the participant from the meeting.

Events associated with remove() :​

Returns​

  • void

captureImage()​

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

  • You need to pass an implementation of TaskCompletionListener as a parameter. This listener will handle the result of the image capture task.

  • When the image capture task is complete, the onComplete() method will provide the image in the form of a base64 string. If an error occurs, the onError() method will provide the error details.

Parameters​

  • height: int
  • width: int
  • listener: TaskCompletionListener

Returns​

  • void

getVideoStats()​

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

Returns​

  • JSONObject
    • 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.

If you are getting high packet loss, try using the customTrack for better experience. To know more about customTrack visit here

getAudioStats()​

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

Returns​

  • JSONObject
    • 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 JSONObject which will contain details regarding the participant's critical video metrics such as Jitter, Packet Loss, Quality Score etc.

Returns​

  • JSONObject
    • 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.

addEventListener()​

Parameters​

  • listener: ParticipantEventListener

Returns​

  • void

removeEventListener()​

Parameters​

  • listener: ParticipantEventListener

Returns​

  • void

removeAllListeners()​

Returns​

  • void

Got a Question? Ask us on discord

Last updated on by ahmedbhesaniya97

Was this helpful?