Bluetooth インターフェース

• 概要
• シーケンスダイアグラム
• 機能API
• Bluetoothのコンテキスト
• Bluetooth接続の管理
  • ScanDevicesディレクティブ
  • ScanDevicesUpdatedイベント
  • ScanDevicesFailedイベント
  • EnterDiscoverableModeディレクティブ
  • EnterDiscoverableModeSucceededイベント
  • EnterDiscoverableModeFailedイベント
  • ExitDiscoverableModeディレクティブ
  • PairDeviceディレクティブ
  • PairDeviceSucceededイベント
  • PairDeviceFailedイベント
  • UnpairDeviceディレクティブ
  • UnpairDeviceSucceededイベント
  • UnpairDeviceFailedイベント
  • ConnectByDeviceIdディレクティブ
  • ConnectByDeviceIdSucceededイベント
  • ConnectByDeviceIdFailedイベント
  • ConnectByProfileディレクティブ
  • ConnectByProfileSucceededイベント
  • ConnectByProfileFailedイベント
  • DisconnectDeviceディレクティブ
  • DisconnectDeviceSucceededイベント
  • DisconnectDeviceFailedイベント
• Bluetoothのストリーミング状態の管理
  • StreamingStartedイベント
  • StreamingEndedイベント
• Bluetooth経由のメディア操作
  • Playディレクティブ
  • MediaControlPlaySucceededイベント
  • MediaControlPlayFailedイベント
  • Stopディレクティブ
  • MediaControlStopSucceededイベント
  • MediaControlStopFailedイベント
  • Nextディレクティブ
  • MediaControlNextSucceededイベント
  • MediaControlNextFailedイベント
  • Previousディレクティブ
  • MediaControlPreviousSucceededイベント
  • MediaControlPreviousFailedイベント

概要

Bluetoothインターフェースは、クライアントと、スマートフォンやBluetooth搭載スピーカーなどのピアデバイスのBluetooth接続の管理に使用されるディレクティブとイベントを提供します。このインターフェースでは以下のプロファイルがサポートされます。A2DP-SOURCE、A2DP-SINK、AVRCP。

• A2DP-SOURCE - ストリーミングオーディオなどのコンテンツを送信します。
• A2DP-SINK - ストリーミングオーディオなどのコンテンツを受信します。
• AVRCP - リモートデバイスのメディア再生を制御します。通常、このプロファイルはA2DPプロファイルと一緒に使用され、次、前、一時停止、再生の制御を行います。

また、このインターフェースは接続されたBluetooth A2DP-SOURCEデバイスのメディア再生の制御に使われるディレクティブとイベントも提供します。すべてのディレクティブとイベントのリストについては、Bluetooth経由のメディア操作を参照してください。

サポートされる使用例：

• Amazon Alexaアプリを使ったBluetoothデバイスのスキャン、ペアリング、ペアリング解除。
• 音声やAmazon Alexaアプリを使ったBluetoothデバイスの接続と接続解除。
• 接続されたBluetoothデバイスがA2DP-SOURCEとして設定されている場合のメディア再生の制御。

シーケンスダイアグラム

Bluetoothインターフェースは、音声、製品上のGUI、Amazon Alexaアプリ、サードパーティ製のコンパニオンアプリを使ったBluetoothピアデバイスのスキャニング、接続/接続解除、ペアリング/ペアリング解除をサポートします。以下は、サポートされるBluetoothの対話、クライアントとAVSの間で送受信される関連ディレクティブとイベントのシーケンスを表した図です。

一連のシーケンスダイアグラムでは、音声によって開始された対話を表しています。

音声を使ったBluetoothデバイスのペアリング

詳細を表示

機能API

Bluetoothインターフェースのバージョン1.0を使用するには、機能APIの呼び出し内で宣言する必要があります。詳細については、機能APIを参照してください。

オブジェクトのサンプル

{
    "type": "AlexaInterface",
    "interface": "Bluetooth",
    "version": "1.0"
}

Bluetoothのコンテキスト

コンテキストは、AVSにクライアントコンポーネントの状態を伝えるのに使用されるコンテナです。コンテキストは、イベントが発生する直前のクライアントコンポーネントの状態を反映する必要があります。

Bluetoothが有効な場合、contextが必要なすべてのイベントにはBluetooth.BluetoothStateのオブジェクトが含まれる必要があります。

コンテキストのサンプル

