Bluetooth 1.0

Overview

The Bluetooth interface exposes directives and events that are used to manage a client's Bluetooth connection with peer devices, such as smart phones, and Bluetooth-enabled speakers. The interface supports the following profiles: A2DP sink and source, and AVRCP target and controller.

• A2DP source - Originates content, such as streaming audio.
• A2DP sink - Receives content, such as streaming audio.
• AVRCP controller and target - Controls media playback on remote devices. Typically, this profiles is used with A2DP profiles for next, previous, pause, and play controls.

Additionally, this interface exposes directives and events that are used to control media playback on connected Bluetooth A2DP source devices (see Media Control via Bluetooth for a complete list of directives and events.).

Supported use cases:

• Scan, pair, and unpair Bluetooth devices via the Amazon Alexa App.
• Connect and disconnect Bluetooth devices with voice and via the Amazon Alexa App.
• Control media playback when a connected Bluetooth device is set as A2DP source.

Sequence diagrams

The Bluetooth interface supports scanning, connecting/disconnecting, and pairing/unpairing from Bluetooth peer devices using voice, on-product GUI, the Amazon Alexa App, and third-party companion apps. These sequence diagrams illustrate supported Bluetooth interactions, and the associated directives and events exchanged between your client and AVS.

This set of sequence diagrams illustrate interactions initiated via voice.

Pair a Bluetooth device using voice

Show details

Media Controls

Media control directives in the Bluetooth interface are used to manage and control playback of content originating from a connected Bluetooth device with its profile set as A2DP-SOURCE. It is the responsibility of your AVS client to pass these commands to the connected device over the Bluetooth channel.

Media control via Bluetooth requires accurate reporting of streaming state in the context. This table shows which directives are delivered to your AVS client based on the streaming state and profile of your connected Bluetooth device:

Manage Bluetooth Streaming State

These events are sent to notify Alexa that Bluetooth streaming has started or ended.

This diagram illustrates when a client is required to report a change in Bluetooth streaming state:

Capability assertion

Bluetooth 1.0 may be implemented by the device on its own behalf, but not on behalf of any connected endpoints.

New AVS integrations must assert support through Alexa.Discovery, but Alexa will continue to support existing integrations using the Capabilities API.

Sample Object

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

Context

Context is a container used to communicate the state of your client components to AVS. Context should reflect the state of client components just before an event is fired.

All events that require context must include an object for Bluetooth.BluetoothState if Bluetooth is enabled.

Sample Context

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

Payload Parameters

Streaming State

The streaming state your product sends up in the Context object determines if your product will receive playback commands. Use this table to determine which state must be provided to Alexa for activeDevice.streaming:

This table shows the streaming state that your product must be in before and after a user request, such as pairing:

Directives

ScanDevices

This directive instructs a client to scan for discoverable Bluetooth devices. Your client must send a ScanDevicesUpdated each time Bluetooth devices are discovered. If the scan fails, your client must send the ScanDevicesFailed event to AVS.

Sample Message

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

Header Parameters

Payload Parameters

This directive has an empty payload.

EnterDiscoverableMode

This directive instructs a client to enter discoverable mode, which allows a user to initiate Bluetooth pairing from a peer device, such as a smart phone. When your client successfully enters discoverable mode, the EnterDiscoverableModeSucceeded event must be sent to AVS. If your client fails to enter "discoverable" mode, it must send EnterDiscoverableModeFailed.

Sample Message

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

Header Parameters

Payload Parameters

PairDevice

This directive instructs a client to initiate pairing with a specific Bluetooth device. The uniqueDeviceId should be used to maintain a local mapping with the peer device's MAC address.

When a client successfully pairs with the specified device, the PairDeviceSucceeded event must be sent. If your client fails to pair with the specified device, it must send PairDeviceFailed.

Sample Message

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

Header Parameters

Payload Parameters

ExitDiscoverableMode

This directive instructs a client to exit discoverable mode. For example, if a user cancels Bluetooth pairing from the Amazon Alexa App, this directive is sent from the service to your client.

Sample Message

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

Header Parameters

Payload Parameters

This directive has an empty payload.

UnpairDevice

This directive instructs a client to unpair from a specific Bluetooth device. When a client successfully unpairs with the specified Bluetooth device, the UnpairDeviceSucceeded event must be sent. If the client fails to unpair with the specified Bluetooth device, it must send UnpairDeviceFailed.

Sample Message

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

Header Parameters

Payload Parameters

ConnectByDeviceId

This directive instructs a client to establish a connection with a paired Bluetooth device using that device's uniqueDeviceId. When a client successfully establishes a connection with the specified device, the ConnectByDeviceIdSucceeded event must be sent. If the client fails to establish a connection with the specified device, it must send ConnectByDeviceIdFailed.

