Livedeck widget’ları için manifest.json: alanlar, izinler ve hata kodları
manifest.json’daki tüm alanlar, izinler ve ayar türleri ile her hata kodunun anlamı.
manifest.json widget’ını tanımlar. Livedeck yüklemede onu okur, editör ayarlarını ondan oluşturur ve widget’a yalnızca orada listelenen izinleri verir. Bilinmeyen alanlar hata sayılır, böylece yazım hataları gizli kalmaz.
{
"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"]
}Alanlar
manifestVersion
Zorunlu: evet
Anlamı: Her zaman 1
name
Zorunlu: evet
Anlamı: Widget’ın adı, en fazla 60 karakter
version
Zorunlu: evet
Anlamı: x.y.z biçiminde sürüm numarası, örneğin 1.2.0
sdk
Zorunlu: evet
Anlamı: SDK sürümü, şu an "1"
entry
Zorunlu: hayır
Anlamı: Başlangıç dosyası, varsayılan index.html. .html ile bitmeli.
description
Zorunlu: hayır
Anlamı: Kısa açıklama, en fazla 300 karakter
formats
Zorunlu: hayır
Anlamı: ["9:16"], ["16:9"] veya ikisi (varsayılan: ikisi)
size
Zorunlu: evet
Anlamı: Overlay tuvalindeki piksel boyutu: default, min ve max, [genişlik, yükseklik] olarak
permissions
Zorunlu: hayır
Anlamı: Widget’ın hangi verileri aldığı (aşağıya bak)
settings
Zorunlu: hayır
Anlamı: Kullanıcıların editörde değiştirdiği ayarlar (en fazla 40)
locales
Zorunlu: hayır
Anlamı: Widget’ının desteklediği diller, örneğin ["de", "en"]
| Alan | Zorunlu | Anlamı |
|---|---|---|
| manifestVersion | evet | Her zaman 1 |
| name | evet | Widget’ın adı, en fazla 60 karakter |
| version | evet | x.y.z biçiminde sürüm numarası, örneğin 1.2.0 |
| sdk | evet | SDK sürümü, şu an "1" |
| entry | hayır | Başlangıç dosyası, varsayılan index.html. .html ile bitmeli. |
| description | hayır | Kısa açıklama, en fazla 300 karakter |
| formats | hayır | ["9:16"], ["16:9"] veya ikisi (varsayılan: ikisi) |
| size | evet | Overlay tuvalindeki piksel boyutu: default, min ve max, [genişlik, yükseklik] olarak |
| permissions | hayır | Widget’ın hangi verileri aldığı (aşağıya bak) |
| settings | hayır | Kullanıcıların editörde değiştirdiği ayarlar (en fazla 40) |
| locales | hayır | Widget’ının desteklediği diller, örneğin ["de", "en"] |
Tuval 9:16’da 1080 × 1920, 16:9’da 1920 × 1080 pikseldir. Boyutlar 16 ile 3840 piksel arasındadır. min ve max, kullanıcılar widget’ı editörde yeniden boyutlandırırken geçerli sınırlardır. Bunlar yoksa default geçerli olur. Widget’ı default için sabit piksellerle yap: kullanıcılar boyutunu değiştirdiğinde Livedeck tüm sayfayı kutuyla birlikte yakınlaştırır (metin, resimler ve boşluklar birlikte büyür). Kutu default’tan farklı bir şekil alırsa sayfa o yönde ek alan kazanır; bu yüzden doldurması gereken yerlerde %100 genişlik/yükseklik, flexbox veya grid kullan. livedeck.context.size, CSS pikseli cinsinden sayfa boyutu, livedeck.context.scale ise yakınlaştırma oranıdır.
İzinler
Alıcılar bu listeyi satın almadan önce görür, editör de bunu "Erişebildikleri" altında gösterir. Yalnızca gerçekten ihtiyacın olanı iste.
events.gift
Hediyeler (gift olayı)
events.chat
Sohbet mesajları (chat)
events.like
Beğeniler, toplu (like)
events.follow
Yeni takipçiler (follow)
events.share
LIVE paylaşımları (share)
events.join
Bir izleyici LIVE’a katılır (join)
events.fanclub
Hayran kulübü katılımları (fanclub)
events.viewers
İzleyici sayısı (viewers)
stream.status
Canlı, çevrimdışı veya kontrol ediliyor (stream)
media.play
Medya ayarlarındaki sesleri Livedeck üzerinden çalabilir
host.profile
Yayıncının adı ve profil resmi (livedeck.host)
| İzin | Widget’ın aldığı |
|---|---|
| events.gift | Hediyeler (gift olayı) |
| events.chat | Sohbet mesajları (chat) |
| events.like | Beğeniler, toplu (like) |
| events.follow | Yeni takipçiler (follow) |
| events.share | LIVE paylaşımları (share) |
| events.join | Bir izleyici LIVE’a katılır (join) |
| events.fanclub | Hayran kulübü katılımları (fanclub) |
| events.viewers | İzleyici sayısı (viewers) |
| stream.status | Canlı, çevrimdışı veya kontrol ediliyor (stream) |
| media.play | Medya ayarlarındaki sesleri Livedeck üzerinden çalabilir |
| host.profile | Yayıncının adı ve profil resmi (livedeck.host) |
Ayarlar
Her ayarın bir key’i, type’ı ve label’ı vardır. key küçük harfle başlar, ardından harf, rakam veya _ gelir (en fazla 32 karakter). label bir metin ya da {"de": "Farbe", "en": "Colour"} gibi dilleri içeren bir nesnedir, en fazla 80 karakter. Widget değerleri livedeck.settings’ten okur.
text
Alanlar: default, maxLength (en fazla 200)
Widget’taki değer: Metin
number
Alanlar: default, min, max, step (hepsi isteğe bağlı)
Widget’taki değer: Sayı
range
Alanlar: default, min ve max (zorunlu), step
Widget’taki değer: Sayı, editörde kaydırıcı olarak gösterilir
boolean
Alanlar: default
Widget’taki değer: true veya false
color
Alanlar: #rrggbb olarak default
Widget’taki değer: #rrggbb olarak renk
select
Alanlar: options (1 ile 50 arası, her biri value ve label ile), default
Widget’taki değer: Seçilen seçeneğin value’su
gift
Alanlar: default (hediye ID’si veya null)
Widget’taki değer: Sayı olarak hediye ID’si veya null
media
Alanlar: accept: audio, image veya video. default yok.
Widget’taki değer: Kullanıcı kendi dosyasını seçtiyse true, aksi halde false
| Tür | Alanlar | Widget’taki değer |
|---|---|---|
| text | default, maxLength (en fazla 200) | Metin |
| number | default, min, max, step (hepsi isteğe bağlı) | Sayı |
| range | default, min ve max (zorunlu), step | Sayı, editörde kaydırıcı olarak gösterilir |
| boolean | default | true veya false |
| color | #rrggbb olarak default | #rrggbb olarak renk |
| select | options (1 ile 50 arası, her biri value ve label ile), default | Seçilen seçeneğin value’su |
| gift | default (hediye ID’si veya null) | Sayı olarak hediye ID’si veya null |
| media | accept: audio, image veya video. default yok. | Kullanıcı kendi dosyasını seçtiyse true, aksi halde false |
Bir değer eksik ya da geçersizse widget varsayılan değeri alır. Böylece yeni ayarlar içeren güncellemeler, widget’ını zaten kullanan herkeste çalışır.
manifest.json hataları
Kontrol "manifest.json is invalid" hatasıyla başarısız olursa, altında kod ve konum listelenir, örneğin settings[2].default.
manifest_not_object
Dosya bir JSON nesnesi değil.
manifest_too_large
Dosya 64 KB’tan büyük.
manifest_invalid_json
Geçerli JSON değil (çoğu zaman bir virgül fazla ya da eksik).
unknown_field
Bu alan yok. Genelde yazım hatası.
required
Zorunlu bir alan eksik.
wrong_type
Yanlış tür, örneğin liste yerine metin.
unsupported_manifest_version
manifestVersion 1 değil.
unsupported_sdk
sdk "1" değil.
invalid_name
Ad boş, 60 karakterden uzun ya da görünmez kontrol karakterleri içeriyor.
invalid_text
Metin boş, çok uzun ya da görünmez kontrol karakterleri içeriyor.
invalid_version
Sürüm x.y.z biçiminde değil (örneğin 1.0.0).
invalid_entry
entry, bir .html dosyasına giden göreli yol değil.
invalid_format
Format "9:16" ya da "16:9" değil.
duplicate
Yinelenen giriş.
invalid_size
Boyut 16–3840 piksel aralığının dışında ya da default, min ile max arasında değil.
unknown_permission
Bu izin yok.
too_many_settings
40’tan fazla ayar.
invalid_setting_key
key kalıba uymuyor (yukarıya bak).
unknown_setting_type
Bu ayar türü yok.
invalid_default
default türe uymuyor ya da sınırların dışında.
invalid_bounds
min, max, step ya da maxLength geçersiz.
invalid_options
options eksik, boş, 50’den fazla ya da bir seçeneğin value’su yok.
invalid_media_kind
accept; audio, image ya da video değil.
invalid_locale
Bu dil yok. İzin verilenler: en, de, tr, fr, es, it, ru, ar, zh-CN, ja, he, pt, nl, pl, uk, ko, hi, id, vi, th.
| Kod | Anlamı |
|---|---|
| manifest_not_object | Dosya bir JSON nesnesi değil. |
| manifest_too_large | Dosya 64 KB’tan büyük. |
| manifest_invalid_json | Geçerli JSON değil (çoğu zaman bir virgül fazla ya da eksik). |
| unknown_field | Bu alan yok. Genelde yazım hatası. |
| required | Zorunlu bir alan eksik. |
| wrong_type | Yanlış tür, örneğin liste yerine metin. |
| unsupported_manifest_version | manifestVersion 1 değil. |
| unsupported_sdk | sdk "1" değil. |
| invalid_name | Ad boş, 60 karakterden uzun ya da görünmez kontrol karakterleri içeriyor. |
| invalid_text | Metin boş, çok uzun ya da görünmez kontrol karakterleri içeriyor. |
| invalid_version | Sürüm x.y.z biçiminde değil (örneğin 1.0.0). |
| invalid_entry | entry, bir .html dosyasına giden göreli yol değil. |
| invalid_format | Format "9:16" ya da "16:9" değil. |
| duplicate | Yinelenen giriş. |
| invalid_size | Boyut 16–3840 piksel aralığının dışında ya da default, min ile max arasında değil. |
| unknown_permission | Bu izin yok. |
| too_many_settings | 40’tan fazla ayar. |
| invalid_setting_key | key kalıba uymuyor (yukarıya bak). |
| unknown_setting_type | Bu ayar türü yok. |
| invalid_default | default türe uymuyor ya da sınırların dışında. |
| invalid_bounds | min, max, step ya da maxLength geçersiz. |
| invalid_options | options eksik, boş, 50’den fazla ya da bir seçeneğin value’su yok. |
| invalid_media_kind | accept; audio, image ya da video değil. |
| invalid_locale | Bu dil yok. İzin verilenler: en, de, tr, fr, es, it, ru, ar, zh-CN, ja, he, pt, nl, pl, uk, ko, hi, id, vi, th. |
Bu makale işine yaradı mı?