Interface: Client

Properties

ack

• ack: (opt: { breakoutUuid?: string ; callUuid?: string ; conferenceAlias?: string ; host?: string ; offerIgnored?: boolean ; participantUuid?: string ; sdp?: string }) => Promise<undefined | AckResponse>

Type declaration

▸ (opt): Promise<undefined | AckResponse>

Parameters

Name	Type
`opt`	`Object`
`opt.breakoutUuid?`	`string`
`opt.callUuid?`	`string`
`opt.conferenceAlias?`	`string`
`opt.host?`	`string`
`opt.offerIgnored?`	`boolean`
`opt.participantUuid?`	`string`
`opt.sdp?`	`string`

Returns

Promise<undefined | AckResponse>

admit

• admit: (opt: { conferenceAlias?: string ; host?: string ; participantUuid: string }) => Promise<undefined | UnlockParticipantResponse>

Type declaration

▸ (opt): Promise<undefined | UnlockParticipantResponse>

Parameters

Name	Type
`opt`	`Object`
`opt.conferenceAlias?`	`string`
`opt.host?`	`string`
`opt.participantUuid`	`string`

Returns

Promise<undefined | UnlockParticipantResponse>

breakout

• breakout: (opt: TopLevel) => Promise<undefined | { breakout_uuid: string }>

Type declaration

▸ (opt): Promise<undefined | { breakout_uuid: string }>

Parameters

Name	Type
`opt`	`TopLevel`

Returns

Promise<undefined | { breakout_uuid: string }>

breakoutMoveParticipants

• breakoutMoveParticipants: (opt: { fromBreakoutUuid?: string ; participants: string[] ; toRoomUuid: string }) => Promise<void>

Type declaration

▸ (opt): Promise<void>

Parameters

Name	Type
`opt`	`Object`
`opt.fromBreakoutUuid?`	`string`
`opt.participants`	`string`[]
`opt.toRoomUuid`	`string`

Returns

Promise<void>

breakoutRooms

• breakoutRooms: Map<string, BreakoutRoom>

call

• call: (opt: { bandwidth: number ; callTag?: string ; callType: ClientCallType ; chosenIdp?: string ; conferenceAlias: string ; conferenceExtension?: string ; directMedia?: boolean ; displayName: string ; host?: string ; mediaStream?: MediaStream ; node?: string ; pin?: string ; ssoToken?: string ; token?: string }) => Promise<undefined | RequestTokenResponse>

Type declaration

▸ (opt): Promise<undefined | RequestTokenResponse>

Parameters

Name	Type
`opt`	`Object`
`opt.bandwidth`	`number`
`opt.callTag?`	`string`
`opt.callType`	`ClientCallType`
`opt.chosenIdp?`	`string`
`opt.conferenceAlias`	`string`
`opt.conferenceExtension?`	`string`
`opt.directMedia?`	`boolean`
`opt.displayName`	`string`
`opt.host?`	`string`
`opt.mediaStream?`	`MediaStream`
`opt.node?`	`string`
`opt.pin?`	`string`
`opt.ssoToken?`	`string`
`opt.token?`	`string`

Returns

Promise<undefined | RequestTokenResponse>

closeBreakoutRoom

• closeBreakoutRoom: (opt: { breakoutUuid: string }) => Promise<undefined | BreakoutDisconnectResponse>

Type declaration

▸ (opt): Promise<undefined | BreakoutDisconnectResponse>

Parameters

Name	Type
`opt`	`Object`
`opt.breakoutUuid`	`string`

Returns

Promise<undefined | BreakoutDisconnectResponse>

closeBreakouts

• closeBreakouts: () => Promise<void>

Type declaration

▸ (): Promise<void>

Returns

Promise<void>

conferenceFeatureFlags

• Optional conferenceFeatureFlags: ConferenceFeatureFlags

conferenceStatus

• conferenceStatus: Map<string, ConferenceStatus>

dial

• dial: (opt: { conferenceAlias?: string ; destination: string ; host?: string ; protocol?: "sip" | "h323" | "rtmp" | "mssip" | "auto" ; role: "HOST" | "GUEST" ; streaming?: "yes" | "no" }) => Promise<undefined | DialResponse>

