manifest.json für Livedeck-Widgets: Felder, Rechte und Fehlercodes

Alle Felder, Rechte und Einstellungs-Typen der manifest.json und was jeder Fehler-Code bedeutet.

8 Min. Lesezeit Aktualisiert 4. Nov. 2026

manifest.json beschreibt dein Widget. Livedeck liest sie beim Hochladen, baut daraus die Einstellungen im Editor und gibt dem Widget nur die Rechte, die darin stehen. Unbekannte Felder sind ein Fehler, damit sich Tippfehler nicht verstecken.

json
{
  "manifestVersion": 1,
  "name": "Geschenkziel",
  "version": "1.0.0",
  "sdk": "1",
  "entry": "index.html",
  "description": "Ein Balken, der sich mit Geschenken füllt.",
  "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"]
}

Felder

manifestVersion

Pflicht: ja

Bedeutung: Immer 1

name

Pflicht: ja

Bedeutung: Name des Widgets, höchstens 60 Zeichen

version

Pflicht: ja

Bedeutung: Versionsnummer x.y.z, zum Beispiel 1.2.0

sdk

Pflicht: ja

Bedeutung: SDK-Version, heute "1"

entry

Pflicht: nein

Bedeutung: Startdatei, Standard index.html. Muss auf .html enden.

description

Pflicht: nein

Bedeutung: Kurzbeschreibung, höchstens 300 Zeichen

formats

Pflicht: nein

Bedeutung: ["9:16"], ["16:9"] oder beide (Standard: beide)

size

Pflicht: ja

Bedeutung: Größe in Pixeln auf der Overlay-Leinwand: default, min und max als [Breite, Höhe]

permissions

Pflicht: nein

Bedeutung: Welche Daten das Widget bekommt (siehe unten)

settings

Pflicht: nein

Bedeutung: Einstellungen, die Nutzer im Editor ändern (höchstens 40)

locales

Pflicht: nein

Bedeutung: Sprachen, die dein Widget kann, zum Beispiel ["de", "en"]

Die Leinwand ist im Format 9:16 1080 × 1920 Pixel groß, im Format 16:9 1920 × 1080. Größen gehen von 16 bis 3840 Pixel. min und max sind die Grenzen, wenn Nutzer das Widget im Editor größer oder kleiner ziehen. Ohne Angabe gilt default. Bau das Widget in festen Pixeln für default: Wenn Nutzer es größer oder kleiner ziehen, zoomt Livedeck die ganze Seite mit (Text, Bilder und Abstände wachsen zusammen). Bekommt der Rahmen eine andere Form als default, bekommt die Seite den zusätzlichen Platz in dieser Richtung; nutze also 100 % Breite/Höhe, Flexbox oder Grid, wo etwas ausfüllen soll. livedeck.context.size ist die Seitengröße in CSS-Pixeln, livedeck.context.scale der Zoom.

Rechte (permissions)

Käufer sehen die Liste vor dem Kauf, und der Editor zeigt sie unter „Bekommt Zugriff auf“. Frage nur an, was du wirklich brauchst.

events.gift

Geschenke (Ereignis gift)

events.chat

Chat-Nachrichten (chat)

events.like

Likes, gebündelt (like)

events.follow

Neue Follower (follow)

events.share

Geteilte Lives (share)

events.join

Zuschauer kommt in den Live (join)

events.fanclub

Beitritte zum Fanclub (fanclub)

events.viewers

Zuschauerzahl (viewers)

stream.status

Live, offline oder wird geprüft (stream)

media.play

Darf Töne aus Medien-Einstellungen über Livedeck abspielen

host.profile

Name und Profilbild des Streamers (livedeck.host)

Einstellungen (settings)

Jede Einstellung hat einen key, einen type und ein label. Der key beginnt mit einem Kleinbuchstaben, danach folgen Buchstaben, Ziffern oder _ (höchstens 32 Zeichen). Ein label ist Text oder ein Objekt mit Sprachen wie {"de": "Farbe", "en": "Colour"}, höchstens 80 Zeichen. Das Widget liest die Werte aus livedeck.settings.

text

Felder: default, maxLength (höchstens 200)

Wert im Widget: Text

number

Felder: default, min, max, step (alle optional)

Wert im Widget: Zahl

range

Felder: default, min und max (Pflicht), step

Wert im Widget: Zahl, im Editor als Schieberegler

boolean

Felder: default

Wert im Widget: true oder false

color

Felder: default als #rrggbb

Wert im Widget: Farbe als #rrggbb

select

Felder: options (1 bis 50, je value und label), default

Wert im Widget: value der gewählten Option

gift

Felder: default (Geschenk-ID oder null)

Wert im Widget: Geschenk-ID als Zahl oder null

media

Felder: accept: audio, image oder video. Kein default.

Wert im Widget: true, wenn der Nutzer eine eigene Datei gewählt hat, sonst false

Hinweis: Medien-Einstellungen geben dem Widget nie die Adresse der Datei. Töne spielst du mit livedeck.media.play(key) ab, Bilder und Clips holst du mit livedeck.media.url(key).

Fehlt ein Wert oder ist er ungültig, bekommt das Widget den default. So laufen Updates mit neuen Einstellungen auch bei allen, die dein Widget schon nutzen.

Fehler in manifest.json

Scheitert die Prüfung mit „manifest.json ist ungültig“, stehen darunter der Code und die Stelle, zum Beispiel settings[2].default.

manifest_not_object

Die Datei ist kein JSON-Objekt.

manifest_too_large

Die Datei ist größer als 64 KB.

manifest_invalid_json

Kein gültiges JSON (oft ein Komma zu viel oder zu wenig).

unknown_field

Dieses Feld gibt es nicht. Meist ein Tippfehler.

required

Ein Pflichtfeld fehlt.

wrong_type

Falscher Typ, zum Beispiel Text statt Liste.

unsupported_manifest_version

manifestVersion ist nicht 1.

unsupported_sdk

sdk ist nicht "1".

invalid_name

Name leer, länger als 60 Zeichen oder mit unsichtbaren Steuerzeichen.

invalid_text

Text leer, zu lang oder mit unsichtbaren Steuerzeichen.

invalid_version

Version nicht im Format x.y.z (zum Beispiel 1.0.0).

invalid_entry

entry ist kein relativer Pfad zu einer .html-Datei.

invalid_format

Format ist nicht "9:16" oder "16:9".

duplicate

Eintrag doppelt.

invalid_size

Größe außerhalb von 16 bis 3840 Pixeln oder default liegt nicht zwischen min und max.

unknown_permission

Dieses Recht gibt es nicht.

too_many_settings

Mehr als 40 Einstellungen.

invalid_setting_key

key passt nicht zum Muster (siehe oben).

unknown_setting_type

Diesen Einstellungs-Typ gibt es nicht.

invalid_default

default passt nicht zum Typ oder liegt außerhalb der Grenzen.

invalid_bounds

min, max, step oder maxLength ungültig.

invalid_options

options fehlen, sind leer, mehr als 50 oder eine Option hat keinen value.

invalid_media_kind

accept ist nicht audio, image oder video.

invalid_locale

Diese Sprache gibt es nicht. Erlaubt: en, de, tr, fr, es, it, ru, ar, zh-CN, ja, he, pt, nl, pl, uk, ko, hi, id, vi, th.

War dieser Artikel hilfreich?