Participant
Last updated
Last updated
Name
Description
participantId
Unique identifier of a participant
participantName
Name of participant
isLocal
Identifies whether the participant is a local one
stream
Participant Media Stream - Read here for more information
streamConstraints
An object with two fields: {audio: boolean, video: boolean}
Example: {audio: false, video: true}. - that means a stream of participant consists only of video tracks
settings
An object with two fields: {mutedAudio: boolean, mutedVideo: boolean} - Those fields contain the state of the Audio and Video of the participant
Name
Description
Parameters
enableAudio()
disableAudio()
enableVideo()
disableVideo()
isAudioEnabled()
Return boolean state of the local audio
isVideoEnabled()
Return boolean state of the local video
startScreenSharing(callback: Function)
The callback function will be invoked when screen sharing is started
stopScreenSharing(callback: Function)
The callback function will be invoked when screen sharing is stopped
toggleRemoteAudio(participantId: String)
Toggle remote participantId audio
toggleRemoteVideo(participantId: String)
Toggle remote participantId video
isRemoteAudioEnabled(participantId: String)
isRemoteVideoEnabled(participantId: String)
setMediaQuality ({videoHeight: Number, videoWidth: Number, frameRate: Number})
Apply constraints to video resolution and frame rate
publishRemoteParticipant(participantId)
Allow the remote participant to publish into the session
disconnectRemoteParticipant(participantId, message)
Disconnect the remote participant from the session
participantId - id of participant who will be disconnected from a session
message - optional parameter to provide a reason of kick action