直播卡片
类别:食品和饮料。标签:餐厅和咖啡馆,商店。
布局
此全屏卡在横屏或竖屏时填满整个屏幕,不作为角落、芯片或条带放置。
布局:全屏。表单:横向,纵向。
数据与隐私
此卡使用其配置的属性和实时卡数据。
属性
有关主题、背景、强调色和位置,请参见通用属性。
创建卡片时,在卡片的params中设置静态属性。其数据文档仅包含动态属性。嵌套行描述其父属性的内容。
静态属性
| 名称 | 类型 | 默认 | 数值和限制 | 描述 |
|---|---|---|---|---|
pageSeconds | integer | 10 | 最小值:4;最大值:60 | 当列表不适合时,每页显示秒数。 |
backgroundColor | 字符串,空值 | null | 模式:"^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$" | 用纯色 CSS 顺序覆盖卡片背景和底板。#RRGGBBAA 提供透明度。背景无则优先。 |
textColor | 字符串,空值 | null | 模式:"^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$" | 覆盖主文本和次要文本颜色。强调色和语义状态色保持原有功能。 |
动态属性
| 名称 | 类型 | 默认 | 数值和限制 | 描述 |
|---|---|---|---|---|
title | string | "" | maxLength:120 | 菜品。 |
subtitle | string | "" | maxLength:80 | 署名行:厨房,厨师,菜品。 |
image | string | "" | maxLength:200 | 菜品照片的项目媒体引用。 |
prep | integer | 0 | 最小值:0;最大值:1440 | 准备时间(分钟)。 |
cook | integer | 0 | 最小值:0;最大值:1440 | 烹饪分钟数。 |
serves | integer | 0 | 最小值:0;最大值:1000 | 它服务多少个。 |
tags | array | [] | minItems:0;maxItems:6 | 简短标记:素食,无麸质,快速。 |
ingredients | array | [] | minItems:0;maxItems:60 | |
ingredients[].heading | string | "" | maxLength:40 | 章节标题,如 For the sauce;替代名称显示。 |
ingredients[].amount | string | "" | maxLength:16 | 数量:2汤匙,400克。 |
ingredients[].name | string | "" | maxLength:80 | 成分。 |
ingredients[].note | string | "" | maxLength:40 | 准备方式:切碎,分割。 |
steps | array | [] | minItems:0;maxItems:40 | |
step | integer | 0 | 最小值:0;最大值:40 | 当前步骤,从 1 开始计数。之前的步骤变暗,当前步骤高亮。0 表示不高亮。 |
tip | string | "" | maxLength:200 | 一个结束提示。 |
stepAt | 字符串,空值 | null | 厨师移动到 step 的 ISO 8601 时间点;Primetime 从此时间点播放下一步时刻。与步骤一起发送。 |
画布示例
将静态属性保存为 params.json 并创建卡片。结果中包含它的 crd_ ID。
{
"theme": "neomustard"
}
screenrig card create --type recipe --major 1 --file params.json
将此项目添加到播放列表页面的primitives中,并用该 ID 替换示例中的 ID。发布播放列表并分配屏幕。
{
"id": "recipe",
"primitive": "card",
"card": "crd_01EXAMPLECARD000000000",
"layout": "full",
"content_fit": "fill"
}
写入实时数据
创建卡片后向其写入文档,之后替换该文档即可更新屏幕,无需重新发布。卡片会按其动态属性检查每次写入,并拒绝它不接受的文档。请使用与播放列表相同的项目。
将文档保存为card-data.json。CLI直接读取文档,无需包装:
{
"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
或直接调用 API。API 将相同文档包装在 document 字段中。智能体令牌已指定其项目,因此不发送项目头;若发送 ScreenRig-Project,必须与令牌项目匹配。通过环境提供 API 授权;详见 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}}'