直播卡片
类别:运营。标签:导向和目录,数字和指标,办公室和工作场所,交通和旅行。
布局
此全屏卡在横屏或竖屏时填满整个屏幕,不作为角落、芯片或条带放置。
布局:全屏。表单:横向,纵向。
数据与隐私
此卡使用其配置的属性和实时卡数据。
属性
有关主题、背景、强调色和位置,请参见通用属性。
创建卡片时,在卡片的params中设置静态属性。其数据文档仅包含动态属性。嵌套行描述其父属性的内容。
静态属性
| 名称 | 类型 | 默认 | 数值和限制 | 描述 |
|---|---|---|---|---|
title | string | "Availability" | maxLength:40 | |
order | string | "listed" | "listed", "most-free", "least-free", "name" | 列表:按给定顺序。最多空闲或最少空闲按空闲数量排序,关闭和未知排最后。名称:A 到 Z。 |
lowPercent | integer | 20 | 最小值:1;最大值:99 | 低于此空闲份额时,磁贴显示正在填充。 |
freeWord | string | "free" | minLength:1;maxLength:12 | 计数后面的词:免费、开放、可用、空闲。 |
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})?$" | 覆盖主文本和次要文本颜色。强调色和语义状态色保持原有功能。 |
动态属性
| 名称 | 类型 | 默认 | 数值和限制 | 描述 |
|---|---|---|---|---|
items | array | [] | minItems:0;maxItems:12 | |
items[].name | string | minLength:1;maxLength:40;必填 | ||
items[].free | integer | 最小值:0;最大值:99999 | 当前空闲数量。未显示时,瓷砖显示为破折号。设置总数时,永远不会超过总数。 | |
items[].total | integer | 0 | 最小值:0;最大值:99999 | 容量。0 或省略时仅显示空闲数量,无进度条。 |
items[].closed | boolean | false | ||
items[].note | string | "" | maxLength:40 | 名字下方的一行:区域、楼层、原因。 |
items[].since | string | "" | maxLength:32 | 此计数最后变更时间(带偏移的 ISO 8601)。黄金时段将变更时刻锚定于此,使所有屏幕同步显示。 |
items[].was | integer | 最小值:0;最大值:99999 | 该变更前的空闲计数。带since时,刚满员的图块翻转为“满员”,其他计数上下滚动。 | |
footnote | string | "" | maxLength:120 |
画布示例
将静态属性保存为 params.json 并创建卡片。结果中包含它的 crd_ ID。
{
"theme": "neomustard"
}
screenrig card create --type availability --major 1 --file params.json
将此项目添加到播放列表页面的primitives中,并用该 ID 替换示例中的 ID。发布播放列表并分配屏幕。
{
"id": "availability",
"primitive": "card",
"card": "crd_01EXAMPLECARD000000000",
"layout": "full",
"content_fit": "fill"
}
写入实时数据
创建卡片后向其写入文档,之后替换该文档即可更新屏幕,无需重新发布。卡片会按其动态属性检查每次写入,并拒绝它不接受的文档。请使用与播放列表相同的项目。
将文档保存为card-data.json。CLI直接读取文档,无需包装:
{
"items": [],
"footnote": ""
}
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":{"items":[],"footnote":""}}'