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-
BreakoutRequestGuestTokenMap-
BreakoutMoveParticipantsFromMainMap-
BreakoutMoveParticipantsMap-
GuestLeaveBreakoutMap-
HostBreakoutBuzzMap-
HostClearBreakoutBuzzMap-
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-
LiveCaptionsLanguagesMap-
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-
RegistrationRequestTokenMap-
RegistrationExchangeTokenMap-
RegistrationRefreshTokenMap-
RegistrationReleaseTokenMap-
RegistrationsMap-
RequestTokenMap-
RefreshTokenMap-
ReleaseTokenMap-
InfinityErrorMessage-
InfinityErrorCode-

Functions​

FunctionDescription
breakouts-
breakoutsMessage-
breakoutsDisconnect-
breakoutsEmpty-
breakoutRequestGuestToken-
breakoutMoveParticipantsFromMain-
breakoutMoveParticipants-
guestLeaveBreakout-
hostBreakoutBuzz-
hostClearBreakoutBuzz-
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-
liveCaptionsLanguages-
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-
registrationRequestToken-
registrationExchangeToken-
registrationRefreshToken-
registrationReleaseToken-
registrations-
requestToken-
refreshToken-
releaseToken-
withToken-
withPin-
getErrorCode-