core/com.cloudflare.realtimekit.participants/RtkRemoteParticipant

RtkRemoteParticipant

class RtkRemoteParticipant : RtkMeetingParticipant

Properties

Link copied to clipboard
open override val audioEnabled: Boolean

A boolean value indicating if the audio currently enabled.

Link copied to clipboard
open val customParticipantId: String?

Identifier provided while adding the participant.

Link copied to clipboard
Link copied to clipboard
open val id: String

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

Link copied to clipboard
open val isHost: Boolean
Link copied to clipboard
open override val isPinned: Boolean
Link copied to clipboard
open val name: String

The participant's name

Link copied to clipboard
open val picture: String?

The participant's picture (if any).

Link copied to clipboard
open val presetName: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
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

Link copied to clipboard
open override val videoEnabled: Boolean

A boolean value indicating if the video currently enabled.

Functions

Link copied to clipboard
Link copied to clipboard
fun disableAudio(): HostError?

Disables the audio of the participant if it is enabled

Link copied to clipboard
fun disableVideo(): HostError?

Disables the video of the participant if it is enabled

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun kick(): HostError?

Removes the participant from the meeting

Link copied to clipboard
open fun pin(): HostError?

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open fun toMap(): Map<String, Any?>
Link copied to clipboard
open fun unpin(): HostError.PinPermissionDenied?

Unpins the participant