zn-android-sdk/live.videosdk.rtc.android/Participant

Participant

Represents a participant in a Meeting.

A Participant can be either a local participant (the current user) or a remote participant. Each participant has an id, display name, mode, and a set of media Streams (audio, video, screen-share).

Use addEventListener to listen for stream and state-change events on this participant.

Obtaining a Participant:

Local participant: getLocalParticipant
Remote participants: getParticipants or onParticipantJoined

Code Example:


// Listen for stream events on a remote participant
participant.addEventListener(object : ParticipantEventListener() {
    override fun onStreamEnabled(stream: Stream) {
        if (stream.kind.equals("video", ignoreCase = true)) {
            // Attach video track to a VideoView
        }
    }

    override fun onStreamDisabled(stream: Stream) {
        if (stream.kind.equals("video", ignoreCase = true)) {
            // Detach video track
        }
    }
})

Properties

displayName

val displayName: String

The display name of this participant, set when joining the meeting.

val id: String

The unique identifier of this participant, assigned by the server.

isLocal

val isLocal: Boolean

Whether this participant is the local participant (current user).

metaData

val metaData: JSONObject

Custom metadata associated with this participant as a JSON object.

mode

var mode: String

The current mode of this participant (e.g.

quality

var quality: String

The current video quality setting for this participant ("high", "med", or "low").

streams

val streams: Map<String, Stream>

A map of all active media streams for this participant, keyed by stream ID.

Functions

addEventListener

fun addEventListener(listener: ParticipantEventListener)

This method can be used to register a ParticipantEventListener on this participant to receive callbacks for stream and state-change events.

captureImage

fun captureImage(listener: TaskCompletionListener<String, String>)

fun captureImage(height: Int, width: Int, listener: TaskCompletionListener<String, String>)

This method can be used to capture a snapshot image from the local participant's webcam.

disableMic

fun disableMic()

This method can be used to request a remote participant to disable their microphone.

disableWebcam

fun disableWebcam()

This method can be used to request a remote participant to disable their webcam.

enableMic

fun enableMic()

This method can be used to request a remote participant to enable their microphone.

enableWebcam

fun enableWebcam()

This method can be used to request a remote participant to enable their webcam.

getAudioStats

@Async

fun getAudioStats(): JSONObject

This method can be used to get the audio statistics for this participant.

getShareStats

@Async

fun getShareStats(): JSONObject

This method can be used to get the screen-share statistics for this participant.

getVideoStats

@Async

fun getVideoStats(): JSONArray

This method can be used to get the video statistics for this participant.

@Async

fun pin(type: String)

This method can be used to pin this participant's camera and/or screen-share stream.

remove

fun remove()

This method can be used to remove a remote participant from the meeting.

removeAllListeners

fun removeAllListeners()

This method can be used to remove all registered ParticipantEventListeners from this participant.

removeEventListener

fun removeEventListener(listener: ParticipantEventListener)

This method can be used to unregister a previously added ParticipantEventListener.

setViewPort

fun setViewPort(width: Int, height: Int)

This method can be used to set the viewport dimensions for adaptive video quality.

unpin

@Async

fun unpin(type: String)

This method can be used to unpin this participant's camera and/or screen-share stream.

Participant

See also

Properties

Functions