{
  "header": {
    "namespace": "Bluetooth",
    "name": "BluetoothState"
  },
  "payload": {
    "alexaDevice": {
      "friendlyName": "{{STRING}}"
    },
    "pairedDevices": [
      {
        "uniqueDeviceId": "{{STRING}}",
        "friendlyName": "{{STRING}}",
        "supportedProfiles": [
          {
            "name": "{{STRING}}",
            "version": "{{STRING}}"
          },
          {
            // Additional objects may be included for each
            // profile that the device supports.
          }
        ]
      },
      {
        // Additional objects should be included for each
        // paired device.
      }
    ],
    "activeDevice": {
      "uniqueDeviceId": "{{STRING}}",
      "friendlyName": "{{STRING}}",
      "supportedProfiles": [
        {
          "name": "{{STRING}}",
          "version": "{{STRING}}"
        },
        {
          // Additional objects may be included for each
          // profile that the device supports.
        }
      ],
      "streaming": "{{STRING}}"
    }
  }
}

Show Sample

{
    "header": {
        "namespace": "Bluetooth",
        "name": "BluetoothState"
    },
    "payload": {
        "alexaDevice": {
            "friendlyName": "Echo-0ST"
        },
        "pairedDevices": [
            {
                // This identifies AVS Device 1 as a paired device
                // that supports three profiles.
                "uniqueDeviceId": "353088131600891",
                "friendlyName": "AVS Device 1",
                "supportedProfiles":[
                    {
                        "name" : "A2DP-SOURCE",
                        "version" : "1.3"
                    },
                    {
                        "name" : "AVRCP",
                        "version" : "1.0"
                    },
                    {
                        "name" : "A2DP-SINK",
                        "version" : "1.3"
                    }
                ]
            },
            // If additional devices have been paired, they are
            // included in the pairedDevices list.
            {
                // This identifies Wendy's Phone as a paired device
                // that supports two profiles.
                "uniqueDeviceId": "85308813234230897",
                "friendlyName": "Wendy's Phone",
                "supportedProfiles":[
                    {
                        "name" : "A2DP-SOURCE",
                        "version" : "1.0"
                    },
                    {
                        "name" : "AVRCP",
                        "version" : "1.0"
                    }
                ]
            }
        ],
        // This identifies the connected device and its supported
        // profiles.IMPORTANT: An activeDevice will always be in
        // the list of pairedDevices.
        "activeDevice": {
           "uniqueDeviceId": "353088131600891",
           "friendlyName": "AVS Device 1",
           "supportedProfiles":[
                {
                    "name" : "A2DP-SOURCE",
                    "version" : "1.3"
                },
                {
                    "name" : "AVRCP",
                    "version" : "1.0"
                },
                {
                    "name" : "A2DP-SINK",
                    "version" : "1.3"
                }
           ],
           // This is the streaming state at the time an event is sent.
           // This will determine what playback directives are sent to your
           // product.
           "streaming": "ACTIVE"
        }
    }
}

ペイロードのパラメーター

ストリーミングの状態

製品よりContextオブジェクトで送信する、製品が再生コマンドを受信するかどうかを判断するストリーミングの状態です。この表を使って、activeDevice.streamingに対してどの状態を提供する必要があるかを判断してください。

この表は、製品がペアリングなどのユーザーリクエストの前後にどの状態にあるべきかを示しています。

Bluetooth接続の管理

これらのディレクティブとイベントは、Alexa搭載製品とピアBluetoothデバイスとの間のBluetooth接続の管理に使用されます。

ScanDevicesディレクティブ

このディレクティブは、検出可能なBluetoothデバイスをスキャンするようにクライアントに指示します。クライアントは、Bluetoothデバイスが検出されるたびにScanDevicesUpdatedを送信する必要があります。スキャンが失敗した場合、クライアントはAVSにScanDevicesFailedイベントを送信する必要があります。

サンプルメッセージ

{
  "directive": {
    "header": {
      "namespace": "Bluetooth",
      "name": "ScanDevices",
      "messageId": "{{STRING}}"
    },
    "payload": {
    }
  }
}

ヘッダーのパラメーター

ペイロードのパラメーター

このディレクティブのペイロードは空です。

ScanDevicesUpdatedイベント

ScanDevicesディレクティブの受信後、このイベントはBluetoothデバイスを検出している間、定期的に送信される必要があります。 discoveredDevices には、スキャンが開始されてから検出されたすべてのデバイスについてのオブジェクトが含まれる必要があります（前回のイベントからの差分ではありません）。

サンプルメッセージ

{
  "context": [
    // This is an array of context objects that are used to communicate the
    // state of all client components to Alexa.See Context for details.
  ],
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "ScanDevicesUpdated",
      "messageId": "{{STRING}}"
    },
    "payload": {
      "discoveredDevices": [
        {
          "uniqueDeviceId": "{{STRING}}",
          "friendlyName": "{{STRING}}",
          "truncatedMacAddress": "{{STRING}}"
        }
      ],
      "hasMore": {{BOOLEAN}}
    }
  }
}

