call module
Used to interact with call functionality, including starting calls with other users.
Interfaces
| StartCallParams |
Represents parameters for StartCall. |
Enums
| CallModalities |
Modalities that can be associated with a call. |
Functions
| is |
Checks if the call capability is supported by the host |
| start |
Starts a call with other users |
Function Details
isSupported()
Checks if the call capability is supported by the host
function isSupported(): booleanReturns
boolean
boolean to represent whether the call capability is supported
startCall(StartCallParams)
Starts a call with other users
function startCall(startCallParams: StartCallParams): Promise<boolean>Parameters
- startCallParams
- StartCallParams
Parameters for the call
Returns
Promise<boolean>
always true if the host notifies of a successful call inititation