Skip to main content

@pexip/infinity

Connect to Pexip MCU and get and send correctly typed events (including webrtc call).

Install

npm install @pexip/infinity

Enumerations

EnumerationDescription
ClientCallTypeClient Call Type for client to make call w.r.t. audio, video, presentation direction
CallType-

Interfaces

InterfaceDescription
RequestClient-
RequestClientOptions-
BreakoutRoom-
Client-
MediaPriorityPriority and QoS Model for each media line
ReceiverJitterBufferTargetThe jitterBufferTarget property of the RTCRtpReceiver interface
DegradationPreference-
AllowMediaChangeOfDirection-
CallOptions-
Call-
PresoConnectionChangeEvent-
ClientSignals-
RoomParticipantEvent-
ParticipantSignals-
InfinitySignals-
MainStatsSignals-
Stats-
CallSignals-
SplashScreen-
EventSignals-
IceCandidate-
DisconnectEvent-
MessageEvent-
StageEvent-
LayoutEvent-
PresentationEvent-
NormalizedPresentationEvent-
Source-
LiveCaptionsEvent-
CallDisconnectedEvent-
Participant-
Message-
ApplicationMessage-
Stage-
ConferenceStatus-
TransferDetails-
BreakoutReferDetails-
ConferenceFeatureFlags-
PresoState-
StatsCollectors-

Type Aliases

Type AliasDescription
MessageBody-
ConferenceStateEvent-
RTCParticipantEvent-
Transforms-
Layout-
FeccEvent-
Role-
Stun-
Turn-
ThemeSchema-
Screen-
MediaType-
CurrentServiceType-
Guid-
RoomID-
ParticipantID-
InfinityClient-
GetEndpointParams-
GetEndpointResponse-
EndpointResponse-
ExtendedInfinityErrorCode-
ErrorSignal-
InfinitySignalsOptional-
InfinitySignalsRequired-
InfinityCallSignalsOptional-
InfinityCallRequired-
InfinityEventSignalsOptional-
SignalName-
ClientSideErrorMessage-
ExtendedInfinityErrorMessage-
Sources-
EventsSourceType-
CallUuid-
DataChannelEvent-
DisconnectReason-
SSOdMessage-

Variables

VariableDescription
CLIENT_CALL_TYPE_MAP-
MAIN_ROOM_ID-

Functions

FunctionDescription
createCall-
createInfinityClient-
setLogger-
isSSOdMessage-
isMediaPriority-
isJitterBufferTarget-
isRoomID-
assertRoomID-
isParticipantID-
assertParticipantID-
createInfinityClientSignalsCreate and return all required and optional (if specified with more), signals for infinity client to work
createCallSignalsCreate and return all required and optional (if specified with more), signals for call to work
isWaiting-
isGateway-
isControlOnly-
isReceivingAudio-
isReceivingVideo-
isReceivingPresentation-
isReceivingAnyMedia-
isSendingAudio-
isSendingVideo-
isSendingPresentation-
isSendingAnyMedia-
isUnidirectionalAudio-
isUnidirectionalVideo-