Marque blanche
Une salle peut s’afficher sous la marque d’un client plutôt que sous celle de Vuisio : son nom dans l’onglet et dans les textes, ses couleurs, son logo à la place du nôtre, son favicon. La marque se règle par locataire : toutes les salles d’une clé la portent. Celle de la clé primaire est la marque de toute l’instance : le hall d’accueil, les rediffusions et les salles des clés qui n’en ont pas.
Ce qu’une marque contient
Section intitulée « Ce qu’une marque contient »| Champ | Rôle |
|---|---|
name | Le nom affiché à la place de « Vuisio », 60 caractères au plus |
theme | Les couleurs : un jeton de sdk/ui/tokens.css (par exemple --color-ink) vers une couleur #rrggbb. Seuls les jetons de la salle sont acceptés |
theme_dark | Les mêmes jetons pour le mode sombre |
logo | Le logo, en PNG, JPEG ou WebP |
logo_dark | Le logo sur fond sombre, même format. Il ne s’emploie qu’avec logo |
favicon | L’icône d’onglet, en PNG ou ICO |
show_powered_by | Si la mention « Propulsé par Vuisio » reste affichée. Vrai par défaut. Elle ne s’affiche que sous un nom, un logo ou une icône d’onglet propres : des couleurs seules ne la font pas apparaître |
Une salle prend chaque champ de la marque de sa clé, à défaut de celle de l’instance, à défaut de Vuisio. Les couleurs se complètent jeton par jeton : un client qui ne change que sa couleur principale garde les autres couleurs de l’instance.
Une clé dont inherit_instance_brand vaut false ne reprend rien de la marque
de l’instance : ses salles prennent sa marque, puis directement celles de
Vuisio. C’est utile quand un portail calcule lui-même la marque complète de
chaque locataire et ne veut pas que celle de l’opérateur se glisse dessous. Le
réglage se pose par le même PATCH, à côté de branding.
Les fichiers ne dépassent pas 1 Mo (256 Ko avant la version 0.18.1). Leur type est reconnu à leur contenu, et le SVG est refusé : un SVG peut porter du script, et il serait servi depuis l’origine des salles.
Le mode sombre
Section intitulée « Le mode sombre »Chaque participant choisit l’apparence de son écran : clair, sombre, ou automatique, qui suit le réglage de son appareil et sert par défaut. Le choix se fait avant d’entrer (pré-salle, salle d’attente, hall d’accueil), d’un clic sur le soleil ou la lune, ou en réunion dans les réglages, page Apparence. Il reste sur l’appareil et ne change rien pour les autres.
En sombre, la salle prend theme_dark et logo_dark. Une marque sans
theme_dark garde les couleurs sombres de Vuisio plutôt que ses couleurs claires
sur fond sombre, et une marque sans logo propre affiche le logo de Vuisio en
blanc. Un logo sans logo_dark s’affiche en sombre sur une pastille claire,
le papier pour lequel il a été dessiné : des lettres noires ne disparaissent
jamais sur le fond de la salle.
Poser une marque
Section intitulée « Poser une marque »Par l’API d’administration, avec la clé primaire. Les fichiers d’abord, puis la marque entière :
# Le logo, qui revient avec son empreintecurl -X PUT -H "Authorization: Bearer $PRIMARY" \ --data-binary @logo.png https://visio.example.org/api/branding/assets/logo# {"sha256":"fc37a6…","content_type":"image/png"}
curl -X PATCH -H "Authorization: Bearer $PRIMARY" -H "Content-Type: application/json" \ https://visio.example.org/api/tenants/greta -d '{ "branding": { "name": "Greta Visio", "theme": { "--color-ink": "#0f766e", "--color-on-ink": "#ffffff" }, "logo": { "sha256": "fc37a6…", "content_type": "image/png" }, "show_powered_by": true } }'La marque est remplacée en entier à chaque appel, et {"branding": {}}
l’efface. Une marque qui nomme un fichier jamais envoyé est refusée : ce serait
une image cassée dans toutes les salles du client. La réponse indique, dans
rooms_notified, combien de réunions ouvertes ont été prévenues.
Pour la marque de toute l’instance, le même appel vise /api/tenants/primary.
Une marque propre à une salle
Section intitulée « Une marque propre à une salle »Une salle peut porter sa propre marque, par-dessus celle de sa clé : une formation sous le nom de l’organisme qui la donne, un client d’une agence dans ses couleurs. Elle se pose avec la clé primaire, comme la marque d’une clé, en nommant le locataire puis la salle telle que ce locataire la connaît :
curl -X PUT -H "Authorization: Bearer $PRIMAIRE" -H "Content-Type: application/json" \ https://visio.example.org/api/tenants/greta/rooms/cours-du-jeudi/branding -d '{ "name": "Greta Formation", "theme": { "--color-ink": "#1e3a8a" }, "logo": { "sha256": "9b1d44…", "content_type": "image/png" } }'Une salle règle son nom, ses couleurs, son logo (logo et logo_dark) et son
icône d’onglet (favicon). La mention « Propulsé par Vuisio » reste celle de la
clé. La salle prend chaque champ de sa propre marque, à défaut de celle de sa
clé, puis de celle de l’instance. Son logo et sa version sombre vont ensemble :
une salle avec son propre logo n’affiche jamais, en mode sombre, celui de la
clé.
Comme pour une clé, la marque est remplacée en entier et {} l’efface. Les
fichiers s’envoient d’abord, avec la clé primaire. GET sur la même adresse
rend la marque propre de la salle, vide si elle n’en a pas. La marque est
gardée avec la salle et disparaît avec elle. Les sous-groupes d’une réunion
reprennent celle de leur salle, y compris quand elle change pendant qu’ils
sont ouverts, et la réunion ouverte change aussitôt.
La clé d’un locataire ne peut pas poser la marque d’une salle : c’est la clé primaire, celle de l’opérateur, qui décide de ce qu’un locataire a le droit de personnaliser.
Une bibliothèque de thèmes
Section intitulée « Une bibliothèque de thèmes »Une clé peut tenir une bibliothèque de thèmes, que ses salles désignent par leur
nom : la formation santé dans un thème, la formation bâtiment dans un autre,
sans poser une marque salle par salle. La bibliothèque se pose avec la clé
primaire, entière à chaque appel, par le même PATCH que la marque :
curl -X PATCH -H "Authorization: Bearer $PRIMAIRE" -H "Content-Type: application/json" \ https://visio.example.org/api/tenants/greta -d '{ "themes": { "sante": { "name": "Greta Santé", "theme": { "--color-ink": "#0f766e" } }, "batiment": { "name": "Greta Bâtiment", "logo": { "sha256": "9b1d44…", "content_type": "image/png" } } } }'Un thème a les mêmes champs qu’une marque, sauf la mention, qui reste celle de
la clé. Son nom de clé s’écrit en minuscules, chiffres et tirets, 40 caractères
au plus, parce qu’on le tape dans un réglage et qu’il voyage dans une adresse.
Une bibliothèque compte 500 thèmes au plus. {"themes": {}} la vide, et les
fichiers s’envoient d’abord, comme pour la marque.
Une salle choisit son thème à sa création, avec la clé du locataire :
curl -X POST -H "Authorization: Bearer $GRETA" -H "Content-Type: application/json" \ https://visio.example.org/api/rooms -d '{ "room_id": "cours-du-jeudi", "theme": "sante" }'La salle garde le nom du thème, pas une copie : modifier le thème dans la bibliothèque change toutes les salles qui le portent, réunions ouvertes comprises. Un nom que la bibliothèque ne contient pas, aujourd’hui ou plus tard, laisse simplement la salle à la marque de sa clé. Le thème se choisit à la création seulement : rappeler la création d’une salle qui existe déjà ne change pas son apparence. Les sous-groupes gardent celle de leur salle, et une marque propre posée sur la salle par la clé primaire l’emporte toujours.
Les réunions en cours suivent
Section intitulée « Les réunions en cours suivent »Une réunion ouverte reçoit la nouvelle marque par son canal de données, sans que personne recharge la page : un client qui ajuste ses couleurs voit ses salles changer pendant qu’il tape. Les changements rapprochés sont regroupés, au plus un envoi toutes les 300 ms par locataire. Rien n’interroge le serveur en boucle.
GET /api/branding?room= (public) donne la marque d’une salle telle qu’un
participant la voit, celle de l’instance sans room. Elle ne dit rien qu’un
participant ne voie déjà à l’écran.
L’aperçu
Section intitulée « L’aperçu »/preview/branding dessine une salle fictive aux couleurs d’un brouillon qu’un
portail d’administration lui envoie par postMessage, sans réseau ni réunion.
Seules les origines de VUISIO_BRANDING_PREVIEW_ORIGINS peuvent l’intégrer et
lui parler. Cette seule page est autorisée en iframe : les salles, elles,
restent limitées à VUISIO_EMBED_ANCESTORS.
Ce qui reste visible
Section intitulée « Ce qui reste visible »L’adresse du serveur reste la sienne. Une instance servie sous un nom de domaine Vuisio garde ce nom dans la barre d’adresse : pour une marque complète, servez l’instance sous le domaine du client.