剩余秒数以时钟数字大字显示,阶段以时间下方条或环绕时间的环显示,轮次显示在旁,便于远距离阅读。可全屏、居中、角落、一行或边缘横幅显示。设置开始时间、工作和休息时长、轮次数及阶段条或环。
直播卡片
类别:时间。标签:倒计时和计时器,时钟和日历。
布局
此核心卡适用于所有布局:全屏、居中、宽屏、角落、芯片、条带或任何自由矩形。
布局:全屏,居中,宽屏,角落,芯片,条带。表单:横向,纵向,方形,条带。
数据与隐私
此卡使用其配置的属性和实时卡数据。
属性
有关主题、背景、强调色和位置,请参见通用属性。
创建卡片时,在卡片的params中设置静态属性。其数据文档仅包含动态属性。嵌套行描述其父属性的内容。
静态属性
| 名称 | 类型 | 默认 | 数值和限制 | 描述 |
|---|---|---|---|---|
title | string | "" | maxLength:40 | |
work | integer | 40 | 最小值:1;最大值:3600 | |
rest | integer | 20 | 最小值:0;最大值:3600 | |
rounds | integer | 8 | 最小值:1;最大值:99 | |
warmup | integer | 0 | 最小值:0;最大值:3600 | |
cooldown | integer | 0 | 最小值:0;最大值:3600 | |
labels | object | additionalProperties:false | ||
labels.work | string | "Work" | maxLength:16 | |
labels.rest | string | "Rest" | maxLength:16 | |
labels.warmup | string | "Warm up" | maxLength:16 | |
labels.cooldown | string | "Cool down" | maxLength:16 | |
loop | boolean | false | 会话结束时重新开始。 | |
style | string | "bar" | "bar", "ring" | 条形:时间上方有阶段条,旁边有圆形。环形:环绕阶段的环,内含时间。 |
hourCycle | string | "24" | "12", "24", "military" | 会话开始前的开始时间写法:上午9:00、09:00或0900小时。 |
showRing | boolean | true | 绘制相位条(或环)。假值仅绘制时间。 | |
presence | string | "always" | "always", "session" | 始终:始终在线。会话:仅在开始前 lead 分钟至结束后 doneSeconds 分钟内显示。 |
lead | number | 10 | 最小值:0;最大值:1440 | 出席会议开始前的分钟数。 |
doneSeconds | number | 10 | 最小值:0;最大值:3600 | 结束后存在会话保持的秒数。 |
timeZone | 字符串,空值 | null | ||
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})?$" | 覆盖主文本和次要文本颜色。强调色和语义状态色保持原有功能。 |
动态属性
| 名称 | 类型 | 默认 | 数值和限制 | 描述 |
|---|---|---|---|---|
startAt | string | 必填 | 会话开始的 ISO 8601 瞬时(或该时区的本地时间)。 |
画布示例
将静态属性保存为 params.json 并创建卡片。结果中包含它的 crd_ ID。
{
"theme": "neomustard"
}
screenrig card create --type timer --major 1 --file params.json
将此项目添加到播放列表页面的primitives中,并用该 ID 替换示例中的 ID。发布播放列表并分配屏幕。
{
"id": "timer",
"primitive": "card",
"card": "crd_01EXAMPLECARD000000000",
"layout": "full",
"content_fit": "fill"
}
写入实时数据
创建卡片后向其写入文档,之后替换该文档即可更新屏幕,无需重新发布。卡片会按其动态属性检查每次写入,并拒绝它不接受的文档。请使用与播放列表相同的项目。
将文档保存为card-data.json。CLI直接读取文档,无需包装:
{
"startAt": "2026-10-15T12:00:00Z"
}
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":{"startAt":"2026-10-15T12:00:00Z"}}'