@pexip/infinity

Enumerations

• CallType
• ClientCallType

Interfaces

• ApplicationMessage
• BreakoutRoom
• Call
• CallDisconnectedEvent
• CallOptions
• CallSignals
• Client
• ClientSignals
• ConferenceFeatureFlags
• ConferenceStatus
• DisconnectEvent
• EventSignals
• IceCandidate
• InfinitySignals
• LayoutEvent
• LiveCaptionsEvent
• Message
• MessageEvent
• Participant
• ParticipantSignals
• PresentationEvent
• PresoConnectionChangeEvent
• PresoState
• RequestClient
• RequestClientOptions
• SplashScreen
• Stage
• StageEvent
• Stats
• StatsCollectors
• TransferDetails

Type Aliases

CallUuid

Ƭ CallUuid: string | undefined

---

ClientSideErrorMessage

Ƭ ClientSideErrorMessage: "Could not reconnect to the meeting" | "Could not execute critical network action" | "Could not find ICE candidates" | "WebRTC connection closed" | "WebRTC connection failed"

---

ConferenceStateEvent

Ƭ ConferenceStateEvent: ConferenceStatusMap["200"][``"result"``]

---

CurrentServiceType

Ƭ CurrentServiceType: RTCParticipantEvent["service_type"] | RequestTokenMap["200"][``"result"``]["current_service_type"]

---

DataChannelEvent

Ƭ DataChannelEvent: { body: Omit<MessageEvent, "direct"> ; type: "message" } | { body: unknown ; type: "fecc" }

---

DisconnectReason

Ƭ DisconnectReason: "Browser closed" | "User initiated disconnect"

---

EndpointResponse

Ƭ EndpointResponse<K>: K extends keyof Client ? GetEndpointResponse<K> : never

Type parameters

Name	Type
K	keyof Client

---

ErrorSignal

Ƭ ErrorSignal: Signal<{ error: ExtendedInfinityErrorMessage ; errorCode: ExtendedInfinityErrorCode }>

---

EventsSourceType

Ƭ EventsSourceType: DisconnectEvent | MessageEvent | ConferenceStateEvent | PresentationEvent | RTCParticipantEvent | FeccEvent

---

ExtendedInfinityErrorCode

Ƭ ExtendedInfinityErrorCode: InfinityErrorCode | "#pex128" | "#pex117"

---

ExtendedInfinityErrorMessage

Ƭ ExtendedInfinityErrorMessage: InfinityErrorMessage | ClientSideErrorMessage

---

FeccEvent

Ƭ FeccEvent: FeccParticipantMap["Body"]

---

GetEndpointParams

Ƭ GetEndpointParams<K>: Client[K] extends (...args: never) => unknown ? Parameters<Client[K]> : never

Type parameters

Name	Type
K	extends keyof Client

---

GetEndpointResponse

Ƭ GetEndpointResponse<K>: Client[K] extends (...args: never) => infer R ? Awaited<R> : unknown

Type parameters

Name	Type
K	extends keyof Client

---

InfinityCallRequired

Ƭ InfinityCallRequired: Pick<CallSignals, "onRemoteStream" | "onRemotePresentationStream" | "onPresentationConnectionChange" | "onRtcStats" | "onCallQualityStats" | "onCallQuality">

---

InfinityCallSignalsOptional

Ƭ InfinityCallSignalsOptional: Pick<Partial<CallSignals>, "onCallConnected">

---

InfinityClient

Ƭ InfinityClient: Omit<Client, "ack" | "update" | "newCandidate" | "sendOffer" | "statistics" | "takeFloor" | "releaseFloor" | "requestTheme" | "sendMessage"> & { sendApplicationMessage: (opt: { conferenceAlias?: string ; host?: string ; participantUuid?: string ; payload: Record<string, unknown> }) => Promise<GetEndpointResponse<"sendMessage">> ; sendMessage: (opt: { conferenceAlias?: string ; host?: string ; participantUuid?: string ; payload: MessageBody["payload"] }) => Promise<GetEndpointResponse<"sendMessage">> }

---

InfinityEventSignalsOptional

Ƭ InfinityEventSignalsOptional: Pick<Partial<EventSignals>, "onHold" | "onRefer" | "onFecc" | "onRefreshToken">

---

InfinitySignalsOptional

Ƭ InfinitySignalsOptional: Pick<Partial<InfinitySignals>, "onPinRequired" | "onParticipants" | "onError">

---

InfinitySignalsRequired

Ƭ InfinitySignalsRequired: Pick<InfinitySignals, "onConnected" | "onAnswer" | "onPresentationAnswer" | "onDisconnected">

---

Layout

Ƭ Layout: Transforms["layout"]

---

MediaType

Ƭ MediaType: CallsWebrtcParticipantMap["Body"][``"media_type"``]

