Skip to main content

Client

Properties

PropertyTypeDescription
roomIdRoomID-
roomsRoomID[]-
breakoutRoomsMap<RoomID, BreakoutRoom>-
breakoutRoomNamesMap<RoomID, string>-
conferenceStatusMap<RoomID, ConferenceStatus>-
conferenceFeatureFlags?ConferenceFeatureFlags-
secureCheckCodestring-
latestStatsStats | undefined-
serviceTypeCurrentServiceType-
isFeccEnabledboolean-
conferenceNamestring | undefined-
localCallTypeClientCallTypeThe callType that is being used for the current call
admit(opt) => Promise< | UnlockParticipantResponse | BreakoutUnlockParticipantResponse | undefined>-
call(opt) => Promise<RequestTokenResponse | undefined>-
disconnect(opt) => Promise<void>-
kick(opt) => Promise< | DisconnectParticipantResponse | BreakoutDisconnectParticipantResponse | undefined>-
dial(opt) => Promise<DialResponse | undefined>-
transfer(opt) => Promise<TransferParticipantResponse | undefined>-
mute(opt) => Promise<MuteParticipantResponse | UnmuteParticipantResponse | undefined>-
clientMute(opt) => Promise< | ClientMuteParticipantResponse | ClientUnmuteParticipantResponse | undefined>-
guestsCanUnmute(opt) => Promise<SetGuestsCanUnmuteResponse | undefined>-
muteAllGuests(opt) => Promise<MuteguestsResponse | UnmuteguestsResponse | undefined>-
muteVideo(opt) => Promise< | VideoMuteParticipantResponse | VideoUnmuteParticipantResponse | undefined>-
lock(opt) => Promise< | LockResponse | UnlockResponse | BreakoutLockResponse | BreakoutUnlockResponse | undefined>-
disconnectAll(opt) => Promise<DisconnectResponse | undefined>-
setLayout(opt) => Promise<TransformLayoutResponse | BreakoutTransformLayoutResponse | undefined>-
setPersonalLayout(opt) => Promise< | VideoMixesConfigureResponse | BreakoutVideoMixesConfigureResponse | undefined>-
deleteVideoMix(opt) => Promise< | VideoMixesDeleteResponse | BreakoutVideoMixesDeleteResponse | undefined>-
sendMessage(opt) => Promise< | MessageConferenceResponse | MessageParticipantResponse | BreakoutMessageConferenceResponse | undefined>-
raiseHand(opt) => Promise<BuzzParticipantResponse | ClearbuzzParticipantResponse | undefined>-
lowerAllRaisedHands(opt) => Promise<ClearAllBuzzResponse | BreakoutClearAllBuzzResponse | undefined>-
spotlight(opt) => Promise< | SpotlightonParticipantResponse | SpotlightoffParticipantResponse | undefined>-
ack(opt) => Promise<AckResponse | undefined>-
update(opt) => Promise<UpdateResponse | undefined>-
newCandidate(opt) => Promise<NewCandidateResponse | undefined>-
sendOffer(opt) => Promise<CallsWebrtcParticipantResponse | undefined>-
takeFloor(opts) => Promise<TakeFloorResponse | undefined>-
releaseFloor(opts) => Promise<ReleaseFloorResponse | undefined>-
breakoutRequestGuestToken(opts) => Promise<BreakoutRequestGuestTokenResponse | undefined>-
present(stream?) => void-
restartCall(opts) => Promise<void>-
stopPresenting() => void-
setStream(stream) => void-
setBandwidth(bandwidth) => void-
setDegradationPreference(preference) => void-
liveCaptions(opt) => Promise< | ShowLiveCaptionsResponse | BreakoutShowLiveCaptionsResponse | HideLiveCaptionsResponse | BreakoutHideLiveCaptionsResponse | undefined>-
setRole(opt) => Promise<void>-
setConferenceExtension(conferenceExtension?) => void-
setPin(pin?) => void-
setSsoToken(ssoToken?) => void-
setToken(token) => void-
setCallTag(callTag) => void-
statistics(opt) => Promise<void>-
requestTheme(opt) => Promise<Result1 | undefined>-
setTextOverlay(opt) => Promise<OverlaytextParticipantResponse | undefined>-
sendDTMF(opt) => Promise<DtmfParticipantResponse | DtmfResponse | undefined>-
requestAspectRatio(opt) => Promise<PreferredAspectRatioResponse> | Promise<undefined>-
sendConferenceRequest(opt) => Promise< | { status: number; data: unknown; } | undefined>-
requestParticipants(opt) => Promise<ParticipantsResponse | undefined>Requests the current participant list from backend via 'participants' API call
breakout(opt) => Promise< | { breakout_uuid: RoomID; } | undefined>-
joinBreakoutRoom(opt) => Promise<void>-
guestLeaveBreakoutRoom() => Promise<GuestLeaveBreakoutResponse | undefined>-
closeBreakouts() => Promise<BreakoutsDisconnectResponse | undefined>-
closeBreakoutRoom(opt) => Promise<BreakoutDisconnectResponse | undefined>-
emptyBreakouts() => Promise<BreakoutsEmptyResponse | undefined>-
breakoutMoveParticipants(opt) => Promise<void>-
startConference(opt) => Promise<StartConferenceResponse | undefined>-
fecc(opt) => Promise<FeccParticipantResponse | FeccResponse | undefined>-
availableLayouts(opt) => Promise<(string | Result2)[] | undefined>-
layoutSvgs(opt) => Promise<Record<string, string> | undefined>-
presInMix(opt) => Promise<PresInMixParticipantResponse | undefined>-
breakoutAskForHelp(opt) => Promise<GuestBreakoutBuzzResponse | HostBreakoutBuzzResponse | undefined>-
breakoutRemoveAskForHelp(opt) => Promise< | GuestClearBreakoutBuzzResponse | (__namedParameters) => Promise<HostClearBreakoutBuzzResponse> | undefined>-
notifyNotAFK(opt) => Promise<NotifyNotAFKResponse | undefined>-

Methods

getMe()

getMe(roomId?): Participant | undefined;

Parameters

ParameterType
roomId?RoomID

Returns

Participant | undefined


getParticipants()

getParticipants(roomId): Participant[];

Parameters

ParameterType
roomIdRoomID

Returns

Participant[]


setFeccSupported()

setFeccSupported(canFecc): void;

Parameters

ParameterType
canFeccboolean

Returns

void


isBreakoutRoom()

isBreakoutRoom(roomId): boolean;

Parameters

ParameterType
roomIdRoomID

Returns

boolean