コンテキスト

このイベントは、クライアントに対してすべてのクライアントコンポーネントのステータスをAlexaに送信するよう要求します必要があります。その他の情報については、コンテキストを参照してください。

ヘッダーのパラメーター

ペイロードのパラメーター

ScanDevicesFailedイベント

ScanDevicesディレクティブの受信後、このイベントはスキャン操作が失敗した場合に送信される必要があります。スキャンが失敗した場合、コンパニオンアプリの検出されたBluetoothデバイスのリストは消去されます。注：スキャンの失敗は、検出中のデバイスとは関係ありません。下位のプロトコルの問題、ドライバーの問題、スキャン開始時に互換性の状態にあったことなどが原因の場合が多いです。

サンプルメッセージ

{
  "context": [
    // This is an array of context objects that are used to communicate the
    // state of all client components to Alexa.See Context for details.
  ],
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "ScanDevicesFailed",
      "messageId": "{{STRING}}"
    },
    "payload": {
    }
  }
}

コンテキスト

このイベントは、クライアントに対してすべてのクライアントコンポーネントのステータスをAlexaに送信するよう要求します。その他の情報については、コンテキストを参照してください。

ヘッダーのパラメーター

ペイロードのパラメーター

空のペイロードが送信されます。

EnterDiscoverableModeディレクティブ

このディレクティブは、クライアントの検出可能モードに入るよう指示します。これにより、ユーザーはスマートフォンなどのピアデバイスからBluetoothのペアリングを開始できます。クライアントが正常に検出可能モードに入ったら、EnterDiscoverableModeSucceededイベントがAVSに送信される必要があります。クライアントが「検出可能」モードになれなかった場合、EnterDiscoverableModeFailedが送信される必要があります。

サンプルメッセージ

{
  "directive": {
    "header": {
      "namespace": "Bluetooth",
      "name": "EnterDiscoverableMode",
      "messageId": "{{STRING}}"
    },
    "payload": {
      "durationInSeconds": {{LONG}}
    }
  }
}

ヘッダーのパラメーター

ペイロードのパラメーター

EnterDiscoverableModeSucceededイベント

このイベントは、クライアントが検出可能モードに入ったときに送信される必要があります。

サンプルメッセージ

{
  "context": [
    // This is an array of context objects that are used to communicate the
    // state of all client components to Alexa.See Context for details.
  ],
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "EnterDiscoverableModeSucceeded",
      "messageId": "{{STRING}}"
    },
    "payload": {
    }
  }
}

コンテキスト

このイベントは、クライアントに対してすべてのクライアントコンポーネントのステータスをAlexaに送信するよう要求します。その他の情報については、コンテキストを参照してください。

ヘッダーのパラメーター

ペイロードのパラメーター

空のペイロードが送信されます。

EnterDiscoverableModeFailedイベント

このイベントは、クライアントが検出可能モードに入れなかったときに送信される必要があります。注：これは、下位のプロトコルまたはドライバーの問題が原因で起こる場合があります。

サンプルメッセージ

{
  "context": [
    // This is an array of context objects that are used to communicate the
    // state of all client components to Alexa.See Context for details.
  ],
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "EnterDiscoverableModeFailed",
      "messageId": "{{STRING}}"
    },
    "payload": {
    }
  }
}

コンテキスト

このイベントは、クライアントに対してすべてのクライアントコンポーネントのステータスをAlexaに送信するよう要求します。その他の情報については、コンテキストを参照してください。

ヘッダーのパラメーター

ペイロードのパラメーター

空のペイロードが送信されます。

ExitDiscoverableModeディレクティブ

このディレクティブは、検出可能モードを終了するようにクライアントに指示します。たとえば、ユーザーがAmazon AlexaアプリからBluetoothのペアリングをキャンセルした場合、このディレクティブがサービスからクライアントに送信されます。

サンプルメッセージ

{
  "directive": {
    "header": {
      "namespace": "Bluetooth",
      "name": "ExitDiscoverableMode",
      "messageId": "{{STRING}}"
    },
    "payload": {
    }
  }
}

ヘッダーのパラメーター

ペイロードのパラメーター

このディレクティブのペイロードは空です。

PairDeviceディレクティブ

このディレクティブは、特定のBluetoothデバイスとのペアリングを開始するようにクライアントに指示します。uniqueDeviceIdは、ピアデバイスのMACアドレスとのローカルマッピングを維持するために使用されます。