Sample Message

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

Header Parameters

Payload Parameters

ConnectByProfile

This directive instructs a client to establish a connection with a paired Bluetooth device using profile information from the peer Bluetooth device. If multiple devices share the specified profile, the client should establish a connection with the last device to establish a connection.

The name parameter should be used to determine if the device is SOURCE or SINK. For example:

• When a user says, "Alexa, pair my phone" the profile is A2DP-SOURCE, since the phone acts as SOURCE.
• When a user says "Alexa, pair my speaker" the profile is A2DP-SINK, since the speaker acts as SINK.
• When a user says, "Alexa, connect to Bluetooth" the profile is A2DP, since the device can connect as SOURCE or SINK.

When a client successfully establishes a connection with the specified device, the ConnectByProfileSucceeded event must be sent to AVS. If the client fails to establish a connection with the specified device, it must send ConnectByProfileFailed.

Sample Message

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

Header Parameters

Payload Parameters

DisconnectDevice

This directive instructs a client to disconnect from a specified Bluetooth device. When a client successfully disconnects from a specified Bluetooth device, the DisconnectDeviceSucceeded event must be sent. If the client fails to establish a connection with the specified device, it must send DisconnectDeviceFailed.

Sample Message

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

Header Parameters

Payload Parameters

Play

This directive instructs the connected Bluetooth device, with its profile set as A2DP-SOURCE, to initiate playback on the A2DP sink device. When the directive is successfully processed, the MediaControlPlaySucceeded. If the client fails to process the directive, it must send MediaControlPlayFailed.

Sample Message

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

Header Parameters

Payload Parameters

This directive has an empty payload.

Stop

This directive instructs the A2DP source to stop playback on the connected A2DP sink device. When the directive is successfully processed, the MediaControlStopSucceeded must be sent. If the client fails to process the directive, MediaControlStopFailed must be sent.

Sample Message

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

Header Parameters

Payload Parameters

This directive has an empty payload.

Next

This directive instructs the A2DP source to skip to the next media item on the connected A2DP sink device. When the directive is successfully processed, the MediaControlNextSucceeded is sent. If the client fails to process the directive, MediaControlNextFailed must be sent.

Sample Message

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

Header Parameters

Payload Parameters

This directive has an empty payload.

Previous

This directive instructs the A2DP source to skip to the previous media item on the connected A2DP sink device. When the directive is successfully processed, the MediaControlPreviousSucceeded. If the client fails to process the directive, it must send MediaControlPreviousFailed.

Sample Message

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

Header Parameters

Payload Parameters

An empty payload is sent.

Events

ScanDevicesUpdated

After receiving a ScanDevices directive, this event must be sent periodically as Bluetooth devices are discovered. discoveredDevices must contain an object for all discovered device from when the scan was initiated (not the delta from the previous event).

Sample Message

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

Context

This event requires the client to send the status of all client component states to Alexa. For additional information see Context.

Header Parameters

Payload Parameters

ScanDevicesFailed

After receiving a ScanDevices directive, this event must be sent if the scan operation fails. If the scan fails, the list of discovered Bluetooth devices in the companion app will be cleared. Note: A scan failure is indepedent of devices being discovered. Most often, this a failure is the result of: a low-level protocol issue, driver issues, or being in an incompatible state when the scan is initiated.

Sample Message

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

Context

This event requires the client to send the status of all client component states to Alexa. For additional information see Context.

Header Parameters

Payload Parameters

An empty payload is sent.

EnterDiscoverableModeSucceeded

This event must be sent when your client enters discoverable mode.

Sample Message

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

Context

This event requires the client to send the status of all client component states to Alexa. For additional information see Context.

Header Parameters

Payload Parameters

An empty payload is sent.

EnterDiscoverableModeFailed

This event must be sent when your client fails to enter discoverable mode. Note: This may occur as the result of a low-level protocol or driver issue.

Sample Message

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

Context

This event requires the client to send the status of all client component states to Alexa. For additional information see Context.

Header Parameters

Payload Parameters

An empty payload is sent.

PairDeviceSucceeded

This event must be sent when a client successfully pairs with a peer Bluetooth device.

Sample Message

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

Context

This event requires the client to send the status of all client component states to Alexa. For additional information see Context.

Header Parameters

Payload Parameters

PairDeviceFailed

This event must be sent when a client fails to pair with a peer Bluetooth device.

Sample Message

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

Context

This event requires the client to send the status of all client component states to Alexa. For additional information see Context.

Header Parameters

Payload Parameters

An empty payload is sent.

UnpairDeviceSucceeded

