data class ConferenceUpdateEvent(val locked: Boolean = false, val started: Boolean = false, val guestsMuted: Boolean = false, val presentationAllowed: Boolean = false, val guestsCanUnmute: Boolean? = null) : InfinityEvent

DataChannelMessage

@Serializable

sealed interface DataChannelMessage

DisconnectEvent

@Serializable

@SerialName(value = "disconnect")

data class DisconnectEvent(val reason: String) : InfinityEvent

DtmfRequest

@Serializable

data class DtmfRequest(val digits: String)

ElementResponse

@Serializable

sealed interface ElementResponse

FeccAction

@Serializable

enum FeccAction : Enum<FeccAction>

FeccEvent

@Serializable

@SerialName(value = "fecc")

data class FeccEvent(val action: FeccAction = FeccAction.UNKNOWN, val timeout: Duration, val movement: List<FeccMovement>) : InfinityEvent

FeccMovement

@Serializable(with = FeccMovementSerializer::class)

enum FeccMovement : Enum<FeccMovement>

IdentityProvider

@Serializable

data class IdentityProvider(val id: IdentityProviderId, val name: String)

A SAML identity provider used for authentication.

IdentityProviderId

@Serializable

@JvmInline

value class IdentityProviderId(value: String)

IllegalLayoutTransformException

class IllegalLayoutTransformException @JvmOverloads constructor(message: String? = null) : RuntimeException

Thrown to indicate that the requested layout transformation is unsupported.

IncomingCancelledEvent

@Serializable

@SerialName(value = "incoming_cancelled")

data class IncomingCancelledEvent(val token: String) : InfinityEvent

IncomingEvent

@Serializable

@SerialName(value = "incoming")

data class IncomingEvent(val conferenceAlias: String, val remoteDisplayName: String, val token: String) : InfinityEvent

InfinityEvent

@Serializable

sealed interface InfinityEvent : Event

InfinityService

interface InfinityService

A fluent client for Infinity REST API v2.

InvalidPinException

class InvalidPinException @JvmOverloads constructor(message: String? = null) : RuntimeException

Thrown to indicate that the provided PIN was invalid.

InvalidTokenException

class InvalidTokenException @JvmOverloads constructor(message: String? = null) : RuntimeException

Thrown to indicate that the provided token was invalid.

LayoutEvent

@Serializable

@SerialName(value = "layout")

data class LayoutEvent(val layout: LayoutId, val requestedLayout: RequestedLayout? = null, val overlayTextEnabled: Boolean = false) : InfinityEvent

LayoutId

typealias ~~LayoutId~~ = com.pexip.sdk.infinity.LayoutId

MessageReceivedEvent

@Serializable

@SerialName(value = "message_received")

data class MessageReceivedEvent(val participantName: String, val participantId: ParticipantId, val type: String, val payload: String, val direct: Boolean = false) : InfinityEvent

MessageRequest

@Serializable

data class MessageRequest(val payload: String, val type: String)

Represents a message request to an Infinity conference or participant.

NewCandidateEvent

@Serializable

@SerialName(value = "new_candidate")

data class NewCandidateEvent(val candidate: String, val mid: String, val ufrag: String = "", val pwd: String = "") : InfinityEvent

NewCandidateRequest

@Serializable

data class NewCandidateRequest(val candidate: String, val mid: String, val ufrag: String? = null, val pwd: String? = null)

NewOfferEvent

@Serializable

@SerialName(value = "new_offer")

data class NewOfferEvent(val sdp: String) : InfinityEvent

NodeResolver

fun interface ~~NodeResolver~~

A class that can resolve node addresses.

NoSuchConferenceException

class NoSuchConferenceException @JvmOverloads constructor(message: String? = null) : RuntimeException

Thrown to indicate that the conference alias does not exist on the node.

NoSuchNodeException

class NoSuchNodeException : RuntimeException

