直播卡片
类别:公共信息。标签:记分板,排行榜和排名,新闻和公告,活动和场馆。
布局
此全屏卡在横屏或竖屏时填满整个屏幕,不作为角落、芯片或条带放置。
布局:全屏。表单:横向,纵向。
数据与隐私
信息源:screenrig.election/v1。
信息源文档带有来源归属。播放器向卡片提供信息源。
属性
有关主题、背景、强调色和位置,请参见通用属性。
创建卡片时,在卡片的params中设置静态属性。其数据文档仅包含动态属性。嵌套行描述其父属性的内容。
静态属性
| 名称 | 类型 | 默认 | 数值和限制 | 描述 |
|---|---|---|---|---|
title | string | "Results" | maxLength:40 | |
perPage | integer | 2 | 最小值:1;最大值:8 | 页面上的赛况(网格布局);更多赛况显示在下一页。 |
pageSeconds | integer | 12 | 最小值:5;最大值:60 | 每页或焦点赛跑在屏幕上的停留时间。 |
maxCandidates | integer | 4 | 最小值:2;最大值:8 | 比赛中列出的候选人;其余共享一行“其他”。 |
showVotes | boolean | true | 在份额旁显示投票数。 | |
showParty | boolean | true | 以文本形式显示每个候选人的党派。 | |
staleMinutes | integer | 30 | 最小值:1;最大值:1440 | |
hour12 | boolean | false | ||
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})?$" | 覆盖主文本和次要文本颜色。强调色和语义状态色保持原有功能。 |
动态属性
| 名称 | 类型 | 默认 | 数值和限制 | 描述 |
|---|---|---|---|---|
electionName | string | "" | maxLength:80 | 选举,例如2026年大选,当数据源无相关信息时显示。 |
races | array | [] | minItems:0;maxItems:40 | 比赛。内容提要(screenrig.election/v1)存在时优先;否则由数据存储提供相同行。 |
races[].id | string | maxLength:40 | ||
races[].title | string | minLength:1;maxLength:80;必填 | 例如市长竞选。 | |
races[].jurisdiction | string | maxLength:60 | 例如费尔维尤市的位置。 | |
races[].reportingPct | number | 最小值:0;最大值:100 | 报告的选区百分比。 | |
races[].precincts | object | additionalProperties:false | ||
races[].precincts.reporting | number | 最小值:0 | ||
races[].precincts.total | number | 最小值:0 | ||
races[].status | string | "open", "called", "recount", "runoff", "unopposed" | 当比赛已宣布时调用;获胜者为 true 的候选人也调用。 | |
races[].calledAt | string | maxLength:32 | 比赛宣布时间,ISO 8601。 | |
races[].featured | boolean | 用这场比赛引领角落和芯片。 | ||
races[].candidates | array | minItems:0;maxItems:40;必填 | ||
races[].candidates[].name | string | maxLength:60;必填 | ||
races[].candidates[].party | string | maxLength:24 | 作为文本显示;不带颜色。 | |
races[].candidates[].votes | number | 最小值:0 | ||
races[].candidates[].pct | number | 最小值:0;最大值:100 | 投票份额;缺失时根据投票计算。 | |
races[].candidates[].winner | boolean | |||
races[].candidates[].incumbent | boolean | |||
updated | string | "" | maxLength:32 | 结果最后更新时间,ISO 8601(仅数据存储;数据源携带 fetchedAt)。 |
画布示例
将静态属性保存为 params.json 并创建卡片。结果中包含它的 crd_ ID。
{
"theme": "neomustard"
}
screenrig card create --type election-results --major 1 --file params.json
将此项目添加到播放列表页面的primitives中,并用该 ID 替换示例中的 ID。发布播放列表并分配屏幕。
{
"id": "election-results",
"primitive": "card",
"card": "crd_01EXAMPLECARD000000000",
"layout": "full",
"content_fit": "fill"
}
写入实时数据
创建卡片后向其写入文档,之后替换该文档即可更新屏幕,无需重新发布。卡片会按其动态属性检查每次写入,并拒绝它不接受的文档。请使用与播放列表相同的项目。
将文档保存为card-data.json。CLI直接读取文档,无需包装:
{
"electionName": "",
"races": [],
"updated": ""
}
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":{"electionName":"","races":[],"updated":""}}'