This event must be sent when a client unpairs with a Bluetooth device.

Sample Message

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

Context

This event requires the client to send the status of all client component states to Alexa. For additional information see Context.

Header Parameters

Payload Parameters

UnpairDeviceFailed

This event must be sent when a client fails to unpair with a Bluetooth device.

Sample Message

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

Context

This event requires the client to send the status of all client component states to Alexa. For additional information see Context.

Header Parameters

Payload Parameters

An empty payload is sent.

ConnectByDeviceIdSucceeded

This event must be sent when a client establishes a connection with a paired Bluetooth device using uniqueDeviceId.

Sample Message

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

Context

This event requires the client to send the status of all client component states to Alexa. For additional information see Context.

Header Parameters

Payload Parameters

ConnectByDeviceIdFailed

This event must be sent when the attempt to connect to a paired Bluetooth device using uniqueDeviceId fails.

Sample Message

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

Context

This event requires the client to send the status of all client component states to Alexa. For additional information see Context.

Header Parameters

Payload Parameters

ConnectByProfileSucceeded

This event must be sent when a client establishes a connection with a paired Bluetooth device using the profile provided in the ConnectByProfile directive.

Sample Message

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

Context

This event requires the client to send the status of all client component states to Alexa. For additional information see Context.

Header Parameters

Payload Parameters

ConnectByProfileFailed

This event must be sent when the attempt to connect to a paired Bluetooth device using the profile provided in the ConnectByProfile directive fails.

Sample Message

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

Context

This event requires the client to send the status of all client component states to Alexa. For additional information see Context.

Header Parameters

Payload Parameters

DisconnectDeviceSucceeded

This event must be sent after receiving a DisconnectDevice directive, when a client successfully disconnects from a paired Bluetooth device.

Sample Message

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

Context

This event requires the client to send the status of all client component states to Alexa. For additional information see Context.

Header Parameters

Payload Parameters

DisconnectDeviceFailed

This event must be sent after receiving a DisconnectDevice directive, when a client fails to disconnect from a paired Bluetooth device.

Sample Message

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

Context

This event requires the client to send the status of all client component states to Alexa. For additional information see Context.

Header Parameters

Payload Parameters

StreamingStarted

This event is sent to Alexa when:

• Bluetooth streaming state of a connected device changes from INACTIVE to ACTIVE
• Bluetooth streaming state of a connected device changes from PAUSED to ACTIVE

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

Payload Parameters

StreamingEnded

This event is sent to Alexa when Bluetooth streaming state of a connected device changes from ACTIVE to PAUSED.

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

MediaControlPlaySucceeded

This event must be sent when the Play directive is successfully handled by the A2DP source.

Sample Message

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

Context

This event requires the client to send the status of all client component states to Alexa. For additional information see Context.

Header Parameters

Payload Parameters

An empty payload is sent.

MediaControlPlayFailed

This event must be sent when the A2DP source fails to handle the Play directive.

Sample Message

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

Context

This event requires the client to send the status of all client component states to Alexa. For additional information see Context.

Header Parameters

Payload Parameters

An empty payload is sent.

MediaControlStopSucceeded

This event must be sent when the Stop directive is successfully handled by the A2DP source.

Sample Message

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

Context

This event requires the client to send the status of all client component states to Alexa. For additional information see Context.

Header Parameters

Payload Parameters

An empty payload is sent.

MediaControlStopFailed

This event must be sent when the A2DP source fails to handle the Stop directive.

Sample Message

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

Context

This event requires the client to send the status of all client component states to Alexa. For additional information see Context.

Header Parameters

Payload Parameters

An empty payload is sent.

MediaControlNextSucceeded

This event must be sent when the Next directive is successfully handled by the A2DP source.

Sample Message

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

Context

This event requires the client to send the status of all client component states to Alexa. For additional information see Context.

Header Parameters

Payload Parameters

An empty payload is sent.

MediaControlNextFailed

This event must be sent if the A2DP source fails to handle the Stop directive.

Sample Message

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

Context

This event requires the client to send the status of all client component states to Alexa. For additional information see Context.

Header Parameters

Payload Parameters

An empty payload is sent.

MediaControlPreviousSucceeded

This event must be sent when the Previous directive is successfully handled by the A2DP source.

Sample Message

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

Context

This event requires the client to send the status of all client component states to Alexa. For additional information see Context.

Header Parameters

Payload Parameters

An empty payload is sent.

MediaControlPreviousFailed

This event must be sent if the A2DP source fails to handle the Previous directive.

Sample Message

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

Context

This event requires the client to send the status of all client component states to Alexa. For additional information see Context.

Header Parameters

Payload Parameters

An empty payload is sent.

Last updated: Nov 27, 2023