Client

Properties

Property	Type	Description
roomId	RoomID	-
rooms	RoomID[]	-
breakoutRooms	Map<RoomID, BreakoutRoom>	-
breakoutRoomNames	Map<RoomID, string>	-
conferenceStatus	Map<RoomID, ConferenceStatus>	-
conferenceFeatureFlags?	ConferenceFeatureFlags	-
secureCheckCode	string	-
latestStats	Stats | undefined	-
serviceType	CurrentServiceType	-
isFeccEnabled	boolean	-
conferenceName	string | undefined	-
localCallType	ClientCallType	The callType that is being used for the current call
admit	(opt) => Promise<UnlockParticipantResponse	undefined>`
call	(opt) => Promise<RequestTokenResponse	undefined>`
disconnect	(opt) => Promise<void>	-
kick	(opt) => Promise<DisconnectParticipantResponse	undefined>`
dial	(opt) => Promise<DialResponse	undefined>`
transfer	(opt) => Promise<TransferParticipantResponse	undefined>`
mute	(opt) => Promise<MuteParticipantResponse	UnmuteParticipantResponse
clientMute	(opt) => Promise< | ClientMuteParticipantResponse | ClientUnmuteParticipantResponse | undefined>	-
guestsCanUnmute	(opt) => Promise<SetGuestsCanUnmuteResponse	undefined>`
muteAllGuests	(opt) => Promise<MuteguestsResponse	UnmuteguestsResponse
muteVideo	(opt) => Promise< | VideoMuteParticipantResponse | VideoUnmuteParticipantResponse | undefined>	-
lock	(opt) => Promise<LockResponse	UnlockResponse
disconnectAll	(opt) => Promise<DisconnectResponse	undefined>`
setLayout	(opt) => Promise<TransformLayoutResponse	undefined>`
setPersonalLayout	(opt) => Promise<VideoMixesConfigureResponse	undefined>`
deleteVideoMix	(opt) => Promise<VideoMixesDeleteResponse	undefined>`
sendMessage	(opt) => Promise<MessageConferenceResponse	MessageParticipantResponse
raiseHand	(opt) => Promise<BuzzParticipantResponse	ClearbuzzParticipantResponse
lowerAllRaisedHands	(opt) => Promise<ClearAllBuzzResponse	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	HideLiveCaptionsResponse
liveCaptionsLanguages	(opt) => Promise<LiveCaptionsLanguagesResponse	undefined>`
setRole	(opt) => Promise<void>	-
setConferenceExtension	(conferenceExtension?) => void	-
setPin	(pin?) => void	-
setSsoToken	(ssoToken?) => void	-
setToken	(token) => void	-
setCallTag	(callTag) => void	-
statistics	(opt) => Promise<void>	-
disconnectCall	(opt) => Promise<void>	-
requestTheme	(opt) => Promise<Result1	undefined>`
setTextOverlay	(opt) => Promise<OverlaytextParticipantResponse	undefined>`
sendDTMF	(opt) => Promise<DtmfParticipantResponse	DtmfResponse
requestAspectRatio	(opt) => Promise<PreferredAspectRatioResponse	undefined>`
sendConferenceRequest	(opt) => Promise< | { status: number; data: unknown; } | undefined>	-
requestParticipants	(opt) => Promise<ParticipantsResponse	undefined>`
breakout	(opt) => Promise< | { breakout_uuid: RoomID; } | undefined>	-
joinBreakoutRoom	(opt) => Promise<void>	-
guestLeaveBreakoutRoom	() => Promise<GuestLeaveBreakoutResponse	undefined>`
closeBreakouts	() => Promise<BreakoutsDisconnectResponse	undefined>`
closeBreakoutRoom	(opt) => Promise<DisconnectResponse	undefined>`
emptyBreakouts	() => Promise<BreakoutsEmptyResponse	undefined>`
breakoutMoveParticipants	(opt) => Promise< | BreakoutMoveParticipantsResponse | BreakoutMoveParticipantsFromMainResponse | undefined>	-
startConference	(opt) => Promise<StartConferenceResponse	undefined>`
fecc	(opt) => Promise<FeccParticipantResponse	FeccResponse
availableLayouts	(opt) => Promise<(string | Result2)[] | undefined>	-
layoutSvgs	(opt) => Promise<Record<string, string>	undefined>`
presInMix	(opt) => Promise<PresInMixParticipantResponse	undefined>`
breakoutAskForHelp	(opt) => Promise<GuestBreakoutBuzzResponse	HostBreakoutBuzzResponse
breakoutRemoveAskForHelp	(opt) => Promise< | GuestClearBreakoutBuzzResponse | (__namedParameters) => Promise<HostClearBreakoutBuzzResponse> | undefined>	-
notifyNotAFK	(opt) => Promise<NotifyNotAFKResponse	undefined>`

Methods

getMe()

getMe(roomId?): Participant | undefined;

Parameters

Parameter	Type
roomId?	RoomID

Returns

Participant | undefined

---

getParticipants()

getParticipants(roomId): Participant[];

Parameters

Parameter	Type
roomId	RoomID

Returns

Participant[]

---

setFeccSupported()

setFeccSupported(canFecc): void;

Parameters

Parameter	Type
canFecc	boolean

Returns

void

---

isBreakoutRoom()

isBreakoutRoom(roomId): boolean;

Parameters

Parameter	Type
roomId	RoomID

Returns

boolean