クライアントが特定のデバイスと正常にペアリングされた場合、PairDeviceSucceededが送信される必要があります。クライアントが特定のデバイスとのペアリングに失敗した場合、PairDeviceFailedが送信される必要があります。

サンプルメッセージ

{
  "directive": {
    "header": {
      "namespace": "Bluetooth",
      "name": "PairDevice",
      "messageId": "{{STRING}}"
    },
    "payload": {
      "device": {
        "uniqueDeviceId": "{{STRING}}"
      }
    }
  }
}

ヘッダーのパラメーター

ペイロードのパラメーター

PairDeviceSucceededイベント

このイベントは、クライアントがピアBluetoothデバイスと正常にペアリングされた場合に送信される必要があります。

サンプルメッセージ

{
  "context": [
    // This is an array of context objects that are used to communicate the
    // state of all client components to Alexa.See Context for details.
  ],
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "PairDeviceSucceeded",
      "messageId": "{{STRING}}"
    },
    "payload": {
      "device": {
        "uniqueDeviceId": "{{STRING}}",
        "friendlyName": "{{STRING}}"
      }
    }
  }
}

コンテキスト

このイベントは、クライアントに対してすべてのクライアントコンポーネントのステータスをAlexaに送信するよう要求します。その他の情報については、コンテキストを参照してください。

ヘッダーのパラメーター

ペイロードのパラメーター

PairDeviceFailedイベント

このイベントは、クライアントがピアBluetoothデバイスとのペアリングに失敗した場合に送信される必要があります。

サンプルメッセージ

{
  "context": [
    // This is an array of context objects that are used to communicate the
    // state of all client components to Alexa.See Context for details.
  ],
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "PairDeviceFailed",
      "messageId": "{{STRING}}"
    },
    "payload": {
    }
  }
}

コンテキスト

このイベントは、クライアントに対してすべてのクライアントコンポーネントのステータスをAlexaに送信するよう要求します。その他の情報については、コンテキストを参照してください。

ヘッダーのパラメーター

ペイロードのパラメーター

空のペイロードが送信されます。

UnpairDeviceディレクティブ

このディレクティブは、特定のBluetoothデバイスとのペアリングを解除するようにクライアントに指示します。クライアントが特定のデバイスから正常にペアリング解除された場合、UnpairDeviceSucceededが送信される必要があります。クライアントが特定のデバイスからのペアリング解除に失敗した場合、UnpairDeviceFailedが送信される必要があります。

サンプルメッセージ

{
  "directive": {
    "header": {
      "namespace": "Bluetooth",
      "name": "UnpairDevice",
      "messageId": "{{STRING}}"
    },
    "payload": {
      "device": {
        "uniqueDeviceId": "{{STRING}}"
      }
    }
  }
}

ヘッダーのパラメーター

ペイロードのパラメーター

UnpairDeviceSucceededイベント

このイベントは、クライアントがピアBluetoothデバイスから正常にペアリング解除された場合に送信される必要があります。

サンプルメッセージ

{
  "context": [
    // This is an array of context objects that are used to communicate the
    // state of all client components to Alexa.See Context for details.
  ],
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "UnpairDeviceSucceeded",
      "messageId": "{{STRING}}"
    },
    "payload": {
      "device": {
        "uniqueDeviceId": "{{STRING}}",
        "friendlyName": "{{STRING}}"
      }
    }
  }
}

コンテキスト

このイベントは、クライアントに対してすべてのクライアントコンポーネントのステータスをAlexaに送信するよう要求します。その他の情報については、コンテキストを参照してください。

ヘッダーのパラメーター

ペイロードのパラメーター

UnpairDeviceFailedイベント

このイベントは、クライアントがピアBluetoothデバイスからのペアリング解除に失敗した場合に送信される必要があります。

サンプルメッセージ

{
  "context": [
    // This is an array of context objects that are used to communicate the
    // state of all client components to Alexa.See Context for details.
  ],
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "UnpairDeviceFailed",
      "messageId": "{{STRING}}"
    },
    "payload": {
    }
  }
}

コンテキスト

このイベントは、クライアントに対してすべてのクライアントコンポーネントのステータスをAlexaに送信するよう要求します。その他の情報については、コンテキストを参照してください。

ヘッダーのパラメーター

ペイロードのパラメーター

空のペイロードが送信されます。

ConnectByDeviceIdディレクティブ

このディレクティブは、デバイスのuniqueDeviceIdを使用して、ペアリングされたBluetoothデバイスとの接続を確立するようにクライアントに指示します。クライアントが特定のデバイスとの接続を正常に確立した場合、ConnectByDeviceIdSucceededが送信される必要があります。クライアントが特定のデバイスとの接続確立に失敗した場合、ConnectByDeviceIdFailedが送信される必要があります。

