data class Layout(val layout: LayoutId, val layouts: Set<LayoutId>, val requestedPrimaryScreenHostLayout: LayoutId?, val requestedPrimaryScreenGuestLayout: LayoutId?, val overlayTextEnabled: Boolean, val layoutSvgs: Map<LayoutId, String>)

The layout of this Conference.

LayoutId

@JvmInline

value class LayoutId(val value: String)

A unique identifier for a layout in a conference.

LockException

class LockException @JvmOverloads constructor(cause: Throwable? = null) : RuntimeException

Thrown to indicate that locking the conference failed.

LowerAllHandsException

class LowerAllHandsException @JvmOverloads constructor(cause: Throwable? = null) : RuntimeException

Thrown to indicate that lowering all hands failed.

LowerHandException

class LowerHandException @JvmOverloads constructor(cause: Throwable? = null) : RuntimeException

Thrown to indicate that lowering hand failed.

MakeGuestException

class MakeGuestException @JvmOverloads constructor(cause: Throwable? = null) : RuntimeException

Thrown to indicate that changing role to guest failed.

MakeHostException

class MakeHostException @JvmOverloads constructor(cause: Throwable? = null) : RuntimeException

Thrown to indicate that changing role to host failed.

Message

data class Message(val at: Long, val participantId: UUID, val participantName: String, val type: String, val payload: String, val direct: Boolean)

A message that can be received from Messenger.

MessageListener

fun interface MessageListener

MessageNotSentException

class MessageNotSentException @JvmOverloads constructor(val msg: Message, cause: Throwable? = null) : RuntimeException

Thrown to indicate that the msg was not sent.

Messenger

interface Messenger

Handles sending and receiving messages.

MuteAllGuestsException

class MuteAllGuestsException @JvmOverloads constructor(cause: Throwable? = null) : RuntimeException

Thrown to indicate that muting all guests failed.

MuteException

class MuteException @JvmOverloads constructor(cause: Throwable? = null) : RuntimeException

Thrown to indicate that mute failed.

Participant

data class Participant(val id: UUID, 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)

A conference participant.

PresentationStartConferenceEvent

data class ~~PresentationStartConferenceEvent~~(val at: Long, val presenterId: UUID, val presenterName: String) : ConferenceEvent

PresentationStopConferenceEvent

data class ~~PresentationStopConferenceEvent~~(val at: Long) : ConferenceEvent

RaiseHandException

class RaiseHandException @JvmOverloads constructor(cause: Throwable? = null) : RuntimeException

Thrown to indicate that raising hand failed.

ReferConferenceEvent

data class ReferConferenceEvent(val at: Long, val conferenceAlias: String, val token: String) : ConferenceEvent

Referer

interface Referer

Handles call transfer.

ReferException

class ReferException @JvmOverloads constructor(cause: Throwable? = null) : RuntimeException

Thrown to indicate that call transfer has failed.

Role

enum Role : Enum<Role>

A conference role that affects privileges that a Participant has

Roster

interface Roster

Handles conference participants.

SendCallback

interface SendCallback

ServiceType

enum ServiceType : Enum<ServiceType>

A service type.

SplashScreen

data class SplashScreen(val key: String, val elements: List<Element>, val backgroundUrl: String)

A splash screen that should be rendered to the user whenever available.

SpotlightException

class SpotlightException @JvmOverloads constructor(cause: Throwable? = null) : RuntimeException

Thrown to indicate that enabling the spotlight failed.

Theme

interface Theme

Handles theme-related functionality of the Conference.

TransformLayoutException

class TransformLayoutException @JvmOverloads constructor(cause: Throwable? = null) : RuntimeException

Thrown to indicate that layout transformation has failed.

UnlockException

class UnlockException @JvmOverloads constructor(cause: Throwable? = null) : RuntimeException

Thrown to indicate that unlocking the conference failed.

UnmuteAllGuestsException

class UnmuteAllGuestsException @JvmOverloads constructor(cause: Throwable? = null) : RuntimeException

Thrown to indicate that unmuting all guests failed.

UnmuteException

class UnmuteException @JvmOverloads constructor(cause: Throwable? = null) : RuntimeException

Thrown to indicate that unmute failed.

UnspotlightException

class UnspotlightException @JvmOverloads constructor(cause: Throwable? = null) : RuntimeException

Thrown to indicate that disabling the spotlight failed.