Type declaration

▸ (opt): Promise<undefined | DialResponse>

Parameters

Name	Type
`opt`	`Object`
`opt.conferenceAlias?`	`string`
`opt.destination`	`string`
`opt.host?`	`string`
`opt.protocol?`	`"sip"` \| `"h323"` \| `"rtmp"` \| `"mssip"` \| `"auto"`
`opt.role`	`"HOST"` \| `"GUEST"`
`opt.streaming?`	`"yes"` \| `"no"`

Returns

Promise<undefined | DialResponse>

disconnect

• disconnect: (opt: { breakoutUuid?: string ; callUuid?: string ; callback?: () => void ; conferenceAlias?: string ; host?: string ; participantUuid?: string ; reason?: DisconnectReason ; release?: () => Promise<void> }) => Promise<void>

Type declaration

▸ (opt): Promise<void>

Parameters

Name	Type
`opt`	`Object`
`opt.breakoutUuid?`	`string`
`opt.callUuid?`	`string`
`opt.callback?`	() => `void`
`opt.conferenceAlias?`	`string`
`opt.host?`	`string`
`opt.participantUuid?`	`string`
`opt.reason?`	`DisconnectReason`
`opt.release?`	() => `Promise`<`void`>

Returns

Promise<void>

disconnectAll

• disconnectAll: (opt: { conferenceAlias?: string ; host?: string }) => Promise<undefined | DisconnectResponse>

Type declaration

▸ (opt): Promise<undefined | DisconnectResponse>

Parameters

Name	Type
`opt`	`Object`
`opt.conferenceAlias?`	`string`
`opt.host?`	`string`

Returns

Promise<undefined | DisconnectResponse>

joinBreakoutRoom

• joinBreakoutRoom: (opt: { breakoutUuid?: string }) => Promise<void>

Type declaration

▸ (opt): Promise<void>

Parameters

Name	Type
`opt`	`Object`
`opt.breakoutUuid?`	`string`

Returns

Promise<void>

kick

• kick: (opt: { conferenceAlias?: string ; host?: string ; participantUuid: string }) => Promise<undefined | DisconnectParticipantResponse>

Type declaration

▸ (opt): Promise<undefined | DisconnectParticipantResponse>

Parameters

Name	Type
`opt`	`Object`
`opt.conferenceAlias?`	`string`
`opt.host?`	`string`
`opt.participantUuid`	`string`

Returns

Promise<undefined | DisconnectParticipantResponse>

latestStats

• latestStats: undefined | Stats

liveCaptions

• liveCaptions: (opt: { breakoutUuid?: string ; conferenceAlias?: string ; enable: boolean ; participantUuid?: string }) => Promise<undefined | ShowLiveCaptionsResponse | BreakoutShowLiveCaptionsResponse | HideLiveCaptionsResponse | BreakoutHideLiveCaptionsResponse>

Type declaration

▸ (opt): Promise<undefined | ShowLiveCaptionsResponse | BreakoutShowLiveCaptionsResponse | HideLiveCaptionsResponse | BreakoutHideLiveCaptionsResponse>

Parameters

Name	Type
`opt`	`Object`
`opt.breakoutUuid?`	`string`
`opt.conferenceAlias?`	`string`
`opt.enable`	`boolean`
`opt.participantUuid?`	`string`

Returns

Promise<undefined | ShowLiveCaptionsResponse | BreakoutShowLiveCaptionsResponse | HideLiveCaptionsResponse | BreakoutHideLiveCaptionsResponse>

lock

• lock: (opt: { conferenceAlias?: string ; host?: string ; lock: boolean }) => Promise<undefined | LockResponse | UnlockResponse>

Type declaration

▸ (opt): Promise<undefined | LockResponse | UnlockResponse>

Parameters

Name	Type
`opt`	`Object`
`opt.conferenceAlias?`	`string`
`opt.host?`	`string`
`opt.lock`	`boolean`

Returns

Promise<undefined | LockResponse | UnlockResponse>

me

• Optional me: Participant

mute

