Participant Class Properties - Android

note

These are Kotlin properties. Read them with property syntax, for example participant.displayName. A getter call such as participant.getDisplayName() does not compile.

id

• type: String

• id is the unique ID of the participant who has joined the room. It is also the participant's key in room.participants.

• For the local participant, the ID is final once onRoomJoined fires. Until then, it is the participantId passed to createRoom(), or empty.

---

displayName

• type: String

• displayName is the name of the participant who has joined the room.

---

videoQuality

• type: VideoQuality

• videoQuality is the video quality this device last requested for the participant with setQuality(): VideoQuality.HIGH, VideoQuality.MEDIUM or VideoQuality.LOW. It starts as VideoQuality.HIGH.

• It is a request, not a measurement. The participant's video can still arrive at a lower quality when bandwidth is short. It does not follow setScreenShareQuality().

---

isLocal

• type: Boolean

• isLocal is true if the participant is the local participant, false otherwise.

---

streams

• type: Map<String, RTCStream>

• streams holds the participant's current streams, keyed by stream ID. A stream's kind is MediaType.AUDIO, MediaType.VIDEO, MediaType.SHARE or MediaType.SHARE_AUDIO.

• For a remote participant, it holds only the streams this device receives.

• It is a live view that changes as streams start and stop. Copy it before you iterate over it off the main thread, or follow the stream events of ParticipantEventListener instead.

---

mode

• type: Mode

• mode is the mode of the participant: Mode.SEND_AND_RECV, Mode.RECV_ONLY or Mode.SIGNALLING_ONLY.

• It is updated when onParticipantModeChanged fires for the participant.

---

pinState

• type: ParticipantPinState

• pinState tells which of the participant's streams are pinned for everyone in the room. pinState.cam is true while the camera is pinned, and pinState.share is true while the screen share is pinned. Both false means not pinned.

• It is updated just before onPinStateChanged fires for the participant. Until then, both values are false.

• Change it with pin() and unpin().

---

metaData

• type: JSONObject?

• metaData is the additional information that was passed as metaData to createRoom(), or null if none was passed. It does not change during the session.