直播卡片
类别：活动。标签：大厅和接待区，商店，新闻和公告，活动和场地。
布局
此全屏卡在横屏或竖屏时填满整个屏幕，不作为角落、芯片或条带放置。
布局：全屏。表单：横向，纵向。
数据与隐私
此卡使用其配置的属性和实时卡数据。
属性
有关主题、背景、强调色和位置，请参见通用属性。
创建卡片时，在卡片的params中设置静态属性。其数据文档仅包含动态属性。嵌套行描述其父属性的内容。
静态属性
| 名称 | 类型 | 默认 | 数值和限制 | 描述 |
|---|---|---|---|---|
calendars | array | ["world"] | maxItems：11；uniqueItems：true | 卡片绘制的节日集：世界（新年、情人节、复活节、万圣节、圣诞节）、基督教、东正教、美国、加拿大、英国、澳大利亚、农历、犹太教、伊斯兰教和南亚。 |
occasion | string | "auto" | "auto", "new-years-day", "valentines-day", "st-patricks-day", "easter", "earth-day", "halloween", "christmas-eve", "christmas", "new-years-eve", "good-friday", "orthodox-christmas", "orthodox-easter", "mlk-day", "presidents-day", "mothers-day", "memorial-day", "juneteenth", "fathers-day", "independence-day", "labor-day", "veterans-day", "thanksgiving", "canada-day", "victoria-day", "thanksgiving-ca", "remembrance-day", "boxing-day", "mothering-sunday", "bonfire-night", "remembrance-sunday", "australia-day", "anzac-day", "fathers-day-au", "lunar-new-year", "lantern-festival", "dragon-boat", "mid-autumn", "rosh-hashanah", "passover", "hanukkah", "ramadan", "eid-al-fitr", "eid-al-adha", "islamic-new-year", "diwali", "vaisakhi" | 自动选择当季或下一个场合。ID 显示该场合的每日问候。 |
showUpcoming | boolean | true | 无当季内容时，显示下一次活动及倒计时。关闭时显示普通信息。 | |
leadDays | 整数，空值 | null | 最小值：0；最大值：60 | 问候语在活动前多少天出现。留空则使用每个活动自身的引入时间。 |
moonOffset | integer | 0 | 最小值：-2；最大值：2 | 根据本地新月观测，斋月和开斋节日期可增加天数。 |
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})?$" | 覆盖主文本和次要文本颜色。强调色和语义状态色保持原有功能。 |
动态属性
| 名称 | 类型 | 默认 | 数值和限制 | 描述 |
|---|---|---|---|---|
message | string | "" | maxLength：120 | 替换场合的问候语。若无特定场合，则显示卡片消息（为空时显示欢迎）。 |
note | string | "" | maxLength：160 | 替换问候语下方的线条。 |
signoff | string | "" | maxLength：100 | 替换结尾语（致以诚挚祝福）。 |
画布示例
将静态属性保存为 params.json 并创建卡片。结果中包含它的 crd_ ID。
{
"theme": "neomustard"
}screenrig card create --type greeting --major 1 --file params.json将此项目添加到播放列表页面的primitives中，并用该 ID 替换示例中的 ID。发布播放列表并分配屏幕。
{
"id": "greeting",
"primitive": "card",
"card": "crd_01EXAMPLECARD000000000",
"layout": "full",
"content_fit": "fill"
}写入实时数据
创建卡片后向其写入文档，之后替换该文档即可更新屏幕，无需重新发布。卡片会按其动态属性检查每次写入，并拒绝它不接受的文档。请使用与播放列表相同的项目。
将文档保存为card-data.json。CLI直接读取文档，无需包装：
{
"message": "",
"note": "",
"signoff": ""
}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":{"message":"","note":"","signoff":""}}'