• mute: (opt: { conferenceAlias?: string ; host?: string ; mute: boolean ; participantUuid?: string }) => Promise<undefined | MuteParticipantResponse | UnmuteParticipantResponse>

Type declaration

▸ (opt): Promise<undefined | MuteParticipantResponse | UnmuteParticipantResponse>

Parameters

Name	Type
`opt`	`Object`
`opt.conferenceAlias?`	`string`
`opt.host?`	`string`
`opt.mute`	`boolean`
`opt.participantUuid?`	`string`

Returns

Promise<undefined | MuteParticipantResponse | UnmuteParticipantResponse>

muteAllGuests

• muteAllGuests: (opt: { conferenceAlias?: string ; host?: string ; mute: boolean }) => Promise<undefined | MuteguestsResponse | UnmuteguestsResponse>

Type declaration

▸ (opt): Promise<undefined | MuteguestsResponse | UnmuteguestsResponse>

Parameters

Name	Type
`opt`	`Object`
`opt.conferenceAlias?`	`string`
`opt.host?`	`string`
`opt.mute`	`boolean`

Returns

Promise<undefined | MuteguestsResponse | UnmuteguestsResponse>

muteVideo

• muteVideo: (opt: { conferenceAlias?: string ; host?: string ; muteVideo: boolean ; participantUuid?: string }) => Promise<undefined | VideoMuteParticipantResponse | VideoUnmuteParticipantResponse>

Type declaration

▸ (opt): Promise<undefined | VideoMuteParticipantResponse | VideoUnmuteParticipantResponse>

Parameters

Name	Type
`opt`	`Object`
`opt.conferenceAlias?`	`string`
`opt.host?`	`string`
`opt.muteVideo`	`boolean`
`opt.participantUuid?`	`string`

Returns

Promise<undefined | VideoMuteParticipantResponse | VideoUnmuteParticipantResponse>

newCandidate

• newCandidate: (opt: { breakoutUuid?: string ; callUuid?: string ; candidate: IceCandidate ; conferenceAlias?: string ; host?: string ; participantUuid?: string }) => Promise<undefined | NewCandidateResponse>

Type declaration

▸ (opt): Promise<undefined | NewCandidateResponse>

Parameters

Name	Type
`opt`	`Object`
`opt.breakoutUuid?`	`string`
`opt.callUuid?`	`string`
`opt.candidate`	`IceCandidate`
`opt.conferenceAlias?`	`string`
`opt.host?`	`string`
`opt.participantUuid?`	`string`

Returns

Promise<undefined | NewCandidateResponse>

present

• present: (stream?: MediaStream) => void

Type declaration

▸ (stream?): void

Parameters

Name	Type
`stream?`	`MediaStream`

Returns

void

raiseHand

• raiseHand: (opt: { conferenceAlias?: string ; host?: string ; participantUuid?: string ; raise: boolean }) => Promise<undefined | BuzzParticipantResponse | ClearbuzzParticipantResponse>

Type declaration

▸ (opt): Promise<undefined | BuzzParticipantResponse | ClearbuzzParticipantResponse>

Parameters

Name	Type
`opt`	`Object`
`opt.conferenceAlias?`	`string`
`opt.host?`	`string`
`opt.participantUuid?`	`string`
`opt.raise`	`boolean`

Returns

Promise<undefined | BuzzParticipantResponse | ClearbuzzParticipantResponse>

releaseFloor

• releaseFloor: (opts: { breakoutUuid?: string ; conferenceAlias?: string ; host?: string ; participantUuid?: string }) => Promise<undefined | ReleaseFloorResponse>

Type declaration

▸ (opts): Promise<undefined | ReleaseFloorResponse>

Parameters

Name	Type
`opts`	`Object`
`opts.breakoutUuid?`	`string`
`opts.conferenceAlias?`	`string`
`opts.host?`	`string`
`opts.participantUuid?`	`string`

Returns

Promise<undefined | ReleaseFloorResponse>

requestAspectRatio

• requestAspectRatio: (opt: { aspectRatio: number ; conferenceAlias?: string ; host?: string ; participantUuid?: string }) => Promise<undefined | PreferredAspectRatioResponse>

