ライブカード
カテゴリ: 飲食。タグ: レストランとカフェ、店舗。
レイアウト
この全画面カードはランドスケープまたはポートレートで画面全体を埋め、コーナー、チップ、ストリップとして配置されません。
レイアウト:フル。フォーム:ランドスケープ、ポートレート。
データとプライバシー
このカードは設定されたプロパティとライブカードデータを使用します。
プロパティ
テーマ、背景、アクセント、位置については共通プロパティを参照してください。
カードの作成時に、静的プロパティをカードのparamsに設定します。データドキュメントは動的プロパティのみを保持します。ネストされた行は親プロパティの内容を説明します。
静的プロパティ
| 名前 | タイプ | デフォルト | 値と制限 | 説明 |
|---|---|---|---|---|
pageSeconds | integer | 10 | 最小値:4;最大値:60 | リストが収まらないとき、各ページの表示秒数。 |
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})?$" | メインとセカンダリのテキスト色を上書きします。アクセントと意味的な状態色はそのまま維持されます。 |
動的プロパティ
| 名前 | タイプ | デフォルト | 値と制限 | 説明 |
|---|---|---|---|---|
title | string | "" | maxLength:120 | 料理です。 |
subtitle | string | "" | maxLength:80 | バイライン:キッチン、料理人、コース。 |
image | string | "" | maxLength:200 | 料理の写真用プロジェクトメディア参照。 |
prep | integer | 0 | 最小値:0;最大値:1440 | 準備時間(分)。 |
cook | integer | 0 | 最小値:0;最大値:1440 | 調理時間(分)。 |
serves | integer | 0 | 最小値:0;最大値:1000 | サービス対象の数。 |
tags | array | [] | minItems:0;maxItems:6 | 短縮マーク:ベジタリアン、グルテンフリー、クイック。 |
ingredients | array | [] | minItems:0;maxItems:60 | |
ingredients[].heading | string | "" | maxLength:40 | For the sauce のようなセクション見出し。name を置き換えます。 |
ingredients[].amount | string | "" | maxLength:16 | 数量:大さじ2、400g。 |
ingredients[].name | string | "" | maxLength:80 | 成分です。 |
ingredients[].note | string | "" | maxLength:40 | 準備方法:刻み、分割。 |
steps | array | [] | minItems:0;maxItems:40 | |
step | integer | 0 | 最小値:0;最大値:40 | 調理中のステップで、1から数えます。前のステップは薄く表示され、このステップが強調されます。0は強調なしです。 |
tip | string | "" | maxLength:200 | 閉店のヒント。 |
stepAt | 文字列、null | null | 調理がstepに移動したISO 8601時刻。Primetimeはそこから次のステップの瞬間を再生します。stepと一緒に送信してください。 |
キャンバス例
静的プロパティを params.json として保存し、カードを作成します。結果にはその crd_ ID が含まれます。
{
"theme": "neomustard"
}
screenrig card create --type recipe --major 1 --file params.json
このアイテムをプレイリストページのprimitivesに追加し、サンプルの ID をその ID に置き換えます。プレイリストを公開してスクリーンに割り当ててください。
{
"id": "recipe",
"primitive": "card",
"card": "crd_01EXAMPLECARD000000000",
"layout": "full",
"content_fit": "fill"
}
ライブデータを書き込む
カードを作成した後にドキュメントを書き込み、画面を再公開せずに更新するには置き換えます。カードは書き込みのたびに動的プロパティと照合し、受け付けないドキュメントは拒否します。プレイリストと同じプロジェクトを使用してください。
ドキュメントを card-data.json として保存します。CLIはラッパーなしでドキュメント自体を読み取ります。
{
"title": "",
"subtitle": "",
"image": "",
"prep": 0,
"cook": 0,
"serves": 0,
"tags": [],
"ingredients": [],
"steps": [],
"step": 0,
"tip": "",
"stepAt": 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":{"title":"","subtitle":"","image":"","prep":0,"cook":0,"serves":0,"tags":[],"ingredients":[],"steps":[],"step":0,"tip":"","stepAt":null}}'