ApiCallsInterfaces
Interface: CallsOptions
Defined in: packages/calls/src/calls.ts:50
Options for createCalls and CallsProvider. Rarely needed but in tests.
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
createConnection? | readonly | (config) => RTCPeerConnection | How a WebRTC connection is made. new RTCPeerConnection by default. | packages/calls/src/calls.ts:52 |
createStream? | readonly | (tracks) => MediaStream | null | How a set of tracks becomes something a <video> can show. new MediaStream by default. | packages/calls/src/calls.ts:58 |
getDisplayMedia? | readonly | (constraints) => Promise<MediaStream> | The screen, for sharing it. navigator.mediaDevices.getDisplayMedia by default. | packages/calls/src/calls.ts:56 |
getUserMedia? | readonly | (constraints) => Promise<MediaStream> | Camera and microphone. navigator.mediaDevices.getUserMedia by default. | packages/calls/src/calls.ts:54 |
goneMs? | readonly | number | How long without hearing that someone is gone. Default 15 s. | packages/calls/src/calls.ts:64 |
heartbeatMs? | readonly | number | How often you say you're in a call. Default 5 s. | packages/calls/src/calls.ts:62 |
ringMs? | readonly | number | How long a ring rings before it's a missed call. Default 45 s. | packages/calls/src/calls.ts:66 |
storage? | readonly | | Pick<Storage, "getItem" | "setItem" | "removeItem"> | null | Where the call you're in is remembered, to offer rejoining after a reload. sessionStorage by default, under minca-call; null for nowhere. | packages/calls/src/calls.ts:60 |