Cartão Receita

Uma receita de relance: o prato e sua foto, tempo e porções, os ingredientes e o método numerado, com o passo sendo preparado destacado.

Cartão ao vivo

Este cartão é desenhado no seu navegador pelo mesmo código que os Players executam, com dados de exemplo.

Categoria: Alimentação e bebida. Etiquetas: Restaurantes e cafés, Lojas.

Layouts

Este cartão em tela cheia preenche toda a tela em paisagem ou retrato e não é colocado como canto, chip ou faixa.

Layouts: cheio. Formas: paisagem, retrato.

Layouts, temas e publicação de cartões. Veja os cartões.

Dados e privacidade

Este cartão usa suas propriedades configuradas e dados ao vivo do cartão.

Propriedades

Para tema, fundo, destaque e posição, veja Propriedades comuns.

Defina as propriedades estáticas nos params do cartão ao criá-lo. O documento de dados dele contém apenas propriedades dinâmicas. Linhas aninhadas descrevem o conteúdo da propriedade pai.

Propriedades estáticas

NomeTipoPadrãoValores e limitesDescrição
pageSecondsinteger10mínimo: 4; máximo: 60Quando as listas não cabem, os segundos que cada página permanece visível.
backgroundColorstring, nulonullpadrão: "^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"Substitui o fundo e a placa do cartão por uma cor plana ordenada por CSS. #RRGGBBAA fornece opacidade. background none tem precedência.
textColorstring, nulonullpadrão: "^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"Substitui as cores do texto principal e secundário. As cores de destaque e status semântico mantêm seus papéis.

Propriedades dinâmicas

NomeTipoPadrãoValores e limitesDescrição
titlestring""maxLength: 120O prato.
subtitlestring""maxLength: 80Uma linha de crédito: a cozinha, o cozinheiro, o prato.
imagestring""maxLength: 200Uma referência de mídia do projeto para a foto do prato.
prepinteger0mínimo: 0; máximo: 1440Minutos de preparo.
cookinteger0mínimo: 0; máximo: 1440Minutos de cozimento.
servesinteger0mínimo: 0; máximo: 1000Quantos ele atende.
tagsarray[]minItems: 0; maxItems: 6Marcas curtas: Vegetariano, Sem glúten, Rápido.
ingredientsarray[]minItems: 0; maxItems: 60
ingredients[].headingstring""maxLength: 40Um título de seção como Para o molho; substitui o nome.
ingredients[].amountstring""maxLength: 16A quantidade: 2 colheres de sopa, 400 g.
ingredients[].namestring""maxLength: 80O ingrediente.
ingredients[].notestring""maxLength: 40Preparado como: picado, dividido.
stepsarray[]minItems: 0; maxItems: 40
stepinteger0mínimo: 0; máximo: 40A etapa que está sendo executada, contando a partir de 1. Etapas anteriores ficam esmaecidas e esta é destacada. 0 não destaca nenhuma.
tipstring""maxLength: 200Uma dica de fechamento.
stepAtstring, nulonullInstante ISO 8601 em que o cozinheiro passou para step; Primetime reproduz o momento do próximo passo a partir dele. Envie junto com o passo.

Exemplo de tela

Salve as propriedades estáticas como params.json e crie o cartão. O resultado traz o id crd_ dele.

{
  "theme": "neomustard"
}
screenrig card create --type recipe --major 1 --file params.json

Adicione este item aos primitives de uma página da playlist, com esse id no lugar do id do exemplo. Publique a playlist e atribua uma tela.

{
  "id": "recipe",
  "primitive": "card",
  "card": "crd_01EXAMPLECARD000000000",
  "layout": "full",
  "content_fit": "fill"
}

Escrever dados ao vivo

Escreva o documento no cartão depois de criá-lo e depois substitua-o para atualizar a tela sem republicar. O cartão verifica cada gravação contra suas propriedades dinâmicas e recusa um documento que ele rejeita. Use o mesmo projeto da playlist.

Salve o documento como card-data.json. O CLI lê o documento em si, sem invólucro:

{
  "title": "",
  "subtitle": "",
  "image": "",
  "prep": 0,
  "cook": 0,
  "serves": 0,
  "tags": [],
  "ingredients": [],
  "steps": [],
  "step": 0,
  "tip": "",
  "stepAt": null
}
screenrig card data put crd_01EXAMPLECARD000000000 --file card-data.json

Ou chame a API diretamente. A API envolve o mesmo documento em um campo document. Um token de agente já nomeia seu projeto, então nenhum cabeçalho de projeto é enviado; se você enviar ScreenRig-Project, ele deve corresponder ao projeto do token. Forneça sua autorização de API pelo ambiente; veja Autenticação da API.

curl --request PUT "https://api.screenrig.ai/api/cards/crd_01EXAMPLECARD000000000/data" \
  --header "Authorization: Bearer $SCREENRIG_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{"document":{"title":"","subtitle":"","image":"","prep":0,"cook":0,"serves":0,"tags":[],"ingredients":[],"steps":[],"step":0,"tip":"","stepAt":null}}'