Type declaration

▸ (opt): Promise<undefined | PreferredAspectRatioResponse>

Parameters

Name	Type
`opt`	`Object`
`opt.aspectRatio`	`number`
`opt.conferenceAlias?`	`string`
`opt.host?`	`string`
`opt.participantUuid?`	`string`

Returns

Promise<undefined | PreferredAspectRatioResponse>

requestTheme

• requestTheme: (opt: { conferenceAlias?: string ; host?: string }) => Promise<undefined | Result1>

Type declaration

▸ (opt): Promise<undefined | Result1>

Parameters

Name	Type
`opt`	`Object`
`opt.conferenceAlias?`	`string`
`opt.host?`	`string`

Returns

Promise<undefined | Result1>

restartCall

• restartCall: (opts: { bandwidth: number ; callType?: ClientCallType ; mediaStream?: MediaStream }) => Promise<void>

Type declaration

▸ (opts): Promise<void>

Parameters

Name	Type
`opts`	`Object`
`opts.bandwidth`	`number`
`opts.callType?`	`ClientCallType`
`opts.mediaStream?`	`MediaStream`

Returns

Promise<void>

roomId

• roomId: string

secureCheckCode

• secureCheckCode: string

sendConferenceRequest

• sendConferenceRequest: (opt: { method: "GET" | "POST" ; path: string ; payload?: Record<string, unknown> }) => Promise<undefined | { data: unknown ; status: number }>

Type declaration

▸ (opt): Promise<undefined | { data: unknown ; status: number }>

Parameters

Name	Type
`opt`	`Object`
`opt.method`	`"GET"` \| `"POST"`
`opt.path`	`string`
`opt.payload?`	`Record`<`string`, `unknown`>

Returns

Promise<undefined | { data: unknown ; status: number }>

sendDTMF

• sendDTMF: (opt: { callUuid?: string ; conferenceAlias?: string ; digits: string ; host?: string ; participantUuid?: string }) => Promise<undefined | DtmfParticipantResponse | DtmfResponse>

Type declaration

▸ (opt): Promise<undefined | DtmfParticipantResponse | DtmfResponse>

Parameters

Name	Type
`opt`	`Object`
`opt.callUuid?`	`string`
`opt.conferenceAlias?`	`string`
`opt.digits`	`string`
`opt.host?`	`string`
`opt.participantUuid?`	`string`

Returns

Promise<undefined | DtmfParticipantResponse | DtmfResponse>

sendMessage

• sendMessage: (opt: TopLevel1 & { conferenceAlias?: string ; host?: string ; participantUuid?: string }) => Promise<undefined | MessageConferenceResponse | MessageParticipantResponse>

Type declaration

▸ (opt): Promise<undefined | MessageConferenceResponse | MessageParticipantResponse>

Parameters

Name	Type
`opt`	`TopLevel1` & { `conferenceAlias?`: `string` ; `host?`: `string` ; `participantUuid?`: `string` }

Returns

Promise<undefined | MessageConferenceResponse | MessageParticipantResponse>

sendOffer

• sendOffer: (opt: { breakoutUuid?: string ; conferenceAlias?: string ; host?: string ; participantUuid?: string ; sdp: string }) => Promise<undefined | CallsWebrtcParticipantResponse>

Type declaration

▸ (opt): Promise<undefined | CallsWebrtcParticipantResponse>

Parameters

Name	Type
`opt`	`Object`
`opt.breakoutUuid?`	`string`
`opt.conferenceAlias?`	`string`
`opt.host?`	`string`
`opt.participantUuid?`	`string`
`opt.sdp`	`string`

Returns

Promise<undefined | CallsWebrtcParticipantResponse>

serviceType

• serviceType: CurrentServiceType

setBandwidth

• setBandwidth: (bandwidth: number) => void

Type declaration

▸ (bandwidth): void

Parameters

Name	Type
`bandwidth`	`number`

Returns

void

setCallTag

• setCallTag: (callTag: string) => void

Type declaration

▸ (callTag): void

Parameters

Name	Type
`callTag`	`string`

Returns

void

