mirrors/element-web
1
0
Fork 0
mirror of https://github.com/element-hq/element-web synced 2024-10-23 19:25:48 +03:00
Code Issues Projects Releases Packages Wiki Activity
element-web/docs/jitsi.md
J. Ryan Stinnett ce226ab534 Replace Riot with Element in docs and comments 
This only covers the simple cases of references to issues and repos. More
complex areas, such as deployment scripts, will be handled separately.

Part of https://github.com/vector-im/element-web/issues/14864
2020-08-03 18:33:36 +01:00

1.4 KiB
Raw Blame History

Jitsi Wrapper

Note: These are developer docs. Please consult your client's documentation for 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:

  • widgetId: The ID of the widget. This is needed for communication back to the react-sdk.
  • parentUrl: The URL of the parent window. This is also needed for communication back to the react-sdk.

Hash/fragment (formatted as a query string):

  • 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.
  • 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 being served. For example, https://develop.element.io/jitsi.html or vector://webapp/jitsi.html.

The jitsi.html wrapper can use the react-sdk's WidgetApi to communicate, making it easier to actually implement the feature.