ライブカード
カテゴリ: イベント。タグ: ロビーと受付、店舗、ニュースとお知らせ、イベントと会場。
レイアウト
この全画面カードはランドスケープまたはポートレートで画面全体を埋め、コーナー、チップ、ストリップとして配置されません。
レイアウト:フル。フォーム:ランドスケープ、ポートレート。
データとプライバシー
このカードは設定されたプロパティとライブカードデータを使用します。
プロパティ
テーマ、背景、アクセント、位置については共通プロパティを参照してください。
カードの作成時に、静的プロパティをカードの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 | null | 最小値:0;最大値:60 | 挨拶が表示されるイベントの何日前か。空欄の場合は各イベントのリードインを使用します。 |
moonOffset | integer | 0 | 最小値:-2;最大値:2 | 現地の月観測に合わせてラマダンやイードの日付に追加される日数です。 |
timeZone | 文字列、null | null | ||
backgroundColor | 文字列、null | null | パターン:"^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$" | カードの背景とプレートをフラットなCSS順序の色で上書きします。#RRGGBBAAは不透明度を指定します。background noneが優先されます。 |
textColor | 文字列、null | 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":""}}'