显示提供的屏幕信息,包括物理分辨率、平台、播放器版本、播放列表、报告的正常运行时间和可用存储。快照过旧或未来时间时连接状态变为未知。网络详情和屏幕标识符除非启用,否则隐藏,且可选帮助链接以静态二维码形式出现。黄金时段增加弹簧进入和缓慢的显示器线条。
直播卡片
类别:运营。标签:数字和指标,办公室和工作场所,大厅和接待区。
布局
此全屏卡在横屏或竖屏时填满整个屏幕,不作为角落、芯片或条带放置。
布局:全屏。表单:横向,纵向。
数据与隐私
此卡使用其配置的属性和实时卡数据。
设备和网络元数据;网络地址和标识默认隐藏。上游访问控制管理提供的快照。
属性
有关主题、背景、强调色和位置,请参见通用属性。
创建卡片时,在卡片的params中设置静态属性。其数据文档仅包含动态属性。嵌套行描述其父属性的内容。
静态属性
| 名称 | 类型 | 默认 | 数值和限制 | 描述 |
|---|---|---|---|---|
title | string | "Screen information" | maxLength:100 | |
staleMinutes | integer | 5 | 最小值:1;最大值:1440 | |
showNetwork | boolean | false | ||
showId | boolean | false | ||
helpUrl | string | "" | maxLength:2048 | |
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})?$" | 覆盖主文本和次要文本颜色。强调色和语义状态色保持原有功能。 |
动态属性
| 名称 | 类型 | 默认 | 数值和限制 | 描述 |
|---|---|---|---|---|
snapshot | 对象,空值 | null | additionalProperties:false | 由主机集成或智能体提供的屏幕报告信息。卡片尺寸永远不会替代物理屏幕分辨率。 |
snapshot.name | string | maxLength:120;必填 | ||
snapshot.updatedAt | string | maxLength:64;必填 | ||
snapshot.id | string | "" | maxLength:100 | |
snapshot.location | string | "" | maxLength:160 | |
snapshot.platform | string | "" | maxLength:80 | |
snapshot.version | string | "" | maxLength:80 | |
snapshot.playlist | string | "" | maxLength:160 | |
snapshot.connection | string | "unknown" | "online", "offline", "unknown" | |
snapshot.width | 整数,空值 | null | 最小值:1;最大值:32768 | |
snapshot.height | 整数,空值 | null | 最小值:1;最大值:32768 | |
snapshot.uptimeSeconds | 整数,空值 | null | 最小值:0;最大值:315576000 | |
snapshot.storageFreeBytes | 整数,空值 | null | 最小值:0;最大值:9007199254740991 | |
snapshot.network | string | "" | maxLength:160 | |
snapshot.ipAddress | string | "" | maxLength:100 |
画布示例
将静态属性保存为 params.json 并创建卡片。结果中包含它的 crd_ ID。
{
"theme": "neomustard"
}
screenrig card create --type screen-info --major 1 --file params.json
将此项目添加到播放列表页面的primitives中,并用该 ID 替换示例中的 ID。发布播放列表并分配屏幕。
{
"id": "screen-info",
"primitive": "card",
"card": "crd_01EXAMPLECARD000000000",
"layout": "full",
"content_fit": "fill"
}
写入实时数据
创建卡片后向其写入文档,之后替换该文档即可更新屏幕,无需重新发布。卡片会按其动态属性检查每次写入,并拒绝它不接受的文档。请使用与播放列表相同的项目。
将文档保存为card-data.json。CLI直接读取文档,无需包装:
{
"snapshot": 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":{"snapshot":null}}'