2020-03-19 05:50:05 +08:00
|
|
|
# Jitsi Wrapper
|
|
|
|
|
|
2020-03-20 01:45:17 +08:00
|
|
|
**Note**: These are developer docs. Please consult your client's documentation for
|
2020-03-19 05:50:05 +08:00
|
|
|
instructions on setting up Jitsi.
|
|
|
|
|
|
|
|
|
|
The react-sdk wraps all Jitsi call widgets in a local wrapper called `jitsi.html`
|
|
|
|
|
which takes several parameters:
|
|
|
|
|
|
|
|
|
|
_Query string_:
|
2022-12-12 19:24:14 +08:00
|
|
|
|
2020-03-19 05:50:05 +08:00
|
|
|
- `widgetId`: The ID of the widget. This is needed for communication back to the
|
|
|
|
|
react-sdk.
|
2020-03-20 01:45:17 +08:00
|
|
|
- `parentUrl`: The URL of the parent window. This is also needed for
|
2020-03-19 05:50:05 +08:00
|
|
|
communication back to the react-sdk.
|
2022-12-12 19:24:14 +08:00
|
|
|
|
2020-03-19 05:50:05 +08:00
|
|
|
_Hash/fragment (formatted as a query string)_:
|
2022-12-12 19:24:14 +08:00
|
|
|
|
2020-03-19 05:50:05 +08:00
|
|
|
- `conferenceDomain`: The domain to connect Jitsi Meet to.
|
|
|
|
|
- `conferenceId`: The room or conference ID to connect Jitsi Meet to.
|
|
|
|
|
- `isAudioOnly`: Boolean for whether this is a voice-only conference. May not
|
|
|
|
|
be present, should default to `false`.
|
2023-03-15 20:51:00 +08:00
|
|
|
- `startWithAudioMuted`: Boolean for whether the calls start with audio
|
|
|
|
|
muted. May not be present.
|
|
|
|
|
- `startWithVideoMuted`: Boolean for whether the calls start with video
|
|
|
|
|
muted. May not be present.
|
2020-03-19 05:50:05 +08:00
|
|
|
- `displayName`: The display name of the user viewing the widget. May not
|
|
|
|
|
be present or could be null.
|
|
|
|
|
- `avatarUrl`: The HTTP(S) URL for the avatar of the user viewing the widget. May
|
|
|
|
|
not be present or could be null.
|
|
|
|
|
- `userId`: The MXID of the user viewing the widget. May not be present or could
|
|
|
|
|
be null.
|
|
|
|
|
|
|
|
|
|
The react-sdk will assume that `jitsi.html` is at the path of wherever it is currently
|
2020-08-03 23:02:26 +08:00
|
|
|
being served. For example, `https://develop.element.io/jitsi.html` or `vector://webapp/jitsi.html`.
|
2020-03-19 05:50:05 +08:00
|
|
|
|
|
|
|
|
The `jitsi.html` wrapper can use the react-sdk's `WidgetApi` to communicate, making
|
|
|
|
|
it easier to actually implement the feature.
|
