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

action.devices.traits.TransportControl - このトレイトは、メディア再生を制御できるデバイスに使用します（たとえば、一時停止中の音楽の再開など）。

デバイスの属性

このトレイトを持つデバイスは、以下をレポートすることがあります。 SYNC オペレーションの一部として使用できます。学習内容 SYNC インテントの処理の詳細については、以下をご覧ください。 インテント フルフィルメント。

属性 タイプ 説明
transportControlSupportedCommands 配列

必須。

このデバイスでサポートされているトランスポート コントロール コマンドを記述した文字列のリスト。
[item, ...] String

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

サポートされている値:

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

デバイスエラー

詳しくは、 エラーと例外をご覧ください。