sdk-conference/com.pexip.sdk.conference/Roster

Roster

interface Roster

Handles conference participants.

Properties

Link copied to clipboard
open val allGuestsMuted: StateFlow<Boolean>

A StateFlow that represents whether guests in the conference all muted.

Link copied to clipboard
open val guestsCanUnmute: StateFlow<Boolean?>

A StateFlow that represents whether guests in the conference can unmute themselves, or null.

Link copied to clipboard
open val locked: StateFlow<Boolean>

A StateFlow that represents whether the conference is locked.

Link copied to clipboard
open val me: StateFlow<Participant?>

A StateFlow that represents you as the participant of this conference.

Link copied to clipboard
open val participants: StateFlow<List<Participant>>

A StateFlow that represents participants of this conference.

Link copied to clipboard
open val presenter: StateFlow<Participant?>

A StateFlow that represents the participant that is currently sharing a presentation.

Functions

Link copied to clipboard
open suspend fun admit(participantId: ParticipantId)

Lets a specified participant into the conference from the waiting room of a locked conference.

Link copied to clipboard
open suspend fun allowGuestsToUnmute()

Allows guests to unmute themselves.

Link copied to clipboard
open suspend fun clientMute()

Signals that the local microphone has been muted.

Link copied to clipboard
open suspend fun clientUnmute()

Signals that the local microphone has been unmuted.

Link copied to clipboard
open suspend fun disallowGuestsToUnmute()

Disallows guests to unmute themselves.

Link copied to clipboard
open suspend fun disconnect(participantId: ParticipantId? = null)

Disconnects the specified participant or self.

Link copied to clipboard
open suspend fun disconnectAll()

Disconnects all conference participants.

Link copied to clipboard
open suspend fun lock()

Locks the conference.

Link copied to clipboard
open suspend fun lowerAllHands()

Lowers all hands.

Link copied to clipboard
open suspend fun lowerHand(participantId: ParticipantId? = null)

Lowers hand of the specified participant or self.

Link copied to clipboard
open suspend fun makeGuest(participantId: ParticipantId? = null)

Changes the role of the participant to guest.

Link copied to clipboard
open suspend fun makeHost(participantId: ParticipantId? = null)

Changes the role of the participant to host.

Link copied to clipboard
open suspend fun mute(participantId: ParticipantId? = null)

Mutes the specified participant or self.

Link copied to clipboard
open suspend fun muteAllGuests()

Mutes all guests in a conference.

Link copied to clipboard
open suspend fun muteVideo(participantId: ParticipantId? = null)

Mutes the video of the specified participant or self.

Link copied to clipboard
open suspend fun raiseHand(participantId: ParticipantId? = null)

Raises hand of the specified participant or self.

Link copied to clipboard
open suspend fun spotlight(participantId: ParticipantId? = null)

Enables the "spotlight" on a participant or self.

Link copied to clipboard
open suspend fun unlock()

Unlocks the conference.

Link copied to clipboard
open suspend fun unmute(participantId: ParticipantId? = null)

Unmutes the specified participant or self.

Link copied to clipboard
open suspend fun unmuteAllGuests()

Unmutes all guests in a conference.

Link copied to clipboard
open suspend fun unmuteVideo(participantId: ParticipantId? = null)

Unmutes the video of the specified participant or self.

Link copied to clipboard
open suspend fun unspotlight(participantId: ParticipantId? = null)

Disables the "spotlight" on a participant or self.