sdk-conference/com.pexip.sdk.conference/Participant

Participant

data class Participant(val id: ParticipantId, val role: Role, val serviceType: ServiceType, val startTime: Instant?, val buzzTime: Instant?, val spotlightTime: Instant?, val displayName: String, val overlayText: String, val me: Boolean = false, val speaking: Boolean = false, val audioMuted: Boolean = false, val videoMuted: Boolean = false, val presenting: Boolean = false, val muteSupported: Boolean = false, val transferSupported: Boolean = false, val disconnectSupported: Boolean = false, val callTag: String = "", val clientAudioMuted: Boolean = audioMuted)

A conference participant.

Constructors

constructor(id: ParticipantId, role: Role, serviceType: ServiceType, startTime: Instant?, buzzTime: Instant?, spotlightTime: Instant?, displayName: String, overlayText: String, me: Boolean = false, speaking: Boolean = false, audioMuted: Boolean = false, videoMuted: Boolean = false, presenting: Boolean = false, muteSupported: Boolean = false, transferSupported: Boolean = false, disconnectSupported: Boolean = false, callTag: String = "", clientAudioMuted: Boolean = audioMuted)

Properties

val audioMuted: Boolean = false

whether this participant has their audio muted

val buzzTime: Instant?

a UNIX timestamp representing the moment in time when this participant raised their hand, or null if their hand is not currently raised

val callTag: String

a call tag set on this participant

clientAudioMuted

val clientAudioMuted: Boolean

whether this participant has their device audio muted

disconnectSupported

val disconnectSupported: Boolean = false

whether this participant can be disconnected

val displayName: String

a display name of this participant

val id: ParticipantId

an unique ID of this participant

val me: Boolean = false

whether this participant is you

val muteSupported: Boolean = false

whether this participant can be muted

val overlayText: String

an overlay text that is shown on top of this participant's remote video

val presenting: Boolean = false

whether this participant is currently presenting

a role of this participant

val serviceType: ServiceType

a service type of this participant

val speaking: Boolean = false

val spotlightTime: Instant?

a UNIX timestamp representing the moment in time when this participant was spotlit, or null if they're currently not spotlit

val startTime: Instant?

a UNIX timestamp representing the moment in time when this participant joined the conference, or null

transferSupported

val transferSupported: Boolean = false

whether this participant can be transferred to a different conference

val videoMuted: Boolean = false

whether this participant has their video muted