Interface: Calls
Defined in: packages/calls/src/calls.ts:150
Methods
answer()
answer(id, options?): Promise<void>;Defined in: packages/calls/src/calls.ts:158
Parameters
| Parameter | Type |
|---|---|
id | string |
options? | CallOptions |
Returns
Promise<void>
close()
close(): Promise<void>;Defined in: packages/calls/src/calls.ts:169
Leaves any call and stops listening
Returns
Promise<void>
decline()
decline(id): Promise<void>;Defined in: packages/calls/src/calls.ts:159
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
Promise<void>
forgetRejoin()
forgetRejoin(): void;Defined in: packages/calls/src/calls.ts:167
Stops offering rejoin
Returns
void
getState()
getState(this): CallsState;Defined in: packages/calls/src/calls.ts:152
What's going on now. The same object until something changes.
Parameters
| Parameter | Type |
|---|---|
this | void |
Returns
leave()
leave(): Promise<void>;Defined in: packages/calls/src/calls.ts:160
Returns
Promise<void>
ring()
ring(
space,
account,
options?
): Promise<void>;Defined in: packages/calls/src/calls.ts:157
Starts a call in a space, and rings one person there — all their devices, until one answers
Parameters
| Parameter | Type |
|---|---|
space | string |
account | string |
options? | CallOptions |
Returns
Promise<void>
setCamera()
setCamera(on): Promise<void>;Defined in: packages/calls/src/calls.ts:162
Parameters
| Parameter | Type |
|---|---|
on | boolean |
Returns
Promise<void>
setMuted()
setMuted(muted): void;Defined in: packages/calls/src/calls.ts:161
Parameters
| Parameter | Type |
|---|---|
muted | boolean |
Returns
void
shareScreen()
shareScreen(): Promise<void>;Defined in: packages/calls/src/calls.ts:164
Shows your screen in place of your camera, until you stop it (or the browser does)
Returns
Promise<void>
start()
start(space, options?): Promise<void>;Defined in: packages/calls/src/calls.ts:155
Joins the call going on in a space, or starts one. Leaves any other call first.
Parameters
| Parameter | Type |
|---|---|
space | string |
options? | CallOptions & object |
Returns
Promise<void>
stopSharing()
stopSharing(): Promise<void>;Defined in: packages/calls/src/calls.ts:165
Returns
Promise<void>
subscribe()
subscribe(this, listener): () => void;Defined in: packages/calls/src/calls.ts:153
Parameters
| Parameter | Type |
|---|---|
this | void |
listener | () => void |
Returns
() => void