setConferenceExtension

• setConferenceExtension: (conferenceExtension?: string) => void

Type declaration

▸ (conferenceExtension?): void

Parameters

Name	Type
`conferenceExtension?`	`string`

Returns

void

setLayout

• setLayout: (opt: { conferenceAlias?: string ; host?: string ; transforms: Transforms }) => Promise<undefined | TransformLayoutResponse>

Type declaration

▸ (opt): Promise<undefined | TransformLayoutResponse>

Parameters

Name	Type
`opt`	`Object`
`opt.conferenceAlias?`	`string`
`opt.host?`	`string`
`opt.transforms`	`Transforms`

Returns

Promise<undefined | TransformLayoutResponse>

setParticipantRoom

• setParticipantRoom: (opt: { conferenceAlias?: string ; host?: string ; participantUuid: string ; roomId: number }) => Promise<undefined | RoomResponse>

Type declaration

▸ (opt): Promise<undefined | RoomResponse>

Parameters

Name	Type
`opt`	`Object`
`opt.conferenceAlias?`	`string`
`opt.host?`	`string`
`opt.participantUuid`	`string`
`opt.roomId`	`number`

Returns

Promise<undefined | RoomResponse>

setPin

• setPin: (pin?: string) => void

Type declaration

▸ (pin?): void

Parameters

Name	Type
`pin?`	`string`

Returns

void

setRole

• setRole: (opt: { conferenceAlias?: string ; participantUuid: string ; role: "guest" | "chair" }) => Promise<void>

Type declaration

▸ (opt): Promise<void>

Parameters

Name	Type
`opt`	`Object`
`opt.conferenceAlias?`	`string`
`opt.participantUuid`	`string`
`opt.role`	`"guest"` \| `"chair"`

Returns

Promise<void>

setStream

• setStream: (stream: MediaStream) => void

Type declaration

▸ (stream): void

Parameters

Name	Type
`stream`	`MediaStream`

Returns

void

setTextOverlay

• setTextOverlay: (opt: TopLevel3 & { conferenceAlias?: string ; host?: string ; participantUuid: string }) => Promise<undefined | OverlaytextParticipantResponse>

Type declaration

▸ (opt): Promise<undefined | OverlaytextParticipantResponse>

Parameters

Name	Type
`opt`	`TopLevel3` & { `conferenceAlias?`: `string` ; `host?`: `string` ; `participantUuid`: `string` }

Returns

Promise<undefined | OverlaytextParticipantResponse>

spotlight

• spotlight: (opt: { conferenceAlias?: string ; enable: boolean ; host?: string ; participantUuid: string }) => Promise<undefined | SpotlightonParticipantResponse | SpotlightoffParticipantResponse>

Type declaration

▸ (opt): Promise<undefined | SpotlightonParticipantResponse | SpotlightoffParticipantResponse>

Parameters

Name	Type
`opt`	`Object`
`opt.conferenceAlias?`	`string`
`opt.enable`	`boolean`
`opt.host?`	`string`
`opt.participantUuid`	`string`

Returns

Promise<undefined | SpotlightonParticipantResponse | SpotlightoffParticipantResponse>

statistics

• statistics: (opt: { audio?: Stream ; callUuid?: string ; conferenceAlias?: string ; host?: string ; participantUuid?: string ; presentation?: Stream ; video?: Stream }) => Promise<void>

Type declaration

▸ (opt): Promise<void>

Parameters

Name	Type
`opt`	`Object`
`opt.audio?`	`Stream`
`opt.callUuid?`	`string`
`opt.conferenceAlias?`	`string`
`opt.host?`	`string`
`opt.participantUuid?`	`string`
`opt.presentation?`	`Stream`
`opt.video?`	`Stream`

Returns

Promise<void>

stopPresenting

• stopPresenting: () => void

Type declaration

▸ (): void

Returns

void

takeFloor

• takeFloor: (opts: { breakoutUuid?: string ; conferenceAlias?: string ; host?: string ; participantUuid?: string }) => Promise<undefined | TakeFloorResponse>

Type declaration

▸ (opts): Promise<undefined | TakeFloorResponse>