サンプルメッセージ

{
  "directive": {
    "header": {
      "namespace": "Bluetooth",
      "name": "ConnectByDeviceId",
      "messageId": "{{STRING}}"
    },
    "payload": {
      "device": {
        "uniqueDeviceId": "{{STRING}}"
      }
    }
  }
}

ヘッダーのパラメーター

ペイロードのパラメーター

ConnectByDeviceIdSucceededイベント

このイベントは、クライアントがuniqueDeviceIdを使用してペアリングされたBluetoothデバイスとの接続を正常に確立した場合に送信される必要があります。

サンプルメッセージ

{
  "context": [
    // This is an array of context objects that are used to communicate the
    // state of all client components to Alexa.See Context for details.
  ],
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "ConnectByDeviceIdSucceeded",
      "messageId": "{{STRING}}"
    },
    "payload": {
      "device": {
        "uniqueDeviceId": "{{STRING}}",
        "friendlyName": "{{STRING}}"
      },
      "requester": "{{STRING}}"
    }
  }
}

コンテキスト

このイベントは、クライアントに対してすべてのクライアントコンポーネントのステータスをAlexaに送信するよう要求します。その他の情報については、コンテキストを参照してください。

ヘッダーのパラメーター

ペイロードのパラメーター

ConnectByDeviceIdFailedイベント

このイベントは、クライアントがuniqueDeviceIdを使用してペアリングされたBluetoothデバイスと接続しようとして失敗した場合に送信される必要があります。

サンプルメッセージ

{
  "context": [
    // This is an array of context objects that are used to communicate the
    // state of all client components to Alexa.See Context for details.
  ],
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "ConnectByDeviceIdFailed",
      "messageId": "{{STRING}}"
    },
    "payload": {
      "device": {
        "uniqueDeviceId": "{{STRING}}",
        "friendlyName": "{{STRING}}"
      },
      "requester": "{{STRING}}"
    }
  }
}

コンテキスト

このイベントは、クライアントに対してすべてのクライアントコンポーネントのステータスをAlexaに送信するよう要求します。その他の情報については、コンテキストを参照してください。

ヘッダーのパラメーター

ペイロードのパラメーター

ConnectByProfileディレクティブ

このディレクティブは、ピアBluetoothデバイスからのプロファイル情報を使用して、ペアリングされたBluetoothデバイスとの接続を確立するようにクライアントに指示します。指定されたプロファイルを複数のデバイスで共有している場合、クライアントは最後のデバイスとの接続を確立する必要があります。

nameパラメーターは、デバイスが送信側または受信側かを判断するのに使用されます。例：

• ユーザーが「アレクサ、スマートフォンとペアリングして」と言った場合、スマートフォンが送信側として動作するため、プロファイルはA2DP-SOURCEとなります。
• ユーザーが「アレクサ、スピーカーとペアリングして」と言った場合、スピーカーが受信側として動作するため、プロファイルはA2DP-SINKとなります。
• ユーザーが「アレクサ、Bluetoothに接続して」と言った場合、デバイスは送信側としても受信側としても動作できるため、プロファイルはA2DPとなります。

クライアントが特定のデバイスとの接続を正常に確立した場合、ConnectByProfileSucceededがAVSに送信される必要があります。クライアントが特定のデバイスとの接続確立に失敗した場合、ConnectByProfileFailedが送信される必要があります。

サンプルメッセージ

{
  "directive": {
    "header": {
      "namespace": "Bluetooth",
      "name": "ConnectByProfile",
      "messageId": "{{STRING}}"
    },
    "payload": {
      "profile": {
        "name": "{{STRING}}",
        "version": "{{STRING}}"
      }
    }
  }
}

ヘッダーのパラメーター

ペイロードのパラメーター

ConnectByProfileSucceededイベント

このイベントは、クライアントがConnectByProfileで指定されたprofileを使用してペアリングされたBluetoothデバイスとの接続を正常に確立した場合に送信される必要があります。

サンプルメッセージ

{
  "context": [
    // This is an array of context objects that are used to communicate the
    // state of all client components to Alexa.See Context for details.
  ],
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "ConnectByProfileSucceeded",
      "messageId": "{{STRING}}"
    },
    "payload": {
      "device": {
        "uniqueDeviceId": "{{STRING}}",
        "friendlyName": "{{STRING}}"
      },
      "requester": "{{STRING}}",
      "profileName": "{{STRING}}"
    }
  }
}

コンテキスト

