@pexip/infinity-api
Classes
Type Aliases
AckMap
Ƭ AckMap: Endpoints
["ack"
]
AllowrxpresentationParticipantMap
Ƭ AllowrxpresentationParticipantMap: Endpoints
["allowrxpresentation_participant"
]
AvatarJpgParticipantMap
Ƭ AvatarJpgParticipantMap: Endpoints
["avatar.jpg_participant"
]
BreakoutAckMap
Ƭ BreakoutAckMap: Endpoints
["breakout_ack"
]
BreakoutCallsWebrtcParticipantMap
Ƭ BreakoutCallsWebrtcParticipantMap: Endpoints
["breakout_calls_webrtc_participant"
]
BreakoutDisconnectCallMap
Ƭ BreakoutDisconnectCallMap: Endpoints
["breakout_disconnect_call"
]
BreakoutDisconnectMap
Ƭ BreakoutDisconnectMap: Endpoints
["breakout_disconnect"
]
BreakoutHideLiveCaptionsMap
Ƭ BreakoutHideLiveCaptionsMap: Endpoints
["breakout_hide_live_captions"
]
BreakoutMoveParticipantsFromMainMap
Ƭ BreakoutMoveParticipantsFromMainMap: Endpoints
["breakout_move_participants_from_main"
]
BreakoutMoveParticipantsMap
Ƭ BreakoutMoveParticipantsMap: Endpoints
["breakout_move_participants"
]
BreakoutMuteParticipantMap
Ƭ BreakoutMuteParticipantMap: Endpoints
["breakout_mute_participant"
]
BreakoutMuteguestsMap
Ƭ BreakoutMuteguestsMap: Endpoints
["breakout_muteguests"
]
BreakoutNewCandidateMap
Ƭ BreakoutNewCandidateMap: Endpoints
["breakout_new_candidate"
]
BreakoutOverlaytextParticipantMap
Ƭ BreakoutOverlaytextParticipantMap: Endpoints
["breakout_overlaytext_participant"
]
BreakoutReleaseFloorMap
Ƭ BreakoutReleaseFloorMap: Endpoints
["breakout_release_floor"
]
BreakoutShowLiveCaptionsMap
Ƭ BreakoutShowLiveCaptionsMap: Endpoints
["breakout_show_live_captions"
]
BreakoutTakeFloorMap
Ƭ BreakoutTakeFloorMap: Endpoints
["breakout_take_floor"
]
BreakoutTransformLayoutMap
Ƭ BreakoutTransformLayoutMap: Endpoints
["breakout_transform_layout"
]
BreakoutUnmuteParticipantMap
Ƭ BreakoutUnmuteParticipantMap: Endpoints
["breakout_unmute_participant"
]
BreakoutUnmuteguestsMap
Ƭ BreakoutUnmuteguestsMap: Endpoints
["breakout_unmuteguests"
]
BreakoutUpdateMap
Ƭ BreakoutUpdateMap: Endpoints
["breakout_update"
]
BreakoutsDisconnectMap
Ƭ BreakoutsDisconnectMap: Endpoints
["breakouts_disconnect"
]
BreakoutsMap
Ƭ BreakoutsMap: Endpoints
["breakouts"
]
BreakoutsMessageMap
Ƭ BreakoutsMessageMap: Endpoints
["breakouts_message"
]
BuzzParticipantMap
Ƭ BuzzParticipantMap: Endpoints
["buzz_participant"
]
CallsRtmpParticipantMap
Ƭ CallsRtmpParticipantMap: Endpoints
["calls_rtmp_participant"
]
CallsWebrtcParticipantMap
Ƭ CallsWebrtcParticipantMap: Endpoints
["calls_webrtc_participant"
]
ClearallbuzzMap
Ƭ ClearallbuzzMap: Endpoints
["clearallbuzz"
]
ClearbuzzParticipantMap
Ƭ ClearbuzzParticipantMap: Endpoints
["clearbuzz_participant"
]
ConferenceStatusMap
Ƭ ConferenceStatusMap: Endpoints
["conference_status"
]
DenyrxpresentationParticipantMap
Ƭ DenyrxpresentationParticipantMap: Endpoints
["denyrxpresentation_participant"
]
DialMap
Ƭ DialMap: Endpoints
["dial"
]
DisconnectCallMap
Ƭ DisconnectCallMap: Endpoints
["disconnect_call"
]
DisconnectMap
Ƭ DisconnectMap: Endpoints
["disconnect"
]
DisconnectParticipantMap
Ƭ DisconnectParticipantMap: Endpoints
["disconnect_participant"
]
DtmfMap
Ƭ DtmfMap: Endpoints
["dtmf"
]
DtmfParticipantMap
Ƭ DtmfParticipantMap: Endpoints
["dtmf_participant"
]
FeccParticipantMap
Ƭ FeccParticipantMap: Endpoints
["fecc_participant"
]
HideLiveCaptionsMap
Ƭ HideLiveCaptionsMap: Endpoints
["hide_live_captions"
]
InfinityErrorCode
Ƭ InfinityErrorCode: ReturnType
<typeof getErrorCode
>
InfinityErrorMessage
Ƭ InfinityErrorMessage: RequestTokenMap
["403"
][``"result"``] & string
LockMap
Ƭ LockMap: Endpoints
["lock"
]
MessageConferenceMap
Ƭ MessageConferenceMap: Endpoints
["message_conference"
]
MessageParticipantMap
Ƭ MessageParticipantMap: Endpoints
["message_participant"
]
MuteParticipantMap
Ƭ MuteParticipantMap: Endpoints
["mute_participant"
]
MuteguestsMap
Ƭ MuteguestsMap: Endpoints
["muteguests"
]
NewCandidateMap
Ƭ NewCandidateMap: Endpoints
["new_candidate"
]
OverlaytextParticipantMap
Ƭ OverlaytextParticipantMap: Endpoints
["overlaytext_participant"
]
ParticipantsMap
Ƭ ParticipantsMap: Endpoints
["participants"
]
PreferredAspectRatioMap
Ƭ PreferredAspectRatioMap: Endpoints
["preferred_aspect_ratio"
]
PresInMixParticipantMap
Ƭ PresInMixParticipantMap: Endpoints
["pres_in_mix_participant"
]
RefreshTokenMap
Ƭ RefreshTokenMap: Endpoints
["refresh_token"
]
ReleaseFloorMap
Ƭ ReleaseFloorMap: Endpoints
["release_floor"
]
ReleaseTokenMap
Ƭ ReleaseTokenMap: Endpoints
["release_token"
]
RequestTokenMap
Ƭ RequestTokenMap: Endpoints
["request_token"
]
RoleParticipantMap
Ƭ RoleParticipantMap: Endpoints
["role_participant"
]
ShowLiveCaptionsMap
Ƭ ShowLiveCaptionsMap: Endpoints
["show_live_captions"
]
SilentVideoDetectionMap
Ƭ SilentVideoDetectionMap: Endpoints
["silent_video_detection"
]
SpotlightoffParticipantMap
Ƭ SpotlightoffParticipantMap: Endpoints
["spotlightoff_participant"
]
SpotlightonParticipantMap
Ƭ SpotlightonParticipantMap: Endpoints
["spotlighton_participant"
]
StartConferenceMap
Ƭ StartConferenceMap: Endpoints
["start_conference"
]
StatisticsMap
Ƭ StatisticsMap: Endpoints
["statistics"
]
TakeFloorMap
Ƭ TakeFloorMap: Endpoints
["take_floor"
]
ThemeMap
Ƭ ThemeMap: Endpoints
["theme"
]
TransferParticipantMap
Ƭ TransferParticipantMap: Endpoints
["transfer_participant"
]
TransformLayoutMap
Ƭ TransformLayoutMap: Endpoints
["transform_layout"
]
UnlockMap
Ƭ UnlockMap: Endpoints
["unlock"
]
UnlockParticipantMap
Ƭ UnlockParticipantMap: Endpoints
["unlock_participant"
]
UnmuteParticipantMap
Ƭ UnmuteParticipantMap: Endpoints
["unmute_participant"
]
UnmuteguestsMap
Ƭ UnmuteguestsMap: Endpoints
["unmuteguests"
]
UpdateMap
Ƭ UpdateMap: Endpoints
["update"
]
VideoMuteParticipantMap
Ƭ VideoMuteParticipantMap: Endpoints
["video_mute_participant"
]
VideoUnmuteParticipantMap
Ƭ VideoUnmuteParticipantMap: Endpoints
["video_unmute_participant"
]
Functions
ack
▸ ack(«destructured»
): Promise
<AckResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› body | TopLevel |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.callUuid | string |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<AckResponse
>
allowrxpresentationParticipant
▸ allowrxpresentationParticipant(«destructured»
): Promise
<AllowrxpresentationParticipantResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<AllowrxpresentationParticipantResponse
>
avatarJpgParticipant
▸ avatarJpgParticipant(«destructured»
): Promise
<AvatarJpgParticipantResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<AvatarJpgParticipantResponse
>
breakoutAck
▸ breakoutAck(«destructured»
): Promise
<BreakoutAckResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› body | TopLevel6 |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.breakoutUuid | string |
› params.callUuid | string |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<BreakoutAckResponse
>
breakoutCallsWebrtcParticipant
▸ breakoutCallsWebrtcParticipant(«destructured»
): Promise
<BreakoutCallsWebrtcParticipantResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› body | TopLevel4 |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.breakoutUuid | string |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<BreakoutCallsWebrtcParticipantResponse
>
breakoutDisconnect
▸ breakoutDisconnect(«destructured»
): Promise
<BreakoutDisconnectResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.breakoutUuid | string |
› params.conferenceAlias | string |
Returns
Promise
<BreakoutDisconnectResponse
>
breakoutDisconnectCall
▸ breakoutDisconnectCall(«destructured»
): Promise
<BreakoutDisconnectCallResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.breakoutUuid | string |
› params.callUuid | string |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<BreakoutDisconnectCallResponse
>
breakoutHideLiveCaptions
▸ breakoutHideLiveCaptions(«destructured»
): Promise
<BreakoutHideLiveCaptionsResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.breakoutUuid | string |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<BreakoutHideLiveCaptionsResponse
>
breakoutMoveParticipants
▸ breakoutMoveParticipants(«destructured»
): Promise
<BreakoutMoveParticipantsResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› body | TopLevel3 |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.breakoutUuid | string |
› params.conferenceAlias | string |
Returns
Promise
<BreakoutMoveParticipantsResponse
>
breakoutMoveParticipantsFromMain
▸ breakoutMoveParticipantsFromMain(«destructured»
): Promise
<BreakoutMoveParticipantsFromMainResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› body | TopLevel3 |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
Returns
Promise
<BreakoutMoveParticipantsFromMainResponse
>
breakoutMuteParticipant
▸ breakoutMuteParticipant(«destructured»
): Promise
<BreakoutMuteParticipantResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.breakoutUuid | string |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<BreakoutMuteParticipantResponse
>
breakoutMuteguests
▸ breakoutMuteguests(«destructured»
): Promise
<BreakoutMuteguestsResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.breakoutUuid | string |
› params.conferenceAlias | string |
Returns
Promise
<BreakoutMuteguestsResponse
>
breakoutNewCandidate
▸ breakoutNewCandidate(«destructured»
): Promise
<BreakoutNewCandidateResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› body | TopLevel7 |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.breakoutUuid | string |
› params.callUuid | string |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<BreakoutNewCandidateResponse
>
breakoutOverlaytextParticipant
▸ breakoutOverlaytextParticipant(«destructured»
): Promise
<BreakoutOverlaytextParticipantResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› body | TopLevel5 |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.breakoutUuid | string |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<BreakoutOverlaytextParticipantResponse
>
breakoutReleaseFloor
▸ breakoutReleaseFloor(«destructured»
): Promise
<BreakoutReleaseFloorResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.breakoutUuid | string |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<BreakoutReleaseFloorResponse
>
breakoutShowLiveCaptions
▸ breakoutShowLiveCaptions(«destructured»
): Promise
<BreakoutShowLiveCaptionsResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.breakoutUuid | string |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<BreakoutShowLiveCaptionsResponse
>
breakoutTakeFloor
▸ breakoutTakeFloor(«destructured»
): Promise
<BreakoutTakeFloorResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.breakoutUuid | string |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<BreakoutTakeFloorResponse
>
breakoutTransformLayout
▸ breakoutTransformLayout(«destructured»
): Promise
<BreakoutTransformLayoutResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› body | TopLevel2 |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.breakoutUuid | string |
› params.conferenceAlias | string |
Returns
Promise
<BreakoutTransformLayoutResponse
>
breakoutUnmuteParticipant
▸ breakoutUnmuteParticipant(«destructured»
): Promise
<BreakoutUnmuteParticipantResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.breakoutUuid | string |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<BreakoutUnmuteParticipantResponse
>
breakoutUnmuteguests
▸ breakoutUnmuteguests(«destructured»
): Promise
<BreakoutUnmuteguestsResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.breakoutUuid | string |
› params.conferenceAlias | string |
Returns
Promise
<BreakoutUnmuteguestsResponse
>
breakoutUpdate
▸ breakoutUpdate(«destructured»
): Promise
<BreakoutUpdateResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› body | TopLevel8 |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.breakoutUuid | string |
› params.callUuid | string |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<BreakoutUpdateResponse
>
breakouts
▸ breakouts(«destructured»
): Promise
<BreakoutsResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› body | TopLevel |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
Returns
Promise
<BreakoutsResponse
>
breakoutsDisconnect
▸ breakoutsDisconnect(«destructured»
): Promise
<BreakoutsDisconnectResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
Returns
Promise
<BreakoutsDisconnectResponse
>
breakoutsMessage
▸ breakoutsMessage(«destructured»
): Promise
<BreakoutsMessageResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› body | TopLevel1 |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
Returns
Promise
<BreakoutsMessageResponse
>
buzzParticipant
▸ buzzParticipant(«destructured»
): Promise
<BuzzParticipantResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<BuzzParticipantResponse
>
callsRtmpParticipant
▸ callsRtmpParticipant(«destructured»
): Promise
<CallsRtmpParticipantResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› body | TopLevel2 |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<CallsRtmpParticipantResponse
>
callsWebrtcParticipant
▸ callsWebrtcParticipant(«destructured»
): Promise
<CallsWebrtcParticipantResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› body | TopLevel1 |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<CallsWebrtcParticipantResponse
>
clearallbuzz
▸ clearallbuzz(«destructured»
): Promise
<ClearallbuzzResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
Returns
Promise
<ClearallbuzzResponse
>
clearbuzzParticipant
▸ clearbuzzParticipant(«destructured»
): Promise
<ClearbuzzParticipantResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<ClearbuzzParticipantResponse
>
conferenceStatus
▸ conferenceStatus(«destructured»
): Promise
<ConferenceStatusResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
Returns
Promise
<ConferenceStatusResponse
>
denyrxpresentationParticipant
▸ denyrxpresentationParticipant(«destructured»
): Promise
<DenyrxpresentationParticipantResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<DenyrxpresentationParticipantResponse
>
dial
▸ dial(«destructured»
): Promise
<DialResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› body | TopLevel |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
Returns
Promise
<DialResponse
>
disconnect
▸ disconnect(«destructured»
): Promise
<DisconnectResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
Returns
Promise
<DisconnectResponse
>
disconnectCall
▸ disconnectCall(«destructured»
): Promise
<DisconnectCallResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.callUuid | string |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<DisconnectCallResponse
>
disconnectParticipant
▸ disconnectParticipant(«destructured»
): Promise
<DisconnectParticipantResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<DisconnectParticipantResponse
>
dtmf
▸ dtmf(«destructured»
): Promise
<DtmfResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› body | TopLevel1 |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.callUuid | string |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<DtmfResponse
>
dtmfParticipant
▸ dtmfParticipant(«destructured»
): Promise
<DtmfParticipantResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› body | TopLevel |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<DtmfParticipantResponse
>
feccParticipant
▸ feccParticipant(«destructured»
): Promise
<FeccParticipantResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› body | TopLevel6 |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<FeccParticipantResponse
>
getErrorCode
▸ getErrorCode(error
): "#pex100"
| "#pex101"
| "#pex109"
| "#pex110"
| "#pex111"
| "#pex112"
| "#pex113"
| "#pex114"
| "#pex115"
| "#pex116"
| "#pex119"
| "#pex120"
| "#pex121"
| "#pex122"
| "#pex123"
| "#pex124"
| "#pex125"
| "#pex126"
| "#pex127"
| "#pex129"
| "#pex130"
| "#pex131"
| "#pex132"
| "#pex140"
| "#pex141"
| "#pex142"
| "#pex143"
| "#pex150"
| "#pex151"
| "#pex152"
| "#pex153"
| "#pex154"
| "#pex156"
| "#pex157"
| "#pex191"
| "#pex192"
| "#pex193"
| "#pex194"
| "#pex195"
| "#pex196"
| "#pex197"
| "#pex200"
| "#pex201"
| "#pex203"
| "#pex204"
| "#pex210"
| "#pex211"
| "#pex117"
Parameters
Name | Type |
---|---|
error | InfinityErrorMessage |
Returns
"#pex100"
| "#pex101"
| "#pex109"
| "#pex110"
| "#pex111"
| "#pex112"
| "#pex113"
| "#pex114"
| "#pex115"
| "#pex116"
| "#pex119"
| "#pex120"
| "#pex121"
| "#pex122"
| "#pex123"
| "#pex124"
| "#pex125"
| "#pex126"
| "#pex127"
| "#pex129"
| "#pex130"
| "#pex131"
| "#pex132"
| "#pex140"
| "#pex141"
| "#pex142"
| "#pex143"
| "#pex150"
| "#pex151"
| "#pex152"
| "#pex153"
| "#pex154"
| "#pex156"
| "#pex157"
| "#pex191"
| "#pex192"
| "#pex193"
| "#pex194"
| "#pex195"
| "#pex196"
| "#pex197"
| "#pex200"
| "#pex201"
| "#pex203"
| "#pex204"
| "#pex210"
| "#pex211"
| "#pex117"
hideLiveCaptions
▸ hideLiveCaptions(«destructured»
): Promise
<HideLiveCaptionsResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<HideLiveCaptionsResponse
>
lock
▸ lock(«destructured»
): Promise
<LockResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
Returns
Promise
<LockResponse
>
messageConference
▸ messageConference(«destructured»
): Promise
<MessageConferenceResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› body | TopLevel1 |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
Returns
Promise
<MessageConferenceResponse
>
messageParticipant
▸ messageParticipant(«destructured»
): Promise
<MessageParticipantResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› body | TopLevel8 |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<MessageParticipantResponse
>
muteParticipant
▸ muteParticipant(«destructured»
): Promise
<MuteParticipantResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<MuteParticipantResponse
>
muteguests
▸ muteguests(«destructured»
): Promise
<MuteguestsResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
Returns
Promise
<MuteguestsResponse
>
newCandidate
▸ newCandidate(«destructured»
): Promise
<NewCandidateResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› body | TopLevel2 |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.callUuid | string |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<NewCandidateResponse
>
overlaytextParticipant
▸ overlaytextParticipant(«destructured»
): Promise
<OverlaytextParticipantResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› body | TopLevel3 |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<OverlaytextParticipantResponse
>
participants
▸ participants(«destructured»
): Promise
<ParticipantsResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
Returns
Promise
<ParticipantsResponse
>
preferredAspectRatio
▸ preferredAspectRatio(«destructured»
): Promise
<PreferredAspectRatioResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› body | TopLevel9 |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<PreferredAspectRatioResponse
>
presInMixParticipant
▸ presInMixParticipant(«destructured»
): Promise
<PresInMixParticipantResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› body | TopLevel4 |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<PresInMixParticipantResponse
>
refreshToken
▸ refreshToken(«destructured»
): Promise
<RefreshTokenResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
Returns
Promise
<RefreshTokenResponse
>
releaseFloor
▸ releaseFloor(«destructured»
): Promise
<ReleaseFloorResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<ReleaseFloorResponse
>
releaseToken
▸ releaseToken(«destructured»
): Promise
<ReleaseTokenResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› body | TopLevel1 |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
Returns
Promise
<ReleaseTokenResponse
>
requestToken
▸ requestToken(«destructured»
): Promise
<RequestTokenResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› body | TopLevel |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
Returns
Promise
<RequestTokenResponse
>
roleParticipant
▸ roleParticipant(«destructured»
): Promise
<RoleParticipantResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› body | TopLevel5 |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<RoleParticipantResponse
>
showLiveCaptions
▸ showLiveCaptions(«destructured»
): Promise
<ShowLiveCaptionsResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<ShowLiveCaptionsResponse
>
silentVideoDetection
▸ silentVideoDetection(«destructured»
): Promise
<SilentVideoDetectionResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› body | TopLevel3 |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
Returns
Promise
<SilentVideoDetectionResponse
>
spotlightoffParticipant
▸ spotlightoffParticipant(«destructured»
): Promise
<SpotlightoffParticipantResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<SpotlightoffParticipantResponse
>
spotlightonParticipant
▸ spotlightonParticipant(«destructured»
): Promise
<SpotlightonParticipantResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<SpotlightonParticipantResponse
>
startConference
▸ startConference(«destructured»
): Promise
<StartConferenceResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
Returns
Promise
<StartConferenceResponse
>
statistics
▸ statistics(«destructured»
): Promise
<StatisticsResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› body | TopLevel4 |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.callUuid | string |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<StatisticsResponse
>
takeFloor
▸ takeFloor(«destructured»
): Promise
<TakeFloorResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<TakeFloorResponse
>
theme
▸ theme(«destructured»
): Promise
<ThemeResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
Returns
Promise
<ThemeResponse
>
transferParticipant
▸ transferParticipant(«destructured»
): Promise
<TransferParticipantResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› body | TopLevel7 |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<TransferParticipantResponse
>
transformLayout
▸ transformLayout(«destructured»
): Promise
<TransformLayoutResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› body | TopLevel2 |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
Returns
Promise
<TransformLayoutResponse
>
unlock
▸ unlock(«destructured»
): Promise
<UnlockResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
Returns
Promise
<UnlockResponse
>
unlockParticipant
▸ unlockParticipant(«destructured»
): Promise
<UnlockParticipantResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<UnlockParticipantResponse
>
unmuteParticipant
▸ unmuteParticipant(«destructured»
): Promise
<UnmuteParticipantResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<UnmuteParticipantResponse
>
unmuteguests
▸ unmuteguests(«destructured»
): Promise
<UnmuteguestsResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
Returns
Promise
<UnmuteguestsResponse
>
update
▸ update(«destructured»
): Promise
<UpdateResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› body | TopLevel3 |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.callUuid | string |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<UpdateResponse
>
videoMuteParticipant
▸ videoMuteParticipant(«destructured»
): Promise
<VideoMuteParticipantResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<VideoMuteParticipantResponse
>
videoUnmuteParticipant
▸ videoUnmuteParticipant(«destructured»
): Promise
<VideoUnmuteParticipantResponse
>
Parameters
Name | Type |
---|---|
«destructured» | Object |
› fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
› host | string |
› init? | RequestInit |
› params | Object |
› params.conferenceAlias | string |
› params.participantUuid | string |
Returns
Promise
<VideoUnmuteParticipantResponse
>
withPin
▸ withPin(fetcher
, pin
): typeof fetch
Parameters
Name | Type |
---|---|
fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
pin | string |
Returns
typeof fetch
withToken
▸ withToken(fetcher
, token
): typeof fetch
Parameters
Name | Type |
---|---|
fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > |
token | string |
Returns
typeof fetch