core/com.cloudflare.realtimekit.self/RtkSelfParticipant

RtkSelfParticipant

class RtkSelfParticipant : 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.

designToken

val designToken: RtkDesignToken

flags

open val flags: ParticipantFlags

open override val id: String

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

isCameraPermissionGranted

val isCameraPermissionGranted: Boolean

isHost

open val isHost: Boolean

isMicrophonePermissionGranted

val isMicrophonePermissionGranted: Boolean

isPinned

open override val isPinned: Boolean

name

open override var name: String

The participant's name

permissions

val permissions: SelfPermissions

picture

open val picture: String?

The participant's picture (if any).

presetInfo

val presetInfo: PresetInfo

presetName

open val presetName: String

roomJoined

val roomJoined: Boolean

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.

waitListStatus

val waitListStatus: WaitListStatus

Functions

addParticipantUpdateListener

fun addParticipantUpdateListener(participantUpdateListener: RtkParticipantUpdateListener)

canDoParticipantHostControls

fun canDoParticipantHostControls(): Boolean

canEnableScreenShare

fun canEnableScreenShare(): Boolean

canJoinStage

fun canJoinStage(): Boolean

canRequestToJoinStage

fun canRequestToJoinStage(): Boolean

disableAudio

fun disableAudio(onResult: (AudioError?) -> Unit)

disableScreenShare

fun disableScreenShare()

This participant is used to disable the local participant's screenshare.

disableVideo

fun disableVideo(onResult: (VideoError?) -> Unit)

enableAudio

fun enableAudio(onResult: (AudioError?) -> Unit)

enableScreenShare

fun enableScreenShare(): ScreenShareError?

This method starts capturing the screen and shares it to the remote participants

enableVideo

fun enableVideo(onResult: (VideoError?) -> Unit)

This method is used to start streaming the local participant's video to the meeting.

getAudioDevices

fun getAudioDevices(): List<AudioDevice>

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.

getSelectedAudioDevice

fun getSelectedAudioDevice(): AudioDevice?

getSelectedVideoDevice

fun getSelectedVideoDevice(): VideoDevice?

getSelfPreview

fun getSelfPreview(): VideoView?

getVideoDevices

fun getVideoDevices(): List<VideoDevice>

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.

open fun pin(): HostError?

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

removeParticipantUpdateListener

fun removeParticipantUpdateListener(participantUpdateListener: RtkParticipantUpdateListener)

removeParticipantUpdateListeners

fun removeParticipantUpdateListeners()

setAudioDevice

fun setAudioDevice(rtkAudioDevice: AudioDevice)

setDisplayName

fun setDisplayName(name: String)

setVideoDevice

fun setVideoDevice(rtkVideoDevice: VideoDevice)

shouldJoinMediaRoom

fun shouldJoinMediaRoom(): Boolean

shouldShowSetupScreen

fun shouldShowSetupScreen(): Boolean

switchCamera

fun switchCamera()

toMap

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

unpin

open fun unpin(): HostError.PinPermissionDenied?

Unpins the participant