manifest.json voor Livedeck-widgets: velden, permissies en foutcodes
Alle velden, permissies en instellingstypes van manifest.json, en wat elke foutcode betekent.
manifest.json beschrijft je widget. Livedeck leest het bestand bij het uploaden, bouwt er de editorinstellingen mee en geeft de widget alleen de permissies die erin staan. Onbekende velden geven een fout, zodat typfouten nooit verborgen blijven.
{
"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"]
}Velden
manifestVersion
Verplicht: ja
Betekenis: Altijd 1
name
Verplicht: ja
Betekenis: Naam van de widget, maximaal 60 tekens
version
Verplicht: ja
Betekenis: Versienummer x.y.z, bijvoorbeeld 1.2.0
sdk
Verplicht: ja
Betekenis: SDK-versie, nu "1"
entry
Verplicht: nee
Betekenis: Startbestand, standaard index.html. Moet eindigen op .html.
description
Verplicht: nee
Betekenis: Korte beschrijving, maximaal 300 tekens
formats
Verplicht: nee
Betekenis: ["9:16"], ["16:9"] of allebei (standaard: allebei)
size
Verplicht: ja
Betekenis: Grootte in pixels op het overlay-canvas: default, min en max als [breedte, hoogte]
permissions
Verplicht: nee
Betekenis: Welke gegevens de widget krijgt (zie hieronder)
settings
Verplicht: nee
Betekenis: Instellingen die gebruikers in de editor aanpassen (maximaal 40)
locales
Verplicht: nee
Betekenis: Talen die je widget ondersteunt, bijvoorbeeld ["de", "en"]
| Veld | Verplicht | Betekenis |
|---|---|---|
| manifestVersion | ja | Altijd 1 |
| name | ja | Naam van de widget, maximaal 60 tekens |
| version | ja | Versienummer x.y.z, bijvoorbeeld 1.2.0 |
| sdk | ja | SDK-versie, nu "1" |
| entry | nee | Startbestand, standaard index.html. Moet eindigen op .html. |
| description | nee | Korte beschrijving, maximaal 300 tekens |
| formats | nee | ["9:16"], ["16:9"] of allebei (standaard: allebei) |
| size | ja | Grootte in pixels op het overlay-canvas: default, min en max als [breedte, hoogte] |
| permissions | nee | Welke gegevens de widget krijgt (zie hieronder) |
| settings | nee | Instellingen die gebruikers in de editor aanpassen (maximaal 40) |
| locales | nee | Talen die je widget ondersteunt, bijvoorbeeld ["de", "en"] |
Het canvas is 1080 × 1920 pixels in 9:16 en 1920 × 1080 in 16:9. Groottes gaan van 16 tot 3840 pixels. min en max zijn de grenzen als gebruikers de widget in de editor groter of kleiner maken. Zonder die waarden geldt default. Bouw de widget in vaste pixels voor default: als gebruikers de grootte aanpassen, zoomt Livedeck de hele pagina mee met het kader (tekst, afbeeldingen en ruimte groeien samen). Krijgt het kader een andere vorm dan default, dan krijgt de pagina de extra ruimte in die richting. Gebruik dus breedtes/hoogtes van 100%, flexbox of grid waar het moet vullen. livedeck.context.size is de paginagrootte in CSS-pixels en livedeck.context.scale de zoom.
Rechten
Kopers zien deze lijst vóór de aankoop en de editor toont hem onder ‘Krijgt toegang tot’. Vraag alleen wat je echt nodig hebt.
events.gift
Cadeaus (event gift)
events.chat
Chatberichten (chat)
events.like
Likes, gebundeld (like)
events.follow
Nieuwe volgers (follow)
events.share
Keren dat de LIVE gedeeld wordt (share)
events.join
Een kijker komt de LIVE binnen (join)
events.fanclub
Nieuwe fanclubleden (fanclub)
events.viewers
Aantal kijkers (viewers)
stream.status
Live, offline of wordt gecontroleerd (stream)
media.play
Mag geluiden uit de media-instellingen via Livedeck afspelen
host.profile
Naam en profielfoto van de streamer (livedeck.host)
| Permissie | Wat de widget krijgt |
|---|---|
| events.gift | Cadeaus (event gift) |
| events.chat | Chatberichten (chat) |
| events.like | Likes, gebundeld (like) |
| events.follow | Nieuwe volgers (follow) |
| events.share | Keren dat de LIVE gedeeld wordt (share) |
| events.join | Een kijker komt de LIVE binnen (join) |
| events.fanclub | Nieuwe fanclubleden (fanclub) |
| events.viewers | Aantal kijkers (viewers) |
| stream.status | Live, offline of wordt gecontroleerd (stream) |
| media.play | Mag geluiden uit de media-instellingen via Livedeck afspelen |
| host.profile | Naam en profielfoto van de streamer (livedeck.host) |
Instellingen
Elke instelling heeft een key, een type en een label. De key begint met een kleine letter, gevolgd door letters, cijfers of _ (maximaal 32 tekens). Een label is tekst of een object met talen, zoals {"de": "Farbe", "en": "Colour"}, maximaal 80 tekens. De widget leest de waarden uit livedeck.settings.
text
Velden: default, maxLength (maximaal 200)
Waarde in de widget: Tekst
number
Velden: default, min, max, step (allemaal optioneel)
Waarde in de widget: Getal
range
Velden: default, min en max (verplicht), step
Waarde in de widget: Getal, in de editor weergegeven als schuifregelaar
boolean
Velden: default
Waarde in de widget: true of false
color
Velden: default als #rrggbb
Waarde in de widget: Kleur als #rrggbb
select
Velden: options (1 tot 50, elk met value en label), default
Waarde in de widget: value van de gekozen optie
gift
Velden: default (cadeau-ID of null)
Waarde in de widget: Cadeau-ID als getal, of null
media
Velden: accept: audio, image of video. Geen default.
Waarde in de widget: true als de gebruiker een eigen bestand heeft gekozen, anders false
| Type | Velden | Waarde in de widget |
|---|---|---|
| text | default, maxLength (maximaal 200) | Tekst |
| number | default, min, max, step (allemaal optioneel) | Getal |
| range | default, min en max (verplicht), step | Getal, in de editor weergegeven als schuifregelaar |
| boolean | default | true of false |
| color | default als #rrggbb | Kleur als #rrggbb |
| select | options (1 tot 50, elk met value en label), default | value van de gekozen optie |
| gift | default (cadeau-ID of null) | Cadeau-ID als getal, of null |
| media | accept: audio, image of video. Geen default. | true als de gebruiker een eigen bestand heeft gekozen, anders false |
Als een waarde ontbreekt of ongeldig is, krijgt de widget de standaardwaarde. Zo werken updates met nieuwe instellingen voor iedereen die je widget al gebruikt.
Fouten in manifest.json
Als de controle mislukt met „manifest.json is invalid”, staan de code en de plek eronder, bijvoorbeeld settings[2].default.
manifest_not_object
Het bestand is geen JSON-object.
manifest_too_large
Het bestand is groter dan 64 KB.
manifest_invalid_json
Geen geldige JSON (vaak een komma te veel of te weinig).
unknown_field
Dit veld bestaat niet. Meestal een typfout.
required
Er ontbreekt een verplicht veld.
wrong_type
Verkeerd type, bijvoorbeeld tekst in plaats van een lijst.
unsupported_manifest_version
manifestVersion is niet 1.
unsupported_sdk
sdk is niet "1".
invalid_name
Naam leeg, langer dan 60 tekens of met onzichtbare stuurtekens.
invalid_text
Tekst leeg, te lang of met onzichtbare stuurtekens.
invalid_version
Versie niet in de vorm x.y.z (bijvoorbeeld 1.0.0).
invalid_entry
entry is geen relatief pad naar een .html-bestand.
invalid_format
Formaat is niet "9:16" of "16:9".
duplicate
Dubbele invoer.
invalid_size
Grootte buiten 16 tot 3840 pixels, of default ligt niet tussen min en max.
unknown_permission
Deze permissie bestaat niet.
too_many_settings
Meer dan 40 instellingen.
invalid_setting_key
key past niet bij het patroon (zie hierboven).
unknown_setting_type
Dit instellingstype bestaat niet.
invalid_default
default past niet bij het type of valt buiten de grenzen.
invalid_bounds
min, max, step of maxLength is ongeldig.
invalid_options
options ontbreken, zijn leeg, het zijn er meer dan 50, of een optie heeft geen value.
invalid_media_kind
accept is niet audio, image of video.
invalid_locale
Deze taal bestaat niet. Toegestaan: en, de, tr, fr, es, it, ru, ar, zh-CN, ja, he, pt, nl, pl, uk, ko, hi, id, vi, th.
| Code | Betekenis |
|---|---|
| manifest_not_object | Het bestand is geen JSON-object. |
| manifest_too_large | Het bestand is groter dan 64 KB. |
| manifest_invalid_json | Geen geldige JSON (vaak een komma te veel of te weinig). |
| unknown_field | Dit veld bestaat niet. Meestal een typfout. |
| required | Er ontbreekt een verplicht veld. |
| wrong_type | Verkeerd type, bijvoorbeeld tekst in plaats van een lijst. |
| unsupported_manifest_version | manifestVersion is niet 1. |
| unsupported_sdk | sdk is niet "1". |
| invalid_name | Naam leeg, langer dan 60 tekens of met onzichtbare stuurtekens. |
| invalid_text | Tekst leeg, te lang of met onzichtbare stuurtekens. |
| invalid_version | Versie niet in de vorm x.y.z (bijvoorbeeld 1.0.0). |
| invalid_entry | entry is geen relatief pad naar een .html-bestand. |
| invalid_format | Formaat is niet "9:16" of "16:9". |
| duplicate | Dubbele invoer. |
| invalid_size | Grootte buiten 16 tot 3840 pixels, of default ligt niet tussen min en max. |
| unknown_permission | Deze permissie bestaat niet. |
| too_many_settings | Meer dan 40 instellingen. |
| invalid_setting_key | key past niet bij het patroon (zie hierboven). |
| unknown_setting_type | Dit instellingstype bestaat niet. |
| invalid_default | default past niet bij het type of valt buiten de grenzen. |
| invalid_bounds | min, max, step of maxLength is ongeldig. |
| invalid_options | options ontbreken, zijn leeg, het zijn er meer dan 50, of een optie heeft geen value. |
| invalid_media_kind | accept is niet audio, image of video. |
| invalid_locale | Deze taal bestaat niet. Toegestaan: en, de, tr, fr, es, it, ru, ar, zh-CN, ja, he, pt, nl, pl, uk, ko, hi, id, vi, th. |
Was dit artikel nuttig?