文本卡片

屏幕上的文字,主内容周围可选眉头、标题和页脚。

可选眉头和标题位于主体上方,安静的页脚位于下方,顺序清晰,易于远距离阅读。它可填满屏幕,居中,嵌入角落,缩小为角落一行,或沿边缘作为带状运行,最小时仅剩主体。你设置眉头、标题、主体和页脚,并选择文字是靠前还是居中。

直播卡片

此卡由浏览器绘制,使用与播放器相同的代码,带示例数据。

类别:消息。标签:办公室与工作场所,大厅与接待。

布局

此核心卡适用于所有布局:全屏、居中、宽屏、角落、芯片、条带或任何自由矩形。

布局:全屏,居中,宽屏,角落,芯片,条带。表单:横向,纵向,方形,条带。

卡片布局、主题和发布。浏览卡片。

数据与隐私

此卡使用其配置的属性和实时卡数据。

属性

有关主题、背景、强调色和位置,请参见通用属性。

创建卡片时,在卡片的params中设置静态属性。其数据文档仅包含动态属性。嵌套行描述其父属性的内容。

静态属性

名称类型默认数值和限制描述
alignstring"start""start", "center"文本在框内的位置。
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})?$"覆盖主文本和次要文本颜色。强调色和语义状态色保持原有功能。

动态属性

名称类型默认数值和限制描述
eyebrowstring""maxLength:40标题上方的短标签,使用主题标签色。
titlestring""maxLength:120
bodystring""maxLength:400主要文本。芯片大小时仅显示此内容。
footerstring""maxLength:120底部的简短说明:来源、日期、出处。
activebooleantrueFalse 会降低卡片:它会离开并且不绘制任何内容,直到再次升起。
since字符串,空值nullISO 8601 瞬时 active 最后更改。升高时,卡片在时间尚未到达时等待;降低时,卡片在时间过后仍显示几秒。

画布示例

将静态属性保存为 params.json 并创建卡片。结果中包含它的 crd_ ID。

{
  "theme": "neomustard"
}
screenrig card create --type text --major 1 --file params.json

将此项目添加到播放列表页面的primitives中,并用该 ID 替换示例中的 ID。发布播放列表并分配屏幕。

{
  "id": "text",
  "primitive": "card",
  "card": "crd_01EXAMPLECARD000000000",
  "layout": "full",
  "content_fit": "fill"
}

写入实时数据

创建卡片后向其写入文档,之后替换该文档即可更新屏幕,无需重新发布。卡片会按其动态属性检查每次写入,并拒绝它不接受的文档。请使用与播放列表相同的项目。

将文档保存为card-data.json。CLI直接读取文档,无需包装:

{
  "eyebrow": "",
  "title": "",
  "body": "",
  "footer": "",
  "active": true,
  "since": 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":{"eyebrow":"","title":"","body":"","footer":"","active":true,"since":null}}'