このイベントは、クライアントに対してすべてのクライアントコンポーネントのステータスをAlexaに送信するよう要求します。その他の情報については、コンテキストを参照してください。

ヘッダーのパラメーター

ペイロードのパラメーター

ConnectByProfileFailedイベント

このイベントは、クライアントがConnectByProfileディレクティブで指定されたprofileを使用してペアリングされたBluetoothデバイスと接続しようとして失敗した場合に送信される必要があります。

サンプルメッセージ

{
  "context": [
    // This is an array of context objects that are used to communicate the
    // state of all client components to Alexa.See Context for details.
  ],
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "ConnectByProfileFailed",
      "messageId": "{{STRING}}"
    },
    "payload": {
      "requester": "{{STRING}}",
      "profileName": "{{STRING}}"
    }
  }
}

コンテキスト

このイベントは、クライアントに対してすべてのクライアントコンポーネントのステータスをAlexaに送信するよう要求します。その他の情報については、コンテキストを参照してください。

ヘッダーのパラメーター

ペイロードのパラメーター

DisconnectDeviceディレクティブ

このディレクティブは、指定されたBluetoothデバイスとの接続を解除するようにクライアントに指示します。クライアントが指定したBluetoothデバイスから正常に接続解除された場合、DisconnectDeviceSucceededが送信される必要があります。クライアントが指定されたデバイスとの接続解除に失敗した場合、DisconnectDeviceFailedが送信される必要があります。

サンプルメッセージ

{
  "directive": {
    "header": {
      "namespace": "Bluetooth",
      "name": "ConnectByDeviceId",
      "messageId": "{{STRING}}"
    },
    "payload": {
      "device": {
        "uniqueDeviceId": "{{STRING}}"
      }
    }
  }
}

ヘッダーのパラメーター

ペイロードのパラメーター

DisconnectDeviceSucceededイベント

このイベントは、クライアントがペアリングされたBluetoothデバイスから正常に接続解除されたときに、DisconnectDevice受信した後で送信される必要があります。

サンプルメッセージ

{
  "context": [
    // This is an array of context objects that are used to communicate the
    // state of all client components to Alexa.See Context for details.
  ],
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "DisconnectDeviceSucceeded",
      "messageId": "{{STRING}}"
    },
    "payload": {
      "device": {
        "uniqueDeviceId": "{{STRING}}",
        "friendlyName": "{{STRING}}"
      },
        "requester": "{{STRING}}"
    }
  }
}

コンテキスト

このイベントは、クライアントに対してすべてのクライアントコンポーネントのステータスをAlexaに送信するよう要求します。その他の情報については、コンテキストを参照してください。

ヘッダーのパラメーター

ペイロードのパラメーター

DisconnectDeviceFailedイベント

このイベントは、クライアントがペアリングされたBluetoothデバイスからの接続解除に失敗したときに、DisconnectDevice受信した後で送信される必要があります。

サンプルメッセージ

{
  "context": [
    // This is an array of context objects that are used to communicate the
    // state of all client components to Alexa.See Context for details.
  ],
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "DisconnectDeviceFailed",
      "messageId": "{{STRING}}"
    },
    "payload": {
      "device": {
        "uniqueDeviceId": "{{STRING}}",
        "friendlyName": "{{STRING}}"
      },
      "requester": "{{STRING}}"
    }
  }
}

コンテキスト

このイベントは、クライアントに対してすべてのクライアントコンポーネントのステータスをAlexaに送信するよう要求します。その他の情報については、コンテキストを参照してください。

ヘッダーのパラメーター

ペイロードのパラメーター

Bluetoothのストリーミング状態の管理

これらのイベントは、Bluetoothストリーミングが開始または終了したことをAlexaに知らせるために送信されます。

このダイアグラムは、クライアントがBluetoothストリーミング状態の変更をレポートする必要がある場合を示しています。

StreamingStartedイベント

このイベントは以下の場合に送信されます。

• 接続されたデバイスのストリーミング状態がINACTIVEからACTIVEに変わります。
• 接続されたデバイスのストリーミング状態がPAUSEDからACTIVEに変わります。

{
    "event": {
        "header": {
            "namespace": "Bluetooth",
            "name": "StreamingStarted",
            "messageId": "{{STRING}}",
        },
        "payload": {
            "device": {
                "uniqueDeviceId": "{{STRING}}"
            }
        }
    }
}

ペイロードのパラメーター

StreamingEndedイベント

このイベントは、接続されたデバイスのBluetoothストリーミング状態がACTIVEからPAUSEDに変わったときにAlexaに送信されます。

