mirror of
https://github.com/vector-im/element-call.git
synced 2026-07-27 19:29:19 +00:00
@@ -38,7 +38,7 @@ The id used by the widget. The presence of this parameter implies that element
|
|||||||
call will not connect to a homeserver directly and instead tries to establish
|
call will not connect to a homeserver directly and instead tries to establish
|
||||||
postMessage communication via the `parentUrl`.
|
postMessage communication via the `parentUrl`.
|
||||||
|
|
||||||
```js
|
```ts
|
||||||
widgetId: string | null;
|
widgetId: string | null;
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -49,28 +49,28 @@ in an Iframe but in a dedicated webview we send the postMessages same webview
|
|||||||
the widget lives in. Filtering is done in the widget so it ignores the messages
|
the widget lives in. Filtering is done in the widget so it ignores the messages
|
||||||
it receives from itself)
|
it receives from itself)
|
||||||
|
|
||||||
```js
|
```ts
|
||||||
parentUrl: string | null;
|
parentUrl: string | null;
|
||||||
```
|
```
|
||||||
|
|
||||||
**userId**
|
**userId**
|
||||||
The user's ID (only used in matryoshka mode).
|
The user's ID (only used in matryoshka mode).
|
||||||
|
|
||||||
```js
|
```ts
|
||||||
userId: string | null;
|
userId: string | null;
|
||||||
```
|
```
|
||||||
|
|
||||||
**deviceId**
|
**deviceId**
|
||||||
The device's ID (only used in matryoshka mode).
|
The device's ID (only used in matryoshka mode).
|
||||||
|
|
||||||
```js
|
```ts
|
||||||
deviceId: string | null;
|
deviceId: string | null;
|
||||||
```
|
```
|
||||||
|
|
||||||
**baseUrl**
|
**baseUrl**
|
||||||
The base URL of the homeserver to use for media lookups in matryoshka mode.
|
The base URL of the homeserver to use for media lookups in matryoshka mode.
|
||||||
|
|
||||||
```js
|
```ts
|
||||||
baseUrl: string | null;
|
baseUrl: string | null;
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -83,14 +83,14 @@ roomId is an exception as we need the room ID in embedded (matroyska) mode, and
|
|||||||
the room alias (or even the via params because we are not trying to join it). This
|
the room alias (or even the via params because we are not trying to join it). This
|
||||||
is also not validated, where it is in useRoomIdentifier().
|
is also not validated, where it is in useRoomIdentifier().
|
||||||
|
|
||||||
```js
|
```ts
|
||||||
roomId: string | null;
|
roomId: string | null;
|
||||||
```
|
```
|
||||||
|
|
||||||
**confineToRoom**
|
**confineToRoom**
|
||||||
Whether the app should keep the user confined to the current call/room.
|
Whether the app should keep the user confined to the current call/room.
|
||||||
|
|
||||||
```js
|
```ts
|
||||||
confineToRoom: boolean; (default: false)
|
confineToRoom: boolean; (default: false)
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -98,7 +98,7 @@ confineToRoom: boolean; (default: false)
|
|||||||
Whether upon entering a room, the user should be prompted to launch the
|
Whether upon entering a room, the user should be prompted to launch the
|
||||||
native mobile app. (Affects only Android and iOS.)
|
native mobile app. (Affects only Android and iOS.)
|
||||||
|
|
||||||
```js
|
```ts
|
||||||
appPrompt: boolean; (default: true)
|
appPrompt: boolean; (default: true)
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -106,14 +106,14 @@ appPrompt: boolean; (default: true)
|
|||||||
Whether the app should pause before joining the call until it sees an
|
Whether the app should pause before joining the call until it sees an
|
||||||
io.element.join widget action, allowing it to be preloaded.
|
io.element.join widget action, allowing it to be preloaded.
|
||||||
|
|
||||||
```js
|
```ts
|
||||||
preload: boolean; (default: false)
|
preload: boolean; (default: false)
|
||||||
```
|
```
|
||||||
|
|
||||||
**hideHeader**
|
**hideHeader**
|
||||||
Whether to hide the room header when in a call.
|
Whether to hide the room header when in a call.
|
||||||
|
|
||||||
```js
|
```ts
|
||||||
hideHeader: boolean; (default: false)
|
hideHeader: boolean; (default: false)
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -121,14 +121,14 @@ hideHeader: boolean; (default: false)
|
|||||||
Whether to show the buttons to mute, screen-share, invite, hangup are shown
|
Whether to show the buttons to mute, screen-share, invite, hangup are shown
|
||||||
when in a call.
|
when in a call.
|
||||||
|
|
||||||
```js
|
```ts
|
||||||
showControls: boolean; (default: true)
|
showControls: boolean; (default: true)
|
||||||
```
|
```
|
||||||
|
|
||||||
**hideScreensharing**
|
**hideScreensharing**
|
||||||
Whether to hide the screen-sharing button.
|
Whether to hide the screen-sharing button.
|
||||||
|
|
||||||
```js
|
```ts
|
||||||
hideScreensharing: boolean; (default: false)
|
hideScreensharing: boolean; (default: false)
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -136,7 +136,7 @@ hideScreensharing: boolean; (default: false)
|
|||||||
Whether to use end-to-end encryption. This is a legacy flag for the full mesh branch.
|
Whether to use end-to-end encryption. This is a legacy flag for the full mesh branch.
|
||||||
It is not used on the livekit branch and has no impact there!
|
It is not used on the livekit branch and has no impact there!
|
||||||
|
|
||||||
```js
|
```ts
|
||||||
enableE2EE: boolean; (default: true)
|
enableE2EE: boolean; (default: true)
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -144,7 +144,7 @@ enableE2EE: boolean; (default: true)
|
|||||||
Whether to use per participant encryption.
|
Whether to use per participant encryption.
|
||||||
Keys will be exchanged over encrypted matrix room messages.
|
Keys will be exchanged over encrypted matrix room messages.
|
||||||
|
|
||||||
```js
|
```ts
|
||||||
perParticipantE2EE: boolean; (default: false)
|
perParticipantE2EE: boolean; (default: false)
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -152,21 +152,21 @@ perParticipantE2EE: boolean; (default: false)
|
|||||||
E2EE password when using a shared secret.
|
E2EE password when using a shared secret.
|
||||||
(For individual sender keys in embedded mode this is not required.)
|
(For individual sender keys in embedded mode this is not required.)
|
||||||
|
|
||||||
```js
|
```ts
|
||||||
password: string | null;
|
password: string | null;
|
||||||
```
|
```
|
||||||
|
|
||||||
**displayName**
|
**displayName**
|
||||||
The display name to use for auto-registration.
|
The display name to use for auto-registration.
|
||||||
|
|
||||||
```js
|
```ts
|
||||||
displayName: string | null;
|
displayName: string | null;
|
||||||
```
|
```
|
||||||
|
|
||||||
**lang**
|
**lang**
|
||||||
The BCP 47 code of the language the app should use.
|
The BCP 47 code of the language the app should use.
|
||||||
|
|
||||||
```js
|
```ts
|
||||||
lang: string | null;
|
lang: string | null;
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -174,7 +174,7 @@ lang: string | null;
|
|||||||
The font/fonts which the interface should use.
|
The font/fonts which the interface should use.
|
||||||
There can be multiple font url parameters: `?font=font-one&font=font-two...`
|
There can be multiple font url parameters: `?font=font-one&font=font-two...`
|
||||||
|
|
||||||
```js
|
```ts
|
||||||
font: string;
|
font: string;
|
||||||
font: string;
|
font: string;
|
||||||
...
|
...
|
||||||
@@ -183,7 +183,7 @@ font: string;
|
|||||||
**fontScale**
|
**fontScale**
|
||||||
The factor by which to scale the interface's font size.
|
The factor by which to scale the interface's font size.
|
||||||
|
|
||||||
```js
|
```ts
|
||||||
fontScale: number | null;
|
fontScale: number | null;
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -191,7 +191,7 @@ fontScale: number | null;
|
|||||||
The Posthog analytics ID. It is only available if the user has given consent for
|
The Posthog analytics ID. It is only available if the user has given consent for
|
||||||
sharing telemetry in element web.
|
sharing telemetry in element web.
|
||||||
|
|
||||||
```js
|
```ts
|
||||||
analyticsID: string | null;
|
analyticsID: string | null;
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -199,7 +199,7 @@ analyticsID: string | null;
|
|||||||
Whether the app is allowed to use fallback STUN servers for ICE in case the
|
Whether the app is allowed to use fallback STUN servers for ICE in case the
|
||||||
user's homeserver doesn't provide any.
|
user's homeserver doesn't provide any.
|
||||||
|
|
||||||
```js
|
```ts
|
||||||
allowIceFallback: boolean; (default: false)
|
allowIceFallback: boolean; (default: false)
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -208,7 +208,7 @@ Setting this flag skips the lobby and brings you in the call directly.
|
|||||||
In the widget this can be combined with preload to pass the device settings
|
In the widget this can be combined with preload to pass the device settings
|
||||||
with the join widget action.
|
with the join widget action.
|
||||||
|
|
||||||
```js
|
```ts
|
||||||
skipLobby: boolean; (default: false)
|
skipLobby: boolean; (default: false)
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -218,7 +218,7 @@ a call.
|
|||||||
This is useful for video rooms.
|
This is useful for video rooms.
|
||||||
If set to false, the widget will show a blank page after leaving the call.
|
If set to false, the widget will show a blank page after leaving the call.
|
||||||
|
|
||||||
```js
|
```ts
|
||||||
returnToLobby: boolean; (default: false)
|
returnToLobby: boolean; (default: false)
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -227,7 +227,7 @@ The theme to use for element call.
|
|||||||
can be "light", "dark", "light-high-contrast" or "dark-high-contrast".
|
can be "light", "dark", "light-high-contrast" or "dark-high-contrast".
|
||||||
If not set element call will use the dark theme.
|
If not set element call will use the dark theme.
|
||||||
|
|
||||||
```js
|
```ts
|
||||||
theme: string | null;
|
theme: string | null;
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -237,7 +237,7 @@ It has to be set to a non default value for links to rooms
|
|||||||
that are not on the default homeserver,
|
that are not on the default homeserver,
|
||||||
that is in use for the current user.
|
that is in use for the current user.
|
||||||
|
|
||||||
```js
|
```ts
|
||||||
viaServers: string; (default: undefined)
|
viaServers: string; (default: undefined)
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -247,6 +247,6 @@ a new (guest) user.
|
|||||||
This can be user to configure a non default guest user server when
|
This can be user to configure a non default guest user server when
|
||||||
creating a spa link.
|
creating a spa link.
|
||||||
|
|
||||||
```js
|
```ts
|
||||||
homeserver: string; (default: undefined)
|
homeserver: string; (default: undefined)
|
||||||
```
|
```
|
||||||
|
|||||||
Reference in New Issue
Block a user