直播卡片
类别:运营。标签:数字和指标,商店,办公室和工作场所,医疗保健。
布局
此全屏卡在横屏或竖屏时填满整个屏幕,不作为角落、芯片或条带放置。
布局:全屏。表单:横向,纵向。
数据与隐私
此卡使用其配置的属性和实时卡数据。
属性
有关主题、背景、强调色和位置,请参见通用属性。
创建卡片时,在卡片的params中设置静态属性。其数据文档仅包含动态属性。嵌套行描述其父属性的内容。
静态属性
| 名称 | 类型 | 默认 | 数值和限制 | 描述 |
|---|---|---|---|---|
title | string | "Occupancy" | maxLength:40 | |
noun | string | "people" | minLength:1;maxLength:16 | 统计对象:人员、客人、访客、购物者。显示“内部人数”。 |
warnPercent | integer | 80 | 最小值:50;最大值:99 | 从此容量份额看,该看板显示几乎已满。 |
openMessage | string | "Welcome, come in" | maxLength:40 | |
busyMessage | string | "Nearly full" | maxLength:40 | |
fullMessage | string | "Please wait" | maxLength:40 | |
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})?$" | 覆盖主文本和次要文本颜色。强调色和语义状态色保持原有功能。 |
动态属性
| 名称 | 类型 | 默认 | 数值和限制 | 描述 |
|---|---|---|---|---|
inside | integer | 0 | 最小值:0;最大值:99999 | 当前在内的人数。 |
capacity | integer | 0 | 最小值:0;最大值:99999 | 最大容量。0 表示未设置时显示等待状态。 |
footnote | string | "" | maxLength:120 | 板底一行:下一次入场时间,排队地点。 |
previous | 整数,空值 | null | 最小值:0;最大值:99999 | 最新更新前的计数。带有updatedAt时,面板显示该时刻的计数,然后播放变化。 |
updatedAt | string | "" | maxLength:40 | 计数最后变更时间(ISO 8601)。锚定面板时刻;为空则不播放。 |
画布示例
将静态属性保存为 params.json 并创建卡片。结果中包含它的 crd_ ID。
{
"theme": "neomustard"
}
screenrig card create --type occupancy --major 1 --file params.json
将此项目添加到播放列表页面的primitives中,并用该 ID 替换示例中的 ID。发布播放列表并分配屏幕。
{
"id": "occupancy",
"primitive": "card",
"card": "crd_01EXAMPLECARD000000000",
"layout": "full",
"content_fit": "fill"
}
写入实时数据
创建卡片后向其写入文档,之后替换该文档即可更新屏幕,无需重新发布。卡片会按其动态属性检查每次写入,并拒绝它不接受的文档。请使用与播放列表相同的项目。
将文档保存为card-data.json。CLI直接读取文档,无需包装:
{
"inside": 0,
"capacity": 0,
"footnote": "",
"previous": null,
"updatedAt": ""
}
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":{"inside":0,"capacity":0,"footnote":"","previous":null,"updatedAt":""}}'