manifest.json para widgets do Livedeck: campos, permissões e códigos de erro

Todos os campos, permissões e tipos de configuração do manifest.json, e o que significa cada código de erro.

8 min de leitura Atualizado em 4 de nov. de 2026

O manifest.json descreve seu widget. O Livedeck o lê no envio, monta as configurações do editor a partir dele e dá ao widget só as permissões listadas nele. Campos desconhecidos geram erro, para que erros de digitação nunca passem despercebidos.

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

Campos

manifestVersion

Obrigatório: sim

Significado: Sempre 1

name

Obrigatório: sim

Significado: Nome do widget, no máximo 60 caracteres

version

Obrigatório: sim

Significado: Número da versão x.y.z, por exemplo 1.2.0

sdk

Obrigatório: sim

Significado: Versão do SDK, hoje "1"

entry

Obrigatório: não

Significado: Arquivo inicial, index.html por padrão. Precisa terminar em .html.

description

Obrigatório: não

Significado: Descrição curta, no máximo 300 caracteres

formats

Obrigatório: não

Significado: ["9:16"], ["16:9"] ou ambos (padrão: ambos)

size

Obrigatório: sim

Significado: Tamanho em pixels no canvas do overlay: default, min e max como [largura, altura]

permissions

Obrigatório: não

Significado: Quais dados o widget recebe (veja abaixo)

settings

Obrigatório: não

Significado: Configurações que os usuários alteram no editor (no máximo 40)

locales

Obrigatório: não

Significado: Idiomas que seu widget suporta, por exemplo ["de", "en"]

O canvas tem 1080 × 1920 pixels em 9:16 e 1920 × 1080 em 16:9. Os tamanhos vão de 16 a 3840 pixels. min e max são os limites quando os usuários redimensionam o widget no editor. Sem eles, vale o default. Crie o widget em pixels fixos para o default: quando os usuários o redimensionam, o Livedeck aplica zoom na página inteira junto com a caixa (texto, imagens e espaçamentos crescem juntos). Se a caixa ficar com um formato diferente do default, a página ganha o espaço extra nessa direção, então use larguras/alturas de 100%, flexbox ou grid onde ela deve preencher. livedeck.context.size é o tamanho da página em pixels CSS e livedeck.context.scale é o zoom.

Permissões

Os compradores veem esta lista antes de comprar, e o editor a mostra em “Tem acesso a”. Peça só o que você realmente precisa.

events.gift

Presentes (evento gift)

events.chat

Mensagens do chat (chat)

events.like

Curtidas, agrupadas (like)

events.follow

Novos seguidores (follow)

events.share

Compartilhamentos da LIVE (share)

events.join

Um espectador entra na LIVE (join)

events.fanclub

Entradas no fã-clube (fanclub)

events.viewers

Número de espectadores (viewers)

stream.status

Ao vivo, offline ou em verificação (stream)

media.play

Pode tocar sons das configurações de mídia pelo Livedeck

host.profile

Nome e foto de perfil do streamer (livedeck.host)

Configurações

Toda configuração tem uma key, um type e um label. A key começa com uma letra minúscula seguida de letras, números ou _ (no máximo 32 caracteres). Um label é um texto ou um objeto com idiomas, como {"de": "Farbe", "en": "Colour"}, no máximo 80 caracteres. O widget lê os valores em livedeck.settings.

text

Campos: default, maxLength (no máximo 200)

Valor no widget: Texto

number

Campos: default, min, max, step (todos opcionais)

Valor no widget: Número

range

Campos: default, min e max (obrigatórios), step

Valor no widget: Número, exibido como controle deslizante no editor

boolean

Campos: default

Valor no widget: true ou false

color

Campos: default como #rrggbb

Valor no widget: Cor como #rrggbb

select

Campos: options (1 a 50, cada uma com value e label), default

Valor no widget: value da opção escolhida

gift

Campos: default (ID do presente ou null)

Valor no widget: ID do presente como número, ou null

media

Campos: accept: audio, image ou video. Sem default.

Valor no widget: true quando o usuário escolheu um arquivo próprio, senão false

Observação: As configurações de mídia nunca passam o endereço do arquivo para o widget. Toque sons com livedeck.media.play(key); pegue imagens e clipes com livedeck.media.url(key).

Quando um valor está faltando ou é inválido, o widget recebe o padrão. Assim, atualizações com novas configurações funcionam para todo mundo que já usa seu widget.

Erros no manifest.json

Quando a verificação falha com “manifest.json is invalid”, o código e o local aparecem logo abaixo, por exemplo settings[2].default.

manifest_not_object

O arquivo não é um objeto JSON.

manifest_too_large

O arquivo tem mais de 64 KB.

manifest_invalid_json

JSON inválido (geralmente uma vírgula a mais ou a menos).

unknown_field

Esse campo não existe. Geralmente é erro de digitação.

required

Falta um campo obrigatório.

wrong_type

Tipo errado, por exemplo texto em vez de lista.

unsupported_manifest_version

manifestVersion não é 1.

unsupported_sdk

sdk não é “1”.

invalid_name

Nome vazio, com mais de 60 caracteres ou com caracteres de controle invisíveis.

invalid_text

Texto vazio, longo demais ou com caracteres de controle invisíveis.

invalid_version

Versão fora do formato x.y.z (por exemplo 1.0.0).

invalid_entry

entry não é um caminho relativo para um arquivo .html.

invalid_format

O formato não é “9:16” nem “16:9”.

duplicate

Entrada duplicada.

invalid_size

Tamanho fora de 16 a 3840 pixels, ou default não está entre min e max.

unknown_permission

Essa permissão não existe.

too_many_settings

Mais de 40 configurações.

invalid_setting_key

key não segue o padrão (veja acima).

unknown_setting_type

Esse tipo de configuração não existe.

invalid_default

default não combina com o tipo ou está fora dos limites.

invalid_bounds

min, max, step ou maxLength é inválido.

invalid_options

options está faltando, vazio, tem mais de 50 ou uma opção não tem value.

invalid_media_kind

accept não é audio, image nem video.

invalid_locale

Esse idioma não existe. Permitidos: en, de, tr, fr, es, it, ru, ar, zh-CN, ja, he, pt, nl, pl, uk, ko, hi, id, vi, th.

Este artigo foi útil?