Parameters

Name	Type
`opts`	`Object`
`opts.breakoutUuid?`	`string`
`opts.conferenceAlias?`	`string`
`opts.host?`	`string`
`opts.participantUuid?`	`string`

Returns

Promise<undefined | TakeFloorResponse>

transfer

• transfer: (opt: { conferenceAlias?: string ; destination: string ; host?: string ; participantUuid: string ; pin: string ; role: "host" | "guest" }) => Promise<undefined | TransferParticipantResponse>

Type declaration

▸ (opt): Promise<undefined | TransferParticipantResponse>

Parameters

Name	Type
`opt`	`Object`
`opt.conferenceAlias?`	`string`
`opt.destination`	`string`
`opt.host?`	`string`
`opt.participantUuid`	`string`
`opt.pin`	`string`
`opt.role`	`"host"` \| `"guest"`

Returns

Promise<undefined | TransferParticipantResponse>

update

• update: (opt: { abortSignal?: AbortSignal ; breakoutUuid?: string ; callUuid?: string ; conferenceAlias?: string ; host?: string ; participantUuid?: string ; sdp: string }) => Promise<undefined | UpdateResponse>

Type declaration

▸ (opt): Promise<undefined | UpdateResponse>

Parameters

Name	Type
`opt`	`Object`
`opt.abortSignal?`	`AbortSignal`
`opt.breakoutUuid?`	`string`
`opt.callUuid?`	`string`
`opt.conferenceAlias?`	`string`
`opt.host?`	`string`
`opt.participantUuid?`	`string`
`opt.sdp`	`string`

Returns

Promise<undefined | UpdateResponse>

Methods

getParticipants

▸ getParticipants(roomId): Participant[]

Parameters

Name	Type
`roomId`	`string`

Returns

Participant[]

Properties​

ack​

Type declaration​

Parameters​

Returns​

admit​

Type declaration​

Parameters​

Returns​

breakout​

Type declaration​

Parameters​

Returns​

breakoutMoveParticipants​

Type declaration​

Parameters​

Returns​

breakoutRooms​

call​

Type declaration​

Parameters​

Returns​

closeBreakoutRoom​

Type declaration​

Parameters​

Returns​

closeBreakouts​

Type declaration​

Returns​

conferenceFeatureFlags​

conferenceStatus​

dial​

Type declaration​

Parameters​

Returns​

disconnect​

Type declaration​

Parameters​

Returns​

disconnectAll​

Type declaration​

Parameters​

Returns​

joinBreakoutRoom​

Type declaration​

Parameters​

Returns​

kick​

Type declaration​

Parameters​

Returns​

latestStats​

liveCaptions​

Type declaration​

Parameters​

Returns​

lock​

Type declaration​

Parameters​

Returns​

me​

mute​

Type declaration​

Parameters​

Returns​

muteAllGuests​

Type declaration​

Parameters​

Returns​

muteVideo​

Type declaration​

Parameters​

Returns​

newCandidate​

Type declaration​

Parameters​

Returns​

present​

Type declaration​

Parameters​

Properties

ack

Type declaration

Parameters

Returns

admit

Type declaration

Parameters

Returns

breakout

Type declaration

Parameters

Returns

breakoutMoveParticipants

Type declaration

Parameters

Returns

breakoutRooms

call

Type declaration

Parameters

Returns

closeBreakoutRoom

Type declaration

Parameters

Returns

closeBreakouts

Type declaration

Returns

conferenceFeatureFlags

conferenceStatus

dial

Type declaration

Parameters

Returns

disconnect

Type declaration

Parameters

Returns

disconnectAll

Type declaration

Parameters

Returns

joinBreakoutRoom

Type declaration

Parameters

Returns

kick

Type declaration

Parameters

Returns

latestStats

liveCaptions

Type declaration

Parameters

Returns

lock

Type declaration

Parameters

Returns

me

mute

Type declaration

Parameters

Returns

muteAllGuests

Type declaration

Parameters

Returns

muteVideo

Type declaration

Parameters

Returns

newCandidate

Type declaration

Parameters

Returns

present

Type declaration

Parameters