Manifest

remeet.json describes your app: its name, where its pages live and what it asks for. It is a JSON file on any https address. JSON Schema for editors: sdk.remeet.video/schema/v0/remeet.json.

{
  "$schema": "https://sdk.remeet.video/schema/v0/remeet.json",
  "key": "hello-remeet",
  "version": "0.1.0",
  "name": { "en": "Hello ReMeet", "ru": "Привет, ReMeet", "ar": "مرحبًا ReMeet" },
  "description": {
    "en": "Wave to everyone in the meeting and count together on a shared stage.",
    "ru": "Помашите всем во встрече и считайте вместе на общей сцене."
  },
  "art": "https://sdk.remeet.video/hello/art.svg",
  "developer": { "name": "ReMeet", "url": "https://sdk.remeet.video" },
  "surfaces": {
    "panel": { "url": "https://sdk.remeet.video/hello/panel.html" },
    "stage": { "url": "https://sdk.remeet.video/hello/stage.html" }
  },
  "permissions": ["participants.read", "app.broadcast", "badges.write", "stage.start", "storage"]
}

This is the real manifest of the Hello ReMeet example.

Fields

Field	Required	Rules
key	yes	Unique id of the app: 3–40 lowercase latin letters, digits and dashes, starts with a letter or digit. Cannot be the key of a built-in ReMeet app. Never changes after the app is added.
version	yes	Three numbers: 0.1.0. Shown in the marketplace.
name	yes	Object with texts by language. en is required, ru and ar are optional. Up to 60 characters.
description	yes	Same shape as name, up to 300 characters.
art	no	https address of the marketplace picture. Square works best; SVG or PNG with a transparent background.
developer.name	yes	Who made the app, up to 80 characters.
developer.url, developer.email	no	Your site (https) and contact.
surfaces	yes	At least one of panel and stage, each with an https url. See where an app is shown.
permissions	no	What the app asks for. See Permissions.
media	no	camera and/or microphone, if the page itself needs them.

People see the name and description in their language when you provide it, otherwise in English.

Where the pages may live

• Only https addresses.
• Not on remeet.video itself: an app is someone else's code, so it lives on its own domain.
• The manifest file itself is up to 64 KB.

Errors

When the manifest does not pass the check, ReMeet says exactly what is wrong, for example:

• «key»: 3–40 lowercase latin letters, digits and dashes.
• «version»: three numbers, like 0.1.0.
• «surfaces.panel.url» must be an https address.
• Unknown permissions: read.mind.
• An app with the key wave already exists.

Updating an app

Change the files, raise version and update the app from the manifest (now through the ReMeet team; developer accounts will do it themselves). What changes for people who already installed it:

• Name, description, picture and page addresses update for everyone at once.
• A removed permission is taken away from everyone at once.
• An added permission is not granted automatically. People who installed the app before keep the old set until they remove the app and add it again. Check with app.can('…') before using a new permission.