---

MessageBody

Ƭ MessageBody: MessageConferenceMap["Body"]

---

RTCParticipantEvent

Ƭ RTCParticipantEvent: ParticipantsMap["200"][``"result"``][0]

---

Role

Ƭ Role: TransferParticipantMap["Body"][``"role"``]

---

SSOdMessage

Ƭ SSOdMessage: { code: 403 ; result: "forbidden" } | { result: "success" ; token: string } | { code: 503 ; result: "service unavailable" }

---

Screen

Ƭ Screen: ThemeSchema["direct_media_escalate"]

---

SignalName

Ƭ SignalName: keyof CallSignals | keyof EventSignals | keyof InfinitySignals

---

Stun

Ƭ Stun: RequestTokenMap["200"][``"result"``]["stun"]

---

ThemeSchema

Ƭ ThemeSchema: ThemeMap["200"][``"result"``]

---

Transforms

Ƭ Transforms: TransformLayoutMap["Body"][``"transforms"``]

---

Turn

Ƭ Turn: RequestTokenMap["200"][``"result"``]["turn"]

Variables

callLivenessSignals

• Const callLivenessSignals: Object

Type declaration

Name	Type
onReconnected	Signal<undefined>
onReconnecting	Signal<undefined>

Functions

createCall

▸ createCall(options): Call

Parameters

Name	Type
options	CallOptions

Returns

Call

---

createCallSignals

▸ createCallSignals<K>(more, scope?): Pick<Required<CallSignals>, SignalKeys>

Create and return all required and optional (if specified with more), signals for call to work

See

• Signal
• CallSignalsOptional

The following signals created by default

• 'onRemoteStream',
• REQUIRED_CALL_SIGNAL_KEYS

Type parameters

Name	Type
K	extends "onCallConnected"

Parameters

Name	Type	Default value	Description
more	K[]	undefined	Keys from CallSignalsOptional,
scope	string	''	any scope prefix for the generated signal name,

Returns

Pick<Required<CallSignals>, SignalKeys>

---

createInfinityClient

▸ createInfinityClient(signals, callSignals): InfinityClient

Parameters

Name	Type
signals	InfinitySignals
callSignals	CallSignals

Returns

InfinityClient

---

createInfinityClientSignals

▸ createInfinityClientSignals<K>(more, scope?): Pick<Required<InfinitySignals>, SignalKeys>

Create and return all required and optional (if specified with more), signals for infinity client to work

See

• Signal
• InfinitySignalsOptional

The following signals created by default

• 'onConnected',
• 'onAnswer',
• REQUIRED_INFINITY_SIGNAL_KEYS

Type parameters

Name	Type
K	extends "onError" | "onPinRequired" | "onParticipants"

Parameters

Name	Type	Default value	Description
more	K[]	undefined	Keys from InfinitySignalsOptional,
scope	string	''	any scope prefix for the generated signal name,

Returns

Pick<Required<InfinitySignals>, SignalKeys>

---

isGateway

▸ isGateway(serviceType): boolean

Parameters

Name	Type
serviceType	CurrentServiceType

Returns

boolean

---

isReceivingAnyMedia

▸ isReceivingAnyMedia(callType): boolean

Parameters

Name	Type
callType	ClientCallType

Returns

boolean

---

isReceivingAudio

▸ isReceivingAudio(callType): boolean

Parameters

Name	Type
callType	ClientCallType

Returns

boolean

---

isReceivingVideo

▸ isReceivingVideo(callType): boolean

Parameters

Name	Type
callType	ClientCallType

Returns

boolean

---

isSSOdMessage

▸ isSSOdMessage(e): e is SSOdMessage

Parameters

Name	Type
e	unknown

Returns

e is SSOdMessage

---

isSendingAnyMedia

▸ isSendingAnyMedia(callType): boolean

Parameters

Name	Type
callType	ClientCallType

Returns

boolean

---

isSendingAudio

▸ isSendingAudio(callType): boolean

Parameters

Name	Type
callType	ClientCallType

Returns

boolean

---

isSendingVideo

▸ isSendingVideo(callType): boolean

Parameters

Name	Type
callType	ClientCallType

Returns

boolean

---

isUnidirectionalAudio

▸ isUnidirectionalAudio(callType): boolean

Parameters

Name	Type
callType	ClientCallType

Returns

boolean

---

isUnidirectionalVideo

▸ isUnidirectionalVideo(callType): boolean

Parameters

Name	Type
callType	ClientCallType

Returns

boolean

---

isWaiting

▸ isWaiting(serviceType): boolean

Parameters

Name	Type
serviceType	CurrentServiceType

Returns

boolean

---

setLogger

▸ setLogger(newLogger): void

Parameters

Name	Type
newLogger	Logger

Returns

void