Matrix/element-web-Github
1
0
Fork 0
mirror of https://github.com/vector-im/element-web.git synced 2024-11-16 13:14:58 +08:00
Code Issues Packages Projects Releases Wiki Activity
5156388fc6
element-web-Github/docs/jitsi.md
Travis Ralston af97ec57d0
Apply suggestions from code review 
Co-Authored-By: J. Ryan Stinnett <jryans@gmail.com>
2020-03-19 11:45:17 -06: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://riot.im/develop/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.