スマートホームの TransportControl トレイトのスキーマ

action.devices.traits.TransportControl - このトレイトは、メディアの再生をコントロールできるデバイスに使用されます(たとえば、一時停止中に音楽を再開するなど)。

デバイスの属性

このトレイトを持つデバイスは、SYNC オペレーションの一部として次の属性をレポートできます。SYNC インテントの処理方法については、インテントのフルフィルメントをご覧ください。

属性 タイプ 説明
transportControlSupportedCommands 配列

必須。

このデバイスでサポートされているトランスポート制御コマンドを記述する文字列のリスト。

[item, ...] 文字列

サポートされているコマンド。

サポートされている値:

CAPTION_CONTROL
NEXT
PAUSE
PREVIOUS
RESUME
SEEK_RELATIVE
SEEK_TO_POSITION
SET_REPEAT
SHUFFLE
STOP

再生コマンドをサポートするデバイス

{
  "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 整数

必須。

シークする前方(正の整数)または後方(負の整数)のミリ秒。

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 整数

必須。

シークする絶対位置のミリ秒。

30 秒に移動

{
  "command": "action.devices.commands.mediaSeekToPosition",
  "params": {
    "absPositionMs": 30000
  }
}

action.devices.commands.mediaRepeatMode

繰り返し再生モードを設定します。

このコマンドには、次の属性が必要です。
{
  "transportControlSupportedCommands": [
    "SET_REPEAT"
  ]
}

パラメータ

パラメータ タイプ 説明
isOn ブール値

必須。

繰り返しモードをオンにする場合は true、繰り返しモードをオフにするには false を指定します。

isSingle ブール値

(デフォルト: false

指定する場合、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 文字列

字幕の言語または地域。

userQueryLanguage 文字列

ユーザークエリの言語またはロケール。

英語の字幕をオンにする

{
  "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": {}
}

デバイスエラー

エラーと例外の全リストをご覧ください。