core/com.cloudflare.realtimekit.participants/RtkRemoteParticipant

RtkRemoteParticipant

class RtkRemoteParticipant : RtkMeetingParticipant

Properties

audioEnabled

open override val audioEnabled: Boolean

A boolean value indicating if the audio currently enabled.

customParticipantId

open val customParticipantId: String?

Identifier provided while adding the participant.

flags

open val flags: ParticipantFlags

open val id: String

The ID of the participant, this ID is temporary changes every time the participant rejoins the meeting

isHost

open val isHost: Boolean

isPinned

open override val isPinned: Boolean

name

open val name: String

The participant's name

picture

open val picture: String?

The participant's picture (if any).

presetName

open val presetName: String

screenShareEnabled

val screenShareEnabled: Boolean

stageStatus

val stageStatus: StageStatus

userId

open val userId: String

The userId of the participant, this ID is tied to customParticipantId and does not change for a user in a meeting

videoEnabled

open override val videoEnabled: Boolean

A boolean value indicating if the video currently enabled.

Functions

addParticipantUpdateListener

fun addParticipantUpdateListener(participantUpdateListener: RtkParticipantUpdateListener)

disableAudio

fun disableAudio(): HostError?

Disables the audio of the participant if it is enabled

disableVideo

fun disableVideo(): HostError?

Disables the video of the participant if it is enabled

getScreenShareVideoView

fun getScreenShareVideoView(): VideoView?

Get the VideoView instance that renders the screen share video for this user. Returns null when no screen share is currently active.

getVideoView

fun getVideoView(): VideoView?

Get the VideoView instance that renders the camera video for this user. Returns null when the participant does not have their video enabled.

kick

fun kick(): HostError?

Removes the participant from the meeting

open fun pin(): HostError?

Pins the participant, so the participant is always in the active list

removeParticipantUpdateListener

fun removeParticipantUpdateListener(participantUpdateListener: RtkParticipantUpdateListener)

removeParticipantUpdateListeners

fun removeParticipantUpdateListeners()

toMap

open fun toMap(): Map<String, Any?>

unpin

open fun unpin(): HostError.PinPermissionDenied?

Unpins the participant