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
CallType-
ClientCallTypeClient Call Type for client to make call w.r.t. audio, video, presentation direction

Interfaces

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

Type Aliases

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

Variables

VariableDescription
CLIENT_CALL_TYPE_MAP-
MAIN_ROOM_ID-

Functions

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