manifest.json untuk widget Livedeck: field, permission, dan kode error

Semua field, permission, dan tipe setting di manifest.json, serta arti setiap kode error.

8 menit baca Diperbarui 4 Nov 2026

manifest.json mendeskripsikan widget kamu. Livedeck membacanya saat upload, membuat pengaturan editor darinya, dan hanya memberi widget permission yang tercantum di dalamnya. Field yang tidak dikenal dianggap error, jadi typo nggak akan tersembunyi.

json
{
  "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"]
}

Field

manifestVersion

Wajib diisi: ya

Arti: Selalu 1

name

Wajib diisi: ya

Arti: Nama widget, maksimal 60 karakter

version

Wajib diisi: ya

Arti: Nomor versi x.y.z, misalnya 1.2.0

sdk

Wajib diisi: ya

Arti: Versi SDK, saat ini "1"

entry

Wajib diisi: tidak

Arti: File awal, default-nya index.html. Harus berakhiran .html.

description

Wajib diisi: tidak

Arti: Deskripsi singkat, maksimal 300 karakter

formats

Wajib diisi: tidak

Arti: ["9:16"], ["16:9"] atau keduanya (default: keduanya)

size

Wajib diisi: ya

Arti: Ukuran dalam piksel di canvas overlay: default, min, dan max sebagai [lebar, tinggi]

permissions

Wajib diisi: tidak

Arti: Data apa saja yang diterima widget (lihat di bawah)

settings

Wajib diisi: tidak

Arti: Pengaturan yang bisa diubah pengguna di editor (maksimal 40)

locales

Wajib diisi: tidak

Arti: Bahasa yang didukung widget kamu, misalnya ["de", "en"]

Canvas berukuran 1080 × 1920 piksel di 9:16 dan 1920 × 1080 di 16:9. Ukuran berkisar dari 16 sampai 3840 piksel. min dan max adalah batas saat pengguna mengubah ukuran widget di editor. Tanpa keduanya, berlaku default. Buat widget dengan piksel tetap untuk default: saat pengguna mengubah ukurannya, Livedeck men-zoom seluruh halaman bersama kotaknya (teks, gambar, dan jarak ikut membesar). Kalau bentuk kotaknya berbeda dari default, halaman mendapat ruang tambahan ke arah itu, jadi pakai lebar/tinggi 100%, flexbox, atau grid di bagian yang harus memenuhi ruang. livedeck.context.size adalah ukuran halaman dalam piksel CSS dan livedeck.context.scale adalah zoom-nya.

Izin

Pembeli melihat daftar ini sebelum membeli, dan editor menampilkannya di bawah "Gets access to". Minta hanya yang benar-benar kamu butuhkan.

events.gift

Gift (event gift)

events.chat

Pesan chat (chat)

events.like

Like, digabung (like)

events.follow

Pengikut baru (follow)

events.share

Bagikan LIVE (share)

events.join

Penonton bergabung ke LIVE (join)

events.fanclub

Bergabung ke fan club (fanclub)

events.viewers

Jumlah penonton (viewers)

stream.status

Live, offline, atau sedang dicek (stream)

media.play

Boleh memutar suara dari pengaturan media lewat Livedeck

host.profile

Nama dan foto profil streamer (livedeck.host)

Pengaturan

Setiap setting punya key, type, dan label. Key diawali huruf kecil, lalu diikuti huruf, angka, atau _ (maksimal 32 karakter). Label berupa teks atau objek dengan bahasa seperti {"de": "Farbe", "en": "Colour"}, maksimal 80 karakter. Widget membaca nilainya dari livedeck.settings.

text

Field: default, maxLength (maksimal 200)

Nilai di widget: Teks

number

Field: default, min, max, step (semuanya opsional)

Nilai di widget: Angka

range

Field: default, min dan max (wajib), step

Nilai di widget: Angka, ditampilkan sebagai slider di editor

boolean

Field: default

Nilai di widget: true atau false

color

Field: default sebagai #rrggbb

Nilai di widget: Warna sebagai #rrggbb

select

Field: options (1 sampai 50, masing-masing dengan value dan label), default

Nilai di widget: value dari opsi yang dipilih

gift

Field: default (ID gift atau null)

Nilai di widget: ID gift sebagai angka, atau null

media

Field: accept: audio, image, atau video. Tanpa default.

Nilai di widget: true kalau pengguna memilih file sendiri, selain itu false

Catatan: Pengaturan media tidak pernah memberikan alamat file ke widget. Putar suara dengan livedeck.media.play(key); ambil gambar dan klip dengan livedeck.media.url(key).

Kalau sebuah nilai kosong atau tidak valid, widget akan mendapat nilai default. Dengan begitu, update dengan pengaturan baru tetap jalan untuk semua orang yang sudah memakai widget kamu.

Error di manifest.json

Kalau pengecekan gagal dengan "manifest.json is invalid", kode dan lokasinya ditampilkan di bawahnya, misalnya settings[2].default.

manifest_not_object

File ini bukan objek JSON.

manifest_too_large

File lebih besar dari 64 KB.

manifest_invalid_json

JSON tidak valid (sering karena kelebihan atau kekurangan satu koma).

unknown_field

Field ini tidak ada. Biasanya salah ketik.

required

Ada field wajib yang belum diisi.

wrong_type

Tipe salah, misalnya teks padahal seharusnya daftar.

unsupported_manifest_version

manifestVersion bukan 1.

unsupported_sdk

sdk bukan "1".

invalid_name

Nama kosong, lebih dari 60 karakter, atau berisi karakter kontrol tak terlihat.

invalid_text

Teks kosong, terlalu panjang, atau berisi karakter kontrol tak terlihat.

invalid_version

Versi tidak berformat x.y.z (misalnya 1.0.0).

invalid_entry

entry bukan path relatif ke file .html.

invalid_format

Format bukan "9:16" atau "16:9".

duplicate

Entri ganda.

invalid_size

Ukuran di luar 16 sampai 3840 piksel, atau default tidak berada di antara min dan max.

unknown_permission

Izin ini tidak ada.

too_many_settings

Lebih dari 40 pengaturan.

invalid_setting_key

key tidak sesuai pola (lihat di atas).

unknown_setting_type

Tipe pengaturan ini tidak ada.

invalid_default

default tidak cocok dengan tipenya atau di luar batas.

invalid_bounds

min, max, step, atau maxLength tidak valid.

invalid_options

options tidak ada, kosong, lebih dari 50, atau ada opsi tanpa value.

invalid_media_kind

accept bukan audio, image, atau video.

invalid_locale

Bahasa ini tidak ada. Yang diizinkan: en, de, tr, fr, es, it, ru, ar, zh-CN, ja, he, pt, nl, pl, uk, ko, hi, id, vi, th.

Apakah artikel ini membantu?