{
    "event": {
        "header": {
            "namespace": "Bluetooth",
            "name": "StreamingEnded",
            "messageId": "{{STRING}}",
        },
        "payload": {
            "device": {
                "uniqueDeviceId": "{{STRING}}"
            }
        }
    }
}

Bluetooth経由のメディア操作

Bluetoothインターフェースのメディア操作のディレクティブは、A2DP-SOURCEとして設定されたプロファイルを使用して接続されたBluetoothデバイスから送信されたコンテンツの再生と管理に使用されます。これらのコマンドをBluetoothチャンネルを通じて接続されたデバイスに渡すのは、AVSクライアントの役割です。

Bluetooth経由のメディア操作には、contextでレポートされるストリーミング状態が正確であることが必要です。この表は、接続されたBluetoothデバイスのストリーミング状態とプロファイルに基づいて、どのディレクティブがAVSクライアントに配信されるかを表しています。

Playディレクティブ

このディレクティブは、接続されたBluetoothデバイスのプロファイルをA2DP-SOURCEにセットし、A2DP-SINKデバイス上で再生を開始するように、接続されたBluetoothデバイスに指示します。ディレクティブが正常に処理された場合はMediaControlPlaySucceededが送信される必要があります。クライアントがディレクティブを処理できなかった場合、MediaControlPlayFailedが送信される必要があります。

サンプルメッセージ

{
  "directive": {
    "header": {
      "namespace": "Bluetooth",
      "name": "Play",
      "messageId": "{{STRING}}"
    },
    "payload": {
    }
  }
}

ヘッダーのパラメーター

ペイロードのパラメーター

このディレクティブのペイロードは空です。

MediaControlPlaySucceededイベント

このイベントは、A2DP-SOURCEによってPlayディレクティブが正常に処理された場合に送信される必要があります。

サンプルメッセージ

{
  "context": [
    // This is an array of context objects that are used to communicate the
    // state of all client components to Alexa.See Context for details.
  ],
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "MediaControlPlaySucceeded",
      "messageId": "{{STRING}}"
    },
    "payload": {
    }
  }
}

コンテキスト

このイベントは、クライアントに対してすべてのクライアントコンポーネントのステータスをAlexaに送信するよう要求します。その他の情報については、コンテキストを参照してください。

ヘッダーのパラメーター

ペイロードのパラメーター

空のペイロードが送信されます。

MediaControlPlayFailedイベント

このイベントは、A2DP-SOURCEがPlayディレクティブを処理できなかった場合に送信される必要があります。

サンプルメッセージ

{
  "context": [
    // This is an array of context objects that are used to communicate the
    // state of all client components to Alexa.See Context for details.
  ],
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "MediaControlPlayFailed",
      "messageId": "{{STRING}}"
    },
    "payload": {
    }
  }
}

コンテキスト

このイベントは、クライアントに対してすべてのクライアントコンポーネントのステータスをAlexaに送信するよう要求します。その他の情報については、コンテキストを参照してください。

ヘッダーのパラメーター

ペイロードのパラメーター

空のペイロードが送信されます。

Stopディレクティブ

このディレクティブは、接続されたA2DP-SINKデバイスでの再生を停止するようにA2DP-SOURCEに指示します。ディレクティブが正常に処理された場合はMediaControlStopSucceededが送信される必要があります。クライアントがディレクティブを処理できなかった場合、MediaControlStopFailedが送信される必要があります。

サンプルメッセージ

{
  "directive": {
    "header": {
      "namespace": "Bluetooth",
      "name": "Stop",
      "messageId": "{{STRING}}"
    },
    "payload": {
    }
  }
}

ヘッダーのパラメーター

ペイロードのパラメーター

このディレクティブのペイロードは空です。

MediaControlStopSucceededイベント

このイベントは、A2DP-SOURCEによってStopディレクティブが正常に処理された場合に送信される必要があります。

サンプルメッセージ

{
  "context": [
    // This is an array of context objects that are used to communicate the
    // state of all client components to Alexa.See Context for details.
  ],
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "MediaControlStopSucceeded",
      "messageId": "{{STRING}}"
    },
    "payload": {
    }
  }
}

コンテキスト

このイベントは、クライアントに対してすべてのクライアントコンポーネントのステータスをAlexaに送信するよう要求します。その他の情報については、コンテキストを参照してください。

ヘッダーのパラメーター

ペイロードのパラメーター

空のペイロードが送信されます。

MediaControlStopFailedイベント

このイベントは、A2DP-SOURCEがStopディレクティブを処理できなかった場合に送信される必要があります。

サンプルメッセージ

