Livedeck widgets के लिए manifest.json: फ़ील्ड, permissions और एरर कोड
manifest.json का हर फ़ील्ड, permission और सेटिंग टाइप, और हर एरर कोड का मतलब।
manifest.json आपके widget का विवरण है। Livedeck अपलोड पर इसे पढ़ता है, इससे editor की सेटिंग्स बनाता है और widget को सिर्फ़ इसमें लिखी permissions देता है। अनजान फ़ील्ड एरर होते हैं, ताकि टाइपो कभी छिपे न रहें।
{
"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"]
}फ़ील्ड
manifestVersion
ज़रूरी: हाँ
मतलब: हमेशा 1
name
ज़रूरी: हाँ
मतलब: widget का नाम, ज़्यादा से ज़्यादा 60 अक्षर
version
ज़रूरी: हाँ
मतलब: वर्ज़न नंबर x.y.z, जैसे 1.2.0
sdk
ज़रूरी: हाँ
मतलब: SDK वर्ज़न, अभी “1”
entry
ज़रूरी: नहीं
मतलब: स्टार्ट फ़ाइल, डिफ़ॉल्ट index.html। अंत में .html होना ज़रूरी है।
description
ज़रूरी: नहीं
मतलब: छोटा विवरण, ज़्यादा से ज़्यादा 300 अक्षर
formats
ज़रूरी: नहीं
मतलब: ["9:16"], ["16:9"] या दोनों (डिफ़ॉल्ट: दोनों)
size
ज़रूरी: हाँ
मतलब: overlay canvas पर पिक्सल में साइज़: default, min और max, [width, height] के रूप में
permissions
ज़रूरी: नहीं
मतलब: widget को कौन-सा डेटा मिलता है (नीचे देखें)
settings
ज़रूरी: नहीं
मतलब: सेटिंग्स जिन्हें यूज़र editor में बदलते हैं (ज़्यादा से ज़्यादा 40)
locales
ज़रूरी: नहीं
मतलब: आपका widget जिन भाषाओं को सपोर्ट करता है, जैसे ["de", "en"]
| फ़ील्ड | ज़रूरी | मतलब |
|---|---|---|
| manifestVersion | हाँ | हमेशा 1 |
| name | हाँ | widget का नाम, ज़्यादा से ज़्यादा 60 अक्षर |
| version | हाँ | वर्ज़न नंबर x.y.z, जैसे 1.2.0 |
| sdk | हाँ | SDK वर्ज़न, अभी “1” |
| entry | नहीं | स्टार्ट फ़ाइल, डिफ़ॉल्ट index.html। अंत में .html होना ज़रूरी है। |
| description | नहीं | छोटा विवरण, ज़्यादा से ज़्यादा 300 अक्षर |
| formats | नहीं | ["9:16"], ["16:9"] या दोनों (डिफ़ॉल्ट: दोनों) |
| size | हाँ | overlay canvas पर पिक्सल में साइज़: default, min और max, [width, height] के रूप में |
| permissions | नहीं | widget को कौन-सा डेटा मिलता है (नीचे देखें) |
| settings | नहीं | सेटिंग्स जिन्हें यूज़र editor में बदलते हैं (ज़्यादा से ज़्यादा 40) |
| locales | नहीं | आपका widget जिन भाषाओं को सपोर्ट करता है, जैसे ["de", "en"] |
canvas 9:16 में 1080 × 1920 पिक्सल और 16:9 में 1920 × 1080 पिक्सल है। साइज़ 16 से 3840 पिक्सल तक होते हैं। min और max वे सीमाएँ हैं जब यूज़र editor में widget का साइज़ बदलते हैं। इनके बिना default लागू होता है। widget को default के लिए फ़िक्स्ड पिक्सल में बनाएँ: जब यूज़र साइज़ बदलते हैं, Livedeck पूरे पेज को बॉक्स के साथ ज़ूम करता है (टेक्स्ट, तस्वीरें और स्पेसिंग साथ बढ़ते हैं)। अगर बॉक्स का आकार default से अलग हो जाए, तो पेज को उस दिशा में अतिरिक्त जगह मिलती है, इसलिए जहाँ भरना हो वहाँ 100% widths/heights, flexbox या grid इस्तेमाल करें। livedeck.context.size CSS पिक्सल में पेज का साइज़ है और livedeck.context.scale ज़ूम।
अनुमतियाँ
ख़रीदार ख़रीदने से पहले यह लिस्ट देखते हैं, और editor इसे “Gets access to” के नीचे दिखाता है। सिर्फ़ वही माँगें जिसकी आपको सच में ज़रूरत है।
events.gift
गिफ़्ट्स (इवेंट gift)
events.chat
चैट मैसेज (chat)
events.like
लाइक्स, एक साथ (like)
events.follow
नए फ़ॉलोअर्स (follow)
events.share
LIVE के शेयर (share)
events.join
कोई दर्शक LIVE में आता है (join)
events.fanclub
फ़ैन क्लब जॉइन (fanclub)
events.viewers
दर्शकों की संख्या (viewers)
stream.status
लाइव, ऑफ़लाइन या जाँच में (stream)
media.play
मीडिया सेटिंग्स की आवाज़ें Livedeck के ज़रिए चला सकता है
host.profile
स्ट्रीमर का नाम और प्रोफ़ाइल फ़ोटो (livedeck.host)
| Permission | widget को क्या मिलता है |
|---|---|
| events.gift | गिफ़्ट्स (इवेंट gift) |
| events.chat | चैट मैसेज (chat) |
| events.like | लाइक्स, एक साथ (like) |
| events.follow | नए फ़ॉलोअर्स (follow) |
| events.share | LIVE के शेयर (share) |
| events.join | कोई दर्शक LIVE में आता है (join) |
| events.fanclub | फ़ैन क्लब जॉइन (fanclub) |
| events.viewers | दर्शकों की संख्या (viewers) |
| stream.status | लाइव, ऑफ़लाइन या जाँच में (stream) |
| media.play | मीडिया सेटिंग्स की आवाज़ें Livedeck के ज़रिए चला सकता है |
| host.profile | स्ट्रीमर का नाम और प्रोफ़ाइल फ़ोटो (livedeck.host) |
सेटिंग्स
हर सेटिंग में एक key, एक type और एक label होता है। key छोटे अक्षर से शुरू होती है, उसके बाद अक्षर, अंक या _ (ज़्यादा से ज़्यादा 32 अक्षर)। label टेक्स्ट होता है या भाषाओं वाला ऑब्जेक्ट, जैसे {"de": "Farbe", "en": "Colour"}, ज़्यादा से ज़्यादा 80 अक्षर। widget वैल्यू livedeck.settings से पढ़ता है।
text
फ़ील्ड: default, maxLength (ज़्यादा से ज़्यादा 200)
widget में वैल्यू: टेक्स्ट
number
फ़ील्ड: default, min, max, step (सभी वैकल्पिक)
widget में वैल्यू: संख्या
range
फ़ील्ड: default, min और max (ज़रूरी), step
widget में वैल्यू: संख्या, editor में स्लाइडर के रूप में
boolean
फ़ील्ड: default
widget में वैल्यू: true या false
color
फ़ील्ड: default, #rrggbb के रूप में
widget में वैल्यू: रंग, #rrggbb के रूप में
select
फ़ील्ड: options (1 से 50, हर एक में value और label), default
widget में वैल्यू: चुने गए विकल्प की value
gift
फ़ील्ड: default (गिफ़्ट ID या null)
widget में वैल्यू: गिफ़्ट ID संख्या के रूप में, या null
media
फ़ील्ड: accept: audio, image या video। कोई default नहीं।
widget में वैल्यू: true अगर यूज़र ने अपनी फ़ाइल चुनी है, वरना false
| टाइप | फ़ील्ड | widget में वैल्यू |
|---|---|---|
| text | default, maxLength (ज़्यादा से ज़्यादा 200) | टेक्स्ट |
| number | default, min, max, step (सभी वैकल्पिक) | संख्या |
| range | default, min और max (ज़रूरी), step | संख्या, editor में स्लाइडर के रूप में |
| boolean | default | true या false |
| color | default, #rrggbb के रूप में | रंग, #rrggbb के रूप में |
| select | options (1 से 50, हर एक में value और label), default | चुने गए विकल्प की value |
| gift | default (गिफ़्ट ID या null) | गिफ़्ट ID संख्या के रूप में, या null |
| media | accept: audio, image या video। कोई default नहीं। | true अगर यूज़र ने अपनी फ़ाइल चुनी है, वरना false |
अगर कोई value मौजूद नहीं है या गलत है, तो widget को default value मिलती है। इससे नई settings वाले updates उन सभी के लिए काम करते हैं जो पहले से आपका widget इस्तेमाल कर रहे हैं।
manifest.json में errors
अगर जाँच "manifest.json is invalid" के साथ fail होती है, तो उसके नीचे code और जगह दिखाई जाती है, जैसे settings[2].default।
manifest_not_object
फ़ाइल JSON object नहीं है।
manifest_too_large
फ़ाइल 64 KB से बड़ी है।
manifest_invalid_json
JSON सही नहीं है (अक्सर एक comma ज़्यादा या कम होता है)।
unknown_field
यह field मौजूद नहीं है। अक्सर spelling की गलती होती है।
required
एक ज़रूरी field मौजूद नहीं है।
wrong_type
गलत type, जैसे list की जगह text।
unsupported_manifest_version
manifestVersion 1 नहीं है।
unsupported_sdk
sdk "1" नहीं है।
invalid_name
नाम खाली है, 60 characters से लंबा है या उसमें invisible control characters हैं।
invalid_text
Text खाली है, बहुत लंबा है या उसमें invisible control characters हैं।
invalid_version
Version x.y.z रूप में नहीं है (जैसे 1.0.0)।
invalid_entry
entry किसी .html फ़ाइल का relative path नहीं है।
invalid_format
Format "9:16" या "16:9" नहीं है।
duplicate
Duplicate entry।
invalid_size
Size 16 से 3840 pixels के बाहर है, या default min और max के बीच नहीं है।
unknown_permission
यह permission मौजूद नहीं है।
too_many_settings
40 से ज़्यादा settings।
invalid_setting_key
key pattern से मेल नहीं खाता (ऊपर देखें)।
unknown_setting_type
यह setting type मौजूद नहीं है।
invalid_default
default type से मेल नहीं खाता या सीमा से बाहर है।
invalid_bounds
min, max, step या maxLength गलत है।
invalid_options
options मौजूद नहीं हैं, खाली हैं, 50 से ज़्यादा हैं, या किसी option की value नहीं है।
invalid_media_kind
accept audio, image या video नहीं है।
invalid_locale
यह भाषा मौजूद नहीं है। अनुमत: en, de, tr, fr, es, it, ru, ar, zh-CN, ja, he, pt, nl, pl, uk, ko, hi, id, vi, th।
| कोड | मतलब |
|---|---|
| manifest_not_object | फ़ाइल JSON object नहीं है। |
| manifest_too_large | फ़ाइल 64 KB से बड़ी है। |
| manifest_invalid_json | JSON सही नहीं है (अक्सर एक comma ज़्यादा या कम होता है)। |
| unknown_field | यह field मौजूद नहीं है। अक्सर spelling की गलती होती है। |
| required | एक ज़रूरी field मौजूद नहीं है। |
| wrong_type | गलत type, जैसे list की जगह text। |
| unsupported_manifest_version | manifestVersion 1 नहीं है। |
| unsupported_sdk | sdk "1" नहीं है। |
| invalid_name | नाम खाली है, 60 characters से लंबा है या उसमें invisible control characters हैं। |
| invalid_text | Text खाली है, बहुत लंबा है या उसमें invisible control characters हैं। |
| invalid_version | Version x.y.z रूप में नहीं है (जैसे 1.0.0)। |
| invalid_entry | entry किसी .html फ़ाइल का relative path नहीं है। |
| invalid_format | Format "9:16" या "16:9" नहीं है। |
| duplicate | Duplicate entry। |
| invalid_size | Size 16 से 3840 pixels के बाहर है, या default min और max के बीच नहीं है। |
| unknown_permission | यह permission मौजूद नहीं है। |
| too_many_settings | 40 से ज़्यादा settings। |
| invalid_setting_key | key pattern से मेल नहीं खाता (ऊपर देखें)। |
| unknown_setting_type | यह setting type मौजूद नहीं है। |
| invalid_default | default type से मेल नहीं खाता या सीमा से बाहर है। |
| invalid_bounds | min, max, step या maxLength गलत है। |
| invalid_options | options मौजूद नहीं हैं, खाली हैं, 50 से ज़्यादा हैं, या किसी option की value नहीं है। |
| invalid_media_kind | accept audio, image या video नहीं है। |
| invalid_locale | यह भाषा मौजूद नहीं है। अनुमत: en, de, tr, fr, es, it, ru, ar, zh-CN, ja, he, pt, nl, pl, uk, ko, hi, id, vi, th। |
क्या यह लेख मददगार था?