sdk-api/com.pexip.sdk.api.infinity

Package-level declarations

Types

AckRequest

@Serializable

data class AckRequest(val sdp: String = "", val offerIgnored: Boolean = false)

BackgroundResponse

@Serializable

data class BackgroundResponse(val path: String)

ByeEvent

data object ByeEvent : Event

CallsRequest

@Serializable

data class CallsRequest(val callType: String, val sdp: String, val present: String? = null, val fecc: Boolean = false)

CallsResponse

@Serializable

data class CallsResponse(val callId: UUID, val sdp: String = "", val offerIgnored: Boolean = false) : OfferResponse

ConferenceUpdateEvent

@Serializable

data class ConferenceUpdateEvent(val locked: Boolean = false, val started: Boolean = false, val guestsMuted: Boolean = false, val presentationAllowed: Boolean = false) : Event

DataChannelMessage

@Serializable

sealed interface DataChannelMessage

DisconnectEvent

@Serializable

data class DisconnectEvent(val reason: String) : Event

DtmfRequest

@Serializable

data class DtmfRequest(val digits: String)

ElementResponse

@Serializable

sealed interface ElementResponse

FeccAction

@Serializable

enum FeccAction : Enum<FeccAction>

FeccEvent

@Serializable

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

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

data class IncomingCancelledEvent(val token: String) : Event

IncomingEvent

@Serializable

data class IncomingEvent(val conferenceAlias: String, val remoteDisplayName: String, val token: String) : 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.

Layout

typealias ~~Layout~~ = LayoutId

LayoutEvent

@Serializable

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

LayoutId

@Serializable

@JvmInline

value class LayoutId(val value: String)

MessageReceivedEvent

@Serializable

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

MessageRequest

@Serializable

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

Represents a message request to an Infinity conference or participant.

NewCandidateEvent

@Serializable

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

NewCandidateRequest

@Serializable

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

NewOfferEvent

@Serializable

data class NewOfferEvent(val sdp: String) : Event

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

@Serializable

@JvmInline

value class ParticipantCreateEvent(val response: ParticipantResponse) : Event

ParticipantDeleteEvent

@Serializable

data class ParticipantDeleteEvent(val id: UUID) : Event

ParticipantResponse

@Serializable

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

ParticipantSyncBeginEvent

data object ParticipantSyncBeginEvent : Event

ParticipantSyncEndEvent

data object ParticipantSyncEndEvent : Event

ParticipantUpdateEvent

@Serializable

@JvmInline

value class ParticipantUpdateEvent(val response: ParticipantResponse) : Event

PeerDisconnectEvent

@Serializable

data object PeerDisconnectEvent : Event

PreferredAspectRatioRequest

@Serializable

data class PreferredAspectRatioRequest(val aspectRatio: Float)

PresentationStartEvent

@Serializable

data class PresentationStartEvent(val presenterName: String, val presenterId: UUID) : Event

PresentationStopEvent

data object PresentationStopEvent : Event

ReferEvent

@Serializable

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

RefreshRegistrationTokenResponse

@Serializable

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

RefreshTokenResponse

@Serializable

data class RefreshTokenResponse(val token: String, val expires: Long) : 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: Long, val registrationId: UUID, 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)

RequestTokenResponse

@Serializable

data class RequestTokenResponse(val token: String, val expires: Long, val conferenceName: String, val participantId: UUID, 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 directMediaRequested: Boolean = false) : Token

RequiredPinException