スマートホームの TransportControl トレイトのスキーマ
action.devices.traits.TransportControl
- このトレイトは、メディア再生を操作できるデバイス(一時停止中に音楽を再開するなど)に使用します。
デバイスの属性
このトレイトを持つデバイスは、SYNC
オペレーションの一部として次の属性を報告できます。SYNC
インテントの処理の詳細については、インテントのフルフィルメントをご覧ください。
属性 | タイプ | 説明 |
---|---|---|
transportControlSupportedCommands |
配列 |
必須。 このデバイスでサポートされているトランスポート制御コマンドを記述する文字列のリスト。 |
[item, ...] |
String |
サポートされているコマンド。 サポートされる値:
|
例
再生コマンドをサポートするデバイス
{ "transportControlSupportedCommands": [ "NEXT", "PREVIOUS", "PAUSE", "STOP", "RESUME" ] }
デバイスのステータス
なし。
デバイスのコマンド
このトレイトを持つデバイスは、EXECUTE
オペレーションの一環として次のコマンドに応答できます。EXECUTE
インテントの処理の詳細については、インテントのフルフィルメントをご覧ください。
action.devices.commands.mediaStop
メディアの再生を一時停止します。
このコマンドには次の属性が必要です。{ "transportControlSupportedCommands": [ "STOP" ] }
パラメータ
パラメータ | タイプ | 説明 |
---|---|---|
プロパティがありません |
例
パラメータなし
{ "command": "action.devices.commands.mediaStop", "params": {} }
action.devices.commands.mediaNext
次のメディア項目にスキップします。
このコマンドには次の属性が必要です。{ "transportControlSupportedCommands": [ "NEXT" ] }
パラメータ
パラメータ | タイプ | 説明 |
---|---|---|
プロパティがありません |
例
パラメータなし
{ "command": "action.devices.commands.mediaNext", "params": {} }
action.devices.commands.mediaPrevious
前のメディア項目にスキップします。
このコマンドには次の属性が必要です。{ "transportControlSupportedCommands": [ "PREVIOUS" ] }
パラメータ
パラメータ | タイプ | 説明 |
---|---|---|
プロパティがありません |
例
パラメータなし
{ "command": "action.devices.commands.mediaPrevious", "params": {} }
action.devices.commands.mediaPause
メディアの再生を一時停止します。
このコマンドには次の属性が必要です。{ "transportControlSupportedCommands": [ "PAUSE" ] }
パラメータ
パラメータ | タイプ | 説明 |
---|---|---|
プロパティがありません |
例
パラメータなし
{ "command": "action.devices.commands.mediaPause", "params": {} }
action.devices.commands.mediaResume
メディアの再生を再開します。
このコマンドには次の属性が必要です。{ "transportControlSupportedCommands": [ "RESUME" ] }
パラメータ
パラメータ | タイプ | 説明 |
---|---|---|
プロパティがありません |
例
パラメータなし
{ "command": "action.devices.commands.mediaResume", "params": {} }
action.devices.commands.mediaSeekRelative
相対位置に移動。
このコマンドには次の属性が必要です。{ "transportControlSupportedCommands": [ "SEEK_RELATIVE" ] }
パラメータ
パラメータ | タイプ | 説明 |
---|---|---|
relativePositionMs |
Integer |
必須。 シークする順(正の整数)または後方(負の int)のミリ秒。 |
例
10 秒早送りします
{ "command": "action.devices.commands.mediaSeekRelative", "params": { "relativePositionMs": 10000 } }
10 秒巻き戻し
{ "command": "action.devices.commands.mediaSeekRelative", "params": { "relativePositionMs": -10000 } }
action.devices.commands.mediaSeekToPosition
絶対位置に移動。
このコマンドには次の属性が必要です。{ "transportControlSupportedCommands": [ "SEEK_TO_POSITION" ] }
パラメータ
パラメータ | タイプ | 説明 |
---|---|---|
absPositionMs |
Integer |
必須。 シーク位置の絶対位置のミリ秒。 |
例
30 秒早送りします
{ "command": "action.devices.commands.mediaSeekToPosition", "params": { "absPositionMs": 30000 } }
action.devices.commands.mediaRepeatMode
繰り返し再生モードを設定します。
このコマンドには次の属性が必要です。{ "transportControlSupportedCommands": [ "SET_REPEAT" ] }
パラメータ
パラメータ | タイプ | 説明 |
---|---|---|
isOn |
ブール値 |
必須。 繰り返しモードをオンにする場合は true、オフにする場合は false です。 |
isSingle |
ブール値 |
(デフォルト: 指定されている場合、true は単一アイテムの繰り返しモードを有効にすることを意味します。false は通常の繰り返しモード(プレイリストなど)を有効にすることを意味します。 |
例
リピート: オン
{ "command": "action.devices.commands.mediaRepeatMode", "params": { "isOn": true } }
繰り返しオフ
{ "command": "action.devices.commands.mediaRepeatMode", "params": { "isOn": false } }
1 つのトラックを繰り返す
{ "command": "action.devices.commands.mediaRepeatMode", "params": { "isOn": true, "isSingle": true } }
action.devices.commands.mediaShuffle
現在のプレイリストをシャッフルします。
このコマンドには次の属性が必要です。{ "transportControlSupportedCommands": [ "SHUFFLE" ] }
パラメータ
パラメータ | タイプ | 説明 |
---|---|---|
プロパティがありません |
例
パラメータなし
{ "command": "action.devices.commands.mediaShuffle", "params": {} }
action.devices.commands.mediaClosedCaptioningOn
字幕をオンにする。
このコマンドには次の属性が必要です。{ "transportControlSupportedCommands": [ "CAPTION_CONTROL" ] }
パラメータ
パラメータ | タイプ | 説明 |
---|---|---|
closedCaptioningLanguage |
String |
字幕の言語またはロケール。 |
userQueryLanguage |
String |
ユーザークエリの言語または言語 / 地域。 |
例
英語の字幕をオンにする
{ "command": "action.devices.commands.mediaClosedCaptioningOn", "params": { "closedCaptioningLanguage": "en" } }
韓国語の字幕をオンにする
{ "command": "action.devices.commands.mediaClosedCaptioningOn", "params": { "closedCaptioningLanguage": "ko-KR" } }
ユーザー検索でアメリカ英語の字幕をオンにする(英語)
{ "command": "action.devices.commands.mediaClosedCaptioningOn", "params": { "closedCaptioningLanguage": "ko-KR", "userQueryLanguage": "en-US" } }
action.devices.commands.mediaClosedCaptioningOff
字幕をオフにする。
このコマンドには次の属性が必要です。{ "transportControlSupportedCommands": [ "CAPTION_CONTROL" ] }
パラメータ
パラメータ | タイプ | 説明 |
---|---|---|
プロパティがありません |
例
字幕をオフにする
{ "command": "action.devices.commands.mediaClosedCaptioningOff", "params": {} }