直播卡片
类别:运营。标签:识别,警报和状态,办公室和工作场所。
布局
此全屏卡在横屏或竖屏时填满整个屏幕,不作为角落、芯片或条带放置。
布局:全屏。表单:横向,纵向。
数据与隐私
此卡使用其配置的属性和实时卡数据。
属性
有关主题、背景、强调色和位置,请参见通用属性。
创建卡片时,在卡片的params中设置静态属性。其数据文档仅包含动态属性。嵌套行描述其父属性的内容。
静态属性
| 名称 | 类型 | 默认 | 数值和限制 | 描述 |
|---|---|---|---|---|
title | string | "Deal closed" | maxLength:30 | 庆祝活动上的标签。 |
currency | string | "$" | maxLength:4 | 金额前显示的货币符号。 |
celebrateSec | integer | 30 | 最小值:5;最大值:600 | 新胜利保持庆祝的时间,之后卡片恢复正常。 |
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})?$" | 覆盖主文本和次要文本颜色。强调色和语义状态色保持原有功能。 |
动态属性
| 名称 | 类型 | 默认 | 数值和限制 | 描述 |
|---|---|---|---|---|
target | number | 最小值:0 | 今天的目标以主要单位显示;固定视图显示进度。 | |
wins | array | [] | maxItems:50 | 关闭的交易,顺序不限;最新的由 at 显示为胜出。少于 celebrateSec 的胜出将接管卡片。 |
wins[].id | string | "" | maxLength:40 | 为胜利设置键值,已显示的胜利不会再次庆祝。 |
wins[].name | string | minLength:1;maxLength:60;必填 | 谁完成了交易。 | |
wins[].team | string | "" | maxLength:40 | |
wins[].photo | string | "" | maxLength:120 | 人员图片的媒体引用;为空时显示其首字母。 |
wins[].deal | string | "" | maxLength:100 | 客户或交易名称。 |
wins[].amount | number | 0 | 最小值:0 | 交易金额(主单位)。 |
wins[].at | string | "" | maxLength:40 | 交易完成时间,ISO 8601 时间点。 |
wins[].note | string | "" | maxLength:120 | 交易下方的简短说明,如产品或条款。 |
画布示例
将静态属性保存为 params.json 并创建卡片。结果中包含它的 crd_ ID。
{
"theme": "neomustard"
}
screenrig card create --type win-alert --major 1 --file params.json
将此项目添加到播放列表页面的primitives中,并用该 ID 替换示例中的 ID。发布播放列表并分配屏幕。
{
"id": "win-alert",
"primitive": "card",
"card": "crd_01EXAMPLECARD000000000",
"layout": "full",
"content_fit": "fill"
}
写入实时数据
创建卡片后向其写入文档,之后替换该文档即可更新屏幕,无需重新发布。卡片会按其动态属性检查每次写入,并拒绝它不接受的文档。请使用与播放列表相同的项目。
将文档保存为card-data.json。CLI直接读取文档,无需包装:
{
"target": 1,
"wins": []
}
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":{"target":1,"wins":[]}}'