{
  "context": [
    // This is an array of context objects that are used to communicate the
    // state of all client components to Alexa.See Context for details.
  ],
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "MediaControlStopFailed",
      "messageId": "{{STRING}}"
    },
    "payload": {
    }
  }
}

コンテキスト

このイベントは、クライアントに対してすべてのクライアントコンポーネントのステータスをAlexaに送信するよう要求します。その他の情報については、コンテキストを参照してください。

ヘッダーのパラメーター

ペイロードのパラメーター

空のペイロードが送信されます。

Nextディレクティブ

このディレクティブは、接続されたA2DP-SINKデバイスで次のメディア項目にスキップするようにA2DP-SOURCEに指示します。ディレクティブが正常に処理された場合はMediaControlNextSucceededが送信される必要があります。クライアントがディレクティブを処理できなかった場合、MediaControlNextFailedが送信される必要があります。

サンプルメッセージ

{
  "directive": {
    "header": {
      "namespace": "Bluetooth",
      "name": "Next",
      "messageId": "{{STRING}}"
    },
    "payload": {
    }
  }
}

ヘッダーのパラメーター

ペイロードのパラメーター

このディレクティブのペイロードは空です。

MediaControlNextSucceededイベント

このイベントは、A2DP-SOURCEによってNextディレクティブが正常に処理された場合に送信される必要があります。

サンプルメッセージ

{
  "context": [
    // This is an array of context objects that are used to communicate the
    // state of all client components to Alexa.See Context for details.
  ],
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "MediaControlNextSucceeded",
      "messageId": "{{STRING}}"
    },
    "payload": {
    }
  }
}

コンテキスト

このイベントは、クライアントに対してすべてのクライアントコンポーネントのステータスをAlexaに送信するよう要求します。その他の情報については、コンテキストを参照してください。

ヘッダーのパラメーター

ペイロードのパラメーター

空のペイロードが送信されます。

MediaControlNextFailedイベント

このイベントは、A2DP-SOURCEがStopディレクティブを処理できなかった場合に送信される必要があります。

サンプルメッセージ

{
  "context": [
    // This is an array of context objects that are used to communicate the
    // state of all client components to Alexa.See Context for details.
  ],
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "MediaControlNextFailed",
      "messageId": "{{STRING}}"
    },
    "payload": {
    }
  }
}

コンテキスト

このイベントは、クライアントに対してすべてのクライアントコンポーネントのステータスをAlexaに送信するよう要求します。その他の情報については、コンテキストを参照してください。

ヘッダーのパラメーター

ペイロードのパラメーター

空のペイロードが送信されます。

Previousディレクティブ

このディレクティブは、接続されたA2DP-SINKデバイスで前のメディア項目にスキップするようにA2DP-SOURCEに指示します。ディレクティブが正常に処理された場合はMediaControlPreviousSucceededが送信される必要があります。クライアントがディレクティブを処理できなかった場合、MediaControlPreviousFailedが送信される必要があります。

サンプルメッセージ

{
  "directive": {
    "header": {
      "namespace": "Bluetooth",
      "name": "Previous",
      "messageId": "{{STRING}}"
    },
    "payload": {
    }
  }
}

ヘッダーのパラメーター

ペイロードのパラメーター

空のペイロードが送信されます。

MediaControlPreviousSucceededイベント

このイベントは、A2DP-SOURCEによってPreviousディレクティブが正常に処理された場合に送信される必要があります。

サンプルメッセージ

{
  "context": [
    // This is an array of context objects that are used to communicate the
    // state of all client components to Alexa.See Context for details.
  ],
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "MediaControlPreviousSucceeded",
      "messageId": "{{STRING}}"
    },
    "payload": {
    }
  }
}

コンテキスト

このイベントは、クライアントに対してすべてのクライアントコンポーネントのステータスをAlexaに送信するよう要求します。その他の情報については、コンテキストを参照してください。

ヘッダーのパラメーター

ペイロードのパラメーター

空のペイロードが送信されます。

MediaControlPreviousFailedイベント

このイベントは、A2DP-SOURCEがPreviousディレクティブを処理できなかった場合に送信される必要があります。

サンプルメッセージ

{
  "context": [
    // This is an array of context objects that are used to communicate the
    // state of all client components to Alexa.See Context for details.
  ],
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "MediaControlPreviousFailed",
      "messageId": "{{STRING}}"
    },
    "payload": {
    }
  }
}

コンテキスト

このイベントは、クライアントに対してすべてのクライアントコンポーネントのステータスをAlexaに送信するよう要求します。その他の情報については、コンテキストを参照してください。

ヘッダーのパラメーター

ペイロードのパラメーター

空のペイロードが送信されます。