Skip to main content

@pexip/infinity-api

Type-safe wrappers for clients v2 rest api.

Install

npm install @pexip/infinity-api

Classes

ClassDescription
ValidationError-
NonJSONResponseError-

Type Aliases

Type AliasDescription
BreakoutsMap-
BreakoutsMessageMap-
BreakoutsDisconnectMap-
BreakoutsEmptyMap-
BreakoutDisconnectMap-
BreakoutTransformLayoutMap-
BreakoutMuteguestsMap-
BreakoutUnmuteguestsMap-
BreakoutSetGuestsCanUnmuteMap-
BreakoutLockMap-
BreakoutUnlockMap-
BreakoutRequestGuestTokenMap-
BreakoutMoveParticipantsFromMainMap-
BreakoutMoveParticipantsMap-
BreakoutCallsWebrtcParticipantMap-
BreakoutMuteParticipantMap-
BreakoutUnmuteParticipantMap-
BreakoutClientMuteParticipantMap-
BreakoutClientUnmuteParticipantMap-
BreakoutVideoMuteParticipantMap-
BreakoutVideoUnmuteParticipantMap-
BreakoutOverlaytextParticipantMap-
BreakoutTakeFloorMap-
BreakoutReleaseFloorMap-
BreakoutAckMap-
BreakoutDisconnectCallMap-
BreakoutNewCandidateMap-
BreakoutUpdateMap-
BreakoutShowLiveCaptionsMap-
BreakoutHideLiveCaptionsMap-
BreakoutMessageConferenceMap-
BreakoutUnlockParticipantMap-
BreakoutDisconnectParticipantMap-
BreakoutBuzzParticipantMap-
BreakoutClearbuzzParticipantMap-
GuestLeaveBreakoutMap-
HostBreakoutBuzzMap-
HostClearBreakoutBuzzMap-
BreakoutClearAllBuzzMap-
BreakoutTransferParticipantMap-
BreakoutFeccParticipantMap-
BreakoutSpotlightonParticipantMap-
BreakoutSpotlightoffParticipantMap-
BreakoutDtmfParticipantMap-
BreakoutVideoMixesCreateMap-
BreakoutVideoMixesConfigureMap-
BreakoutVideoMixesDeleteMap-
AckMap-
DisconnectCallMap-
DtmfMap-
FeccMap-
NewCandidateMap-
UpdateMap-
StatisticsMap-
DialMap-
ConferenceStatusMap-
LockMap-
UnlockMap-
StartConferenceMap-
MuteguestsMap-
UnmuteguestsMap-
SetGuestsCanUnmuteMap-
DisconnectMap-
MessageConferenceMap-
ParticipantsMap-
TransformLayoutMap-
ClearAllBuzzMap-
SilentVideoDetectionMap-
ThemeMap-
AvailableLayoutsMap-
LayoutSvgsMap-
GuestBreakoutBuzzMap-
GuestClearBreakoutBuzzMap-
VideoMixesCreateMap-
VideoMixesConfigureMap-
VideoMixesDeleteMap-
DisconnectParticipantMap-
MuteParticipantMap-
UnmuteParticipantMap-
ClientMuteParticipantMap-
ClientUnmuteParticipantMap-
VideoMuteParticipantMap-
VideoUnmuteParticipantMap-
AllowrxpresentationParticipantMap-
DenyrxpresentationParticipantMap-
SpotlightonParticipantMap-
SpotlightoffParticipantMap-
UnlockParticipantMap-
DtmfParticipantMap-
CallsWebrtcParticipantMap-
CallsRtmpParticipantMap-
OverlaytextParticipantMap-
PresInMixParticipantMap-
RoleParticipantMap-
FeccParticipantMap-
BuzzParticipantMap-
ClearbuzzParticipantMap-
TransferParticipantMap-
MessageParticipantMap-
AvatarJpgParticipantMap-
TakeFloorMap-
ReleaseFloorMap-
ShowLiveCaptionsMap-
HideLiveCaptionsMap-
PreferredAspectRatioMap-
NotifyNotAFKMap-
RequestTokenMap-
RefreshTokenMap-
ReleaseTokenMap-
InfinityErrorMessage-
InfinityErrorCode-

Functions

FunctionDescription
breakouts-
breakoutsMessage-
breakoutsDisconnect-
breakoutsEmpty-
breakoutDisconnect-
breakoutTransformLayout-
breakoutMuteguests-
breakoutUnmuteguests-
breakoutSetGuestsCanUnmute-
breakoutLock-
breakoutUnlock-
breakoutRequestGuestToken-
breakoutMoveParticipantsFromMain-
breakoutMoveParticipants-
breakoutCallsWebrtcParticipant-
breakoutMuteParticipant-
breakoutUnmuteParticipant-
breakoutClientMuteParticipant-
breakoutClientUnmuteParticipant-
breakoutVideoMuteParticipant-
breakoutVideoUnmuteParticipant-
breakoutOverlaytextParticipant-
breakoutTakeFloor-
breakoutReleaseFloor-
breakoutAck-
breakoutDisconnectCall-
breakoutNewCandidate-
breakoutUpdate-
breakoutShowLiveCaptions-
breakoutHideLiveCaptions-
breakoutMessageConference-
breakoutUnlockParticipant-
breakoutDisconnectParticipant-
breakoutBuzzParticipant-
breakoutClearbuzzParticipant-
guestLeaveBreakout-
hostBreakoutBuzz-
hostClearBreakoutBuzz-
breakoutClearAllBuzz-
breakoutTransferParticipant-
breakoutFeccParticipant-
breakoutSpotlightonParticipant-
breakoutSpotlightoffParticipant-
breakoutDtmfParticipant-
breakoutVideoMixesCreate-
breakoutVideoMixesConfigure-
breakoutVideoMixesDelete-
ack-
disconnectCall-
dtmf-
fecc-
newCandidate-
update-
statistics-
dial-
conferenceStatus-
lock-
unlock-
startConference-
muteguests-
unmuteguests-
setGuestsCanUnmute-
disconnect-
messageConference-
participants-
transformLayout-
clearAllBuzz-
silentVideoDetection-
theme-
availableLayouts-
layoutSvgs-
guestBreakoutBuzz-
guestClearBreakoutBuzz-
videoMixesCreate-
videoMixesConfigure-
videoMixesDelete-
disconnectParticipant-
muteParticipant-
unmuteParticipant-
clientMuteParticipant-
clientUnmuteParticipant-
videoMuteParticipant-
videoUnmuteParticipant-
allowrxpresentationParticipant-
denyrxpresentationParticipant-
spotlightonParticipant-
spotlightoffParticipant-
unlockParticipant-
dtmfParticipant-
callsWebrtcParticipant-
callsRtmpParticipant-
overlaytextParticipant-
presInMixParticipant-
roleParticipant-
feccParticipant-
buzzParticipant-
clearbuzzParticipant-
transferParticipant-
messageParticipant-
avatarJpgParticipant-
takeFloor-
releaseFloor-
showLiveCaptions-
hideLiveCaptions-
preferredAspectRatio-
notifyNotAFK-
requestToken-
refreshToken-
releaseToken-
withToken-
withPin-
getErrorCode-