Launch Features

These features can also be enabled/disabled on an organisation level under the Space Settings of your dashboard.

General Features

It is possible to disable or enable features available inside the Space by using the features parameter in the Launch endpoint. This is an object with each key being the feature name and the value being either true (representing an enabled feature) or false (a disabled feature). These are applied on a per-link basis (not a per-Space basis) so it is possible to have two users with chat and one user without chat on the same Space.

Example of object to be added to the POST body schema of the Launch endpoint:

  {
    "features": {
      "chat": true,
      "emojis": false
    }
  }

These features apply across all tabs in a room. Below is a list of those features and a short description for each of them.

KEY	DEFAULT VALUE	DESCRIPTION
chat	`true`	Enable/disable chat
timer	`true`	Control whether or not users have access to the timer. Note: this is always true for leaders
invite	`false`	Hide/show the invite others button*
endSession	`false`	Hide/show the end session button*
participants	`true`	Hide/show the participants list in the toolbar
fullscreen	`true`	Enable/disable the ability to allow the room to go fullscreen
tabContextMenu	`true`	Enable/disable the context menu shown when right clicking on a tab
importZip	`true`	Enable/disable the ability to import a room configuration ZIP file
importPdf	`true`	Enable/disable the ability to upload a PDF file
exportZip	`true`	Enable/disable the ability to download the room configuration/content as a ZIP file
tabDownload	`true`	Allow/disallow a tab to be downloaded
emojis	`true`	Enable/disable emojis in chat
profanityFilter	`false`	Filter out bad words
hideTabbar	`false`	Show/hide the tab bar
hideToolbar	`false`	Show/hide the toolbar

By default users who can lead will have those buttons available and those who cannot lead will have those buttons hidden. However, setting the value to false will hide the button for potential leaders as well.

Theming

Certain elements of the Space UI can be controlled by using the theme parameter in the Launch endpoint. It is an object with each key being the feature name and the values being valid properties in the formats described in the table below. These are applied on a per-link basis (not a per-Space basis).

Example of object to be added to the POST body schema of the Launch endpoint:

  {
    "theme": {
      "darkmode": true,
      "corners": "md"
    }
  }

KEY	DEFAULT VALUE	DESCRIPTION
darkmode	`true`	Boolean flag determining whether or not dark mode is enabled when loading the Space.
corners	`md`	Adjusts the roundness of UI elements. Valid values are: `none`, `xs`, `sm`, `md`, `lg`, `full`.
logo		URL for an image file that will be displayed above the video in the Lobby if you want to add branding there.
color	`#4299E1`	Controls the colour of the accents, buttons, and toggles. Accepts a hex colour code (eg. #4299E1).
hue	`214`	Subtly adjust the base colour of the grey UI chrome. Valid values are any integer between 0 and 255 on the hue scale.

Language

The launch endpoint also supports localisations for certain languages. This can be achieved by simply adding the locale parameter to your payload with the value being the ISO639-1 string corresponding to your locale of choice (for example it,fr and pl for Italian, French and Polish respectively). Below is a table of the available languages and their respective ISO639-1 values. Please contact support@thelessonspace.com if you are interested in expanding this list.

Example of object to be added to the POST body schema of the Launch endpoint:

  {
    "locale": "it"
  }

LANGUAGE	ISO639-1 VALUE
English	`en`
English (US)	`en-us`
French	`fr`
Italian	`it`
Polish	`pl`
Bulgarian	`bg`
Spanish	`es`
Hungarian	`hu`
Russian	`ru`
Xhosa	`xh`

Generating a spectator link

You can generate a link to a Space so that a user will have their AV disabled within the Space. They can see the videos of other participants and interact with the Space contents and chat as normal but their own video feed is not broadcasted. Since there is a limit of 10 AV publishers in a Space, this feature can be used to prioritize the AV of select users.

Spectator mode can be achieved by setting the lobby and avPublishing field of the features parameter to false when calling the launch endpoint. Upon clicking the link, the user will be taken directly to the Space (bypassing the device setup in the Lobby).

An example payload would look something like:

{
  "id": "space 1",
  "features": {
    "lobby": false,
    "avPublishing": false
  }
}

Additional Parameters

This guide is not meant to be exhaustive and covers only the most common use-cases. You can find more information on the other fields by checking out the endpoint specification in our API reference.