Thrown to indicate that the node address used to make calls doesn't have Pexip Infinity deployment.

NoSuchRegistrationException

class NoSuchRegistrationException @JvmOverloads constructor(message: String? = null) : RuntimeException

Thrown to indicate that the device alias either does not exist on the node or credentials are invalid.

OfferResponse

sealed interface OfferResponse

ParticipantCreateEvent

@JvmInline

@Serializable

@SerialName(value = "participant_create")

value class ParticipantCreateEvent(val response: ParticipantResponse) : InfinityEvent

ParticipantDeleteEvent

@Serializable

@SerialName(value = "participant_delete")

data class ParticipantDeleteEvent(val id: ParticipantId) : InfinityEvent

ParticipantResponse

@Serializable

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

ParticipantSyncBeginEvent

@Serializable

@SerialName(value = "participant_sync_begin")

data object ParticipantSyncBeginEvent : InfinityEvent

ParticipantSyncEndEvent

@Serializable

@SerialName(value = "participant_sync_end")

data object ParticipantSyncEndEvent : InfinityEvent

ParticipantUpdateEvent

@JvmInline

@Serializable

@SerialName(value = "participant_update")

value class ParticipantUpdateEvent(val response: ParticipantResponse) : InfinityEvent

PeerDisconnectEvent

@Serializable

@SerialName(value = "peer_disconnect")

data object PeerDisconnectEvent : InfinityEvent

PreferredAspectRatioRequest

@Serializable

data class PreferredAspectRatioRequest(val aspectRatio: Float)

PresentationStartEvent

@Serializable

@SerialName(value = "presentation_start")

data class PresentationStartEvent(val presenterName: String, val presenterId: ParticipantId) : InfinityEvent

PresentationStopEvent

@Serializable

@SerialName(value = "presentation_stop")

data object PresentationStopEvent : InfinityEvent

ReferEvent

@Serializable

@SerialName(value = "refer")

data class ReferEvent(val conferenceAlias: String, val token: String) : InfinityEvent

RefreshRegistrationTokenResponse

@Serializable

data class RefreshRegistrationTokenResponse(val token: String, val expires: Duration) : Token

RefreshTokenResponse

@Serializable

data class RefreshTokenResponse(val token: String, val expires: Duration) : Token

RegistrationResponse

@Serializable

data class RegistrationResponse(val alias: String, val description: String = "", val username: String = "")

RequestedLayout

@Serializable

data class RequestedLayout(val primaryScreen: Screen)

RequestRegistrationTokenResponse

@Serializable

data class RequestRegistrationTokenResponse(val token: String, val expires: Duration, val registrationId: RegistrationId, val directoryEnabled: Boolean, val routeViaRegistrar: Boolean, val version: VersionResponse) : Token

RequestTokenRequest

@Serializable

data class RequestTokenRequest(val conferenceExtension: String? = null, val displayName: String? = null, val chosenIdp: IdentityProviderId? = null, val ssoToken: String? = null, val incomingToken: String? = null, val registrationToken: String? = null, val directMedia: Boolean = false, val callTag: String = "", val breakoutCapable: Boolean = false)

RequestTokenResponse

@Serializable

data class RequestTokenResponse(val token: String, val expires: Duration, val conferenceName: String, val participantId: ParticipantId, val participantName: String, val version: VersionResponse, val analyticsEnabled: Boolean = false, val chatEnabled: Boolean = false, val guestsCanPresent: Boolean = false, val serviceType: ServiceType = ServiceType.UNKNOWN, val stun: List<StunResponse> = emptyList(), val turn: List<TurnResponse> = emptyList(), val directMedia: Boolean = false, val useRelayCandidatesOnly: Boolean = false, val dataChannelId: Int = -1, val clientStatsUpdateInterval: Duration = Duration.INFINITE, val callTag: String = "", val parentParticipantId: ParticipantId? = null, val directMediaRequested: Boolean = false) : Token

RequiredPinException