manifest.json pour les widgets Livedeck : champs, permissions et codes d’erreur
Tous les champs, permissions et types de paramètres de manifest.json, et la signification de chaque code d’erreur.
manifest.json décrit votre widget. Livedeck le lit à l’import, génère à partir de lui les paramètres de l’éditeur et n’accorde au widget que les permissions qui y figurent. Les champs inconnus provoquent une erreur, pour qu’aucune faute de frappe ne passe inaperçue.
{
"manifestVersion": 1,
"name": "Gift Goal",
"version": "1.0.0",
"sdk": "1",
"entry": "index.html",
"description": "A bar that fills up with gifts.",
"formats": ["9:16", "16:9"],
"size": { "default": [600, 160], "min": [300, 80], "max": [1080, 400] },
"permissions": ["events.gift", "media.play"],
"settings": [
{ "key": "goal", "type": "number", "label": { "de": "Ziel", "en": "Goal" }, "default": 100, "min": 1 },
{ "key": "giftId", "type": "gift", "label": { "de": "Nur dieses Geschenk", "en": "Only this gift" } },
{ "key": "accent", "type": "color", "label": { "de": "Farbe", "en": "Colour" }, "default": "#22c55e" },
{ "key": "doneSound", "type": "media", "label": { "de": "Ton bei Ziel", "en": "Goal sound" }, "accept": "audio" }
],
"locales": ["de", "en"]
}Champs
manifestVersion
Obligatoire: oui
Signification: Toujours 1
name
Obligatoire: oui
Signification: Nom du widget, 60 caractères max.
version
Obligatoire: oui
Signification: Numéro de version x.y.z, par exemple 1.2.0
sdk
Obligatoire: oui
Signification: Version du SDK, « 1 » actuellement
entry
Obligatoire: non
Signification: Fichier de démarrage, index.html par défaut. Doit se terminer par .html.
description
Obligatoire: non
Signification: Description courte, 300 caractères max.
formats
Obligatoire: non
Signification: ["9:16"], ["16:9"] ou les deux (par défaut : les deux)
size
Obligatoire: oui
Signification: Taille en pixels sur le canevas de l’overlay : default, min et max sous forme [largeur, hauteur]
permissions
Obligatoire: non
Signification: Les données que reçoit le widget (voir ci-dessous)
settings
Obligatoire: non
Signification: Paramètres modifiables dans l’éditeur (40 max.)
locales
Obligatoire: non
Signification: Langues prises en charge par votre widget, par exemple ["de", "en"]
| Champ | Obligatoire | Signification |
|---|---|---|
| manifestVersion | oui | Toujours 1 |
| name | oui | Nom du widget, 60 caractères max. |
| version | oui | Numéro de version x.y.z, par exemple 1.2.0 |
| sdk | oui | Version du SDK, « 1 » actuellement |
| entry | non | Fichier de démarrage, index.html par défaut. Doit se terminer par .html. |
| description | non | Description courte, 300 caractères max. |
| formats | non | ["9:16"], ["16:9"] ou les deux (par défaut : les deux) |
| size | oui | Taille en pixels sur le canevas de l’overlay : default, min et max sous forme [largeur, hauteur] |
| permissions | non | Les données que reçoit le widget (voir ci-dessous) |
| settings | non | Paramètres modifiables dans l’éditeur (40 max.) |
| locales | non | Langues prises en charge par votre widget, par exemple ["de", "en"] |
Le canevas fait 1080 × 1920 pixels en 9:16 et 1920 × 1080 en 16:9. Les tailles vont de 16 à 3840 pixels. min et max sont les limites quand l’utilisateur redimensionne le widget dans l’éditeur. Sans elles, default s’applique. Concevez le widget en pixels fixes pour default : quand l’utilisateur le redimensionne, Livedeck zoome toute la page avec le cadre (texte, images et espacements grandissent ensemble). Si le cadre prend une autre forme que default, la page reçoit l’espace supplémentaire dans cette direction : utilisez donc des largeurs/hauteurs à 100 %, flexbox ou grid là où elle doit remplir. livedeck.context.size est la taille de la page en pixels CSS et livedeck.context.scale le zoom.
Autorisations
Les acheteurs voient cette liste avant l’achat, et l’éditeur l’affiche sous « A accès à ». Ne demandez que ce dont vous avez vraiment besoin.
events.gift
Cadeaux (événement gift)
events.chat
Messages du chat (chat)
events.like
Likes, groupés (like)
events.follow
Nouveaux followers (follow)
events.share
Partages du LIVE (share)
events.join
Un spectateur rejoint le LIVE (join)
events.fanclub
Adhésions au fan club (fanclub)
events.viewers
Nombre de spectateurs (viewers)
stream.status
En direct, hors ligne ou en vérification (stream)
media.play
Peut lire des sons des paramètres média via Livedeck
host.profile
Le nom et la photo de profil du streamer (livedeck.host)
| Permission | Ce que reçoit le widget |
|---|---|
| events.gift | Cadeaux (événement gift) |
| events.chat | Messages du chat (chat) |
| events.like | Likes, groupés (like) |
| events.follow | Nouveaux followers (follow) |
| events.share | Partages du LIVE (share) |
| events.join | Un spectateur rejoint le LIVE (join) |
| events.fanclub | Adhésions au fan club (fanclub) |
| events.viewers | Nombre de spectateurs (viewers) |
| stream.status | En direct, hors ligne ou en vérification (stream) |
| media.play | Peut lire des sons des paramètres média via Livedeck |
| host.profile | Le nom et la photo de profil du streamer (livedeck.host) |
Paramètres
Chaque paramètre a une clé (key), un type et un libellé (label). La clé commence par une lettre minuscule suivie de lettres, chiffres ou _ (32 caractères max.). Un libellé est un texte ou un objet avec des langues comme {"de": "Farbe", "en": "Colour"}, 80 caractères max. Le widget lit les valeurs dans livedeck.settings.
text
Champs: default, maxLength (200 max.)
Valeur dans le widget: Texte
number
Champs: default, min, max, step (tous facultatifs)
Valeur dans le widget: Nombre
range
Champs: default, min et max (obligatoires), step
Valeur dans le widget: Nombre, affiché sous forme de curseur dans l’éditeur
boolean
Champs: default
Valeur dans le widget: true ou false
color
Champs: default au format #rrggbb
Valeur dans le widget: Couleur au format #rrggbb
select
Champs: options (1 à 50, chacune avec value et label), default
Valeur dans le widget: value de l’option choisie
gift
Champs: default (ID de cadeau ou null)
Valeur dans le widget: ID de cadeau sous forme de nombre, ou null
media
Champs: accept : audio, image ou video. Pas de default.
Valeur dans le widget: true si l’utilisateur a choisi son propre fichier, sinon false
| Type | Champs | Valeur dans le widget |
|---|---|---|
| text | default, maxLength (200 max.) | Texte |
| number | default, min, max, step (tous facultatifs) | Nombre |
| range | default, min et max (obligatoires), step | Nombre, affiché sous forme de curseur dans l’éditeur |
| boolean | default | true ou false |
| color | default au format #rrggbb | Couleur au format #rrggbb |
| select | options (1 à 50, chacune avec value et label), default | value de l’option choisie |
| gift | default (ID de cadeau ou null) | ID de cadeau sous forme de nombre, ou null |
| media | accept : audio, image ou video. Pas de default. | true si l’utilisateur a choisi son propre fichier, sinon false |
Si une valeur manque ou est invalide, le widget reçoit la valeur par défaut. Ainsi, les mises à jour avec de nouveaux paramètres fonctionnent pour tous ceux qui utilisent déjà votre widget.
Erreurs dans manifest.json
Si la vérification échoue avec « manifest.json is invalid », le code et l’emplacement sont indiqués en dessous, par exemple settings[2].default.
manifest_not_object
Le fichier n’est pas un objet JSON.
manifest_too_large
Le fichier dépasse 64 Ko.
manifest_invalid_json
JSON invalide (souvent une virgule en trop ou manquante).
unknown_field
Ce champ n’existe pas. Souvent une faute de frappe.
required
Un champ obligatoire manque.
wrong_type
Mauvais type, par exemple du texte au lieu d’une liste.
unsupported_manifest_version
manifestVersion n’est pas 1.
unsupported_sdk
sdk n’est pas "1".
invalid_name
Nom vide, de plus de 60 caractères ou contenant des caractères de contrôle invisibles.
invalid_text
Texte vide, trop long ou contenant des caractères de contrôle invisibles.
invalid_version
Version pas au format x.y.z (par exemple 1.0.0).
invalid_entry
entry n’est pas un chemin relatif vers un fichier .html.
invalid_format
Le format n’est pas "9:16" ou "16:9".
duplicate
Entrée en double.
invalid_size
Taille hors de la plage 16 à 3840 pixels, ou default n’est pas entre min et max.
unknown_permission
Cette autorisation n’existe pas.
too_many_settings
Plus de 40 paramètres.
invalid_setting_key
key ne correspond pas au modèle (voir ci-dessus).
unknown_setting_type
Ce type de paramètre n’existe pas.
invalid_default
default ne correspond pas au type ou sort des limites.
invalid_bounds
min, max, step ou maxLength est invalide.
invalid_options
options manquantes, vides, plus de 50, ou une option sans value.
invalid_media_kind
accept n’est pas audio, image ou video.
invalid_locale
Cette langue n’existe pas. Autorisées : en, de, tr, fr, es, it, ru, ar, zh-CN, ja, he, pt, nl, pl, uk, ko, hi, id, vi, th.
| Code | Signification |
|---|---|
| manifest_not_object | Le fichier n’est pas un objet JSON. |
| manifest_too_large | Le fichier dépasse 64 Ko. |
| manifest_invalid_json | JSON invalide (souvent une virgule en trop ou manquante). |
| unknown_field | Ce champ n’existe pas. Souvent une faute de frappe. |
| required | Un champ obligatoire manque. |
| wrong_type | Mauvais type, par exemple du texte au lieu d’une liste. |
| unsupported_manifest_version | manifestVersion n’est pas 1. |
| unsupported_sdk | sdk n’est pas "1". |
| invalid_name | Nom vide, de plus de 60 caractères ou contenant des caractères de contrôle invisibles. |
| invalid_text | Texte vide, trop long ou contenant des caractères de contrôle invisibles. |
| invalid_version | Version pas au format x.y.z (par exemple 1.0.0). |
| invalid_entry | entry n’est pas un chemin relatif vers un fichier .html. |
| invalid_format | Le format n’est pas "9:16" ou "16:9". |
| duplicate | Entrée en double. |
| invalid_size | Taille hors de la plage 16 à 3840 pixels, ou default n’est pas entre min et max. |
| unknown_permission | Cette autorisation n’existe pas. |
| too_many_settings | Plus de 40 paramètres. |
| invalid_setting_key | key ne correspond pas au modèle (voir ci-dessus). |
| unknown_setting_type | Ce type de paramètre n’existe pas. |
| invalid_default | default ne correspond pas au type ou sort des limites. |
| invalid_bounds | min, max, step ou maxLength est invalide. |
| invalid_options | options manquantes, vides, plus de 50, ou une option sans value. |
| invalid_media_kind | accept n’est pas audio, image ou video. |
| invalid_locale | Cette langue n’existe pas. Autorisées : en, de, tr, fr, es, it, ru, ar, zh-CN, ja, he, pt, nl, pl, uk, ko, hi, id, vi, th. |
Cet article vous a-t-il été utile ?