Bluetooth 2.0

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 source, A2DP sink, and AVRCP target and controller

Version changes

• Support for multiple simultaneous connections to Bluetooth peripherals
  • CHANGED BluetoothState context entry:
    • REMOVED activeDevice object
    • ADDED deviceCategory string
    • ADDED connectionState string
    • CHANGED supportedProfiles list to support additional Bluetooth profiles
  • ADDED SetDeviceCategories directive
  • ADDED SetDeviceCategoriesSucceeded event
  • ADDED SetDeviceCategoriesFailed event
  • RENAMED the following messages:
    • ScanDeviceUpdated event to ScanDevicesReport
    • ConnectByDeviceId event to ConnectByDeviceIds
    • DisconnectDevice directive to DisconnectDevices
    • PairDevice directive to PairDevices
    • UnpairDevice directive to UnpairDevices
  • CHANGED the following events by removing the requirement to include context:
    • ScanDevicesReport
    • ScanDevicesFailed
    • UnpairDevicesFailed
    • UnpairDevicesSucceeded
    • DisconnectDevicesSucceeded
    • DisconnectDevicesFailed
    • PairDevicesSucceeded
    • PairDevicesFailed
    • ConnectByDeviceIdsSucceeded
    • ConnectByDeviceIds
    • EnterDiscoverableModeFailed
    • EnterDiscoverableModeSucceeded
    • ConnectByProfileSucceeded
    • ConnectByProfileFailed
    • MediaControlPlaySucceeded
    • MediaControlPlayFailed
    • MediaControlNextSucceeded
    • MediaControlNextFailed
    • MediaControlPreviousSucceeded
    • MediaControlPreviousFailed
    • MediaControlStopSucceeded
    • MediaControlStopFailed
  • CHANGED the payload object of the following messages:
    • UnpairDevicesFailed event
    • UnpairDevicesSucceeded event
    • DisconnectDevicesSucceeded event
    • DisconnectDevicesFailed event
    • PairDevicesSucceeded event
    • PairDevicesFailed event
    • ConnectByDeviceIdsSucceeded event
    • ConnectByDeviceIdsFailed event
    • ConnectByProfileFailed event
    • StreamingStarted event
    • StreamingEnded event
    • MediaControlPlaySucceeded event
    • MediaControlPlayFailed event
    • MediaControlNextSucceeded event
    • MediaControlNextFailed event
    • MediaControlPreviousSucceeded event
    • MediaControlPreviousFailed event
    • MediaControlStopSucceeded event
    • MediaControlStopFailed event
    • PairDevices directive
    • UnpairDevices directive
    • ConnectByDeviceIds directive
    • DisconnectDevices directive
    • SetDeviceCategories directive
    • Play directive
    • Previous directive
    • Next directive
    • Stop directive

Overview

The Bluetooth interface supports the following profiles:

• A2DP source - Originator of content, such as streaming audio.
• A2DP sink - Receiver of content, such as streaming audio.
• AVRCP controller and target - Controls media playback on remote devices. Typically, this profile handles functions such as next, previous, pause, and play.

The Bluetooth interface also controls media playback on connected Bluetooth A2DP source devices. For a complete list of directives and events to handle this functionality, see Media Control through Bluetooth.

Supported use cases:

• Scan, pair, and unpair Bluetooth devices with the Amazon Alexa App.
• Connect and disconnect Bluetooth devices with voice through the Amazon Alexa App.
• Control media playback on Bluetooth devices set to the A2DP source.

Sequence diagrams

The Bluetooth interface supports scanning, connecting/disconnecting, pairing/unpairing from Bluetooth peer devices using voice, on-product GUI, the Amazon Alexa App, and third-party companion apps.

The following sequence diagrams illustrate the directives and events exchanged between your client and the Alexa Voice Service (AVS) when using Bluetooth.

Pair a Bluetooth device by using voice

Media controls

Media control directives manage and control playback of content originating from a connected Bluetooth device with its profile set as A2DP_SOURCE. It's the responsibility of your client to pass these commands to the connected device over the Bluetooth channel.

Media control requires accurate reporting of the streaming state with the context object. The following table explains which directives your AVS client delivers based on the streaming state and profile of your connected Bluetooth device.

Manage Bluetooth streaming state

The following diagram illustrates when a client should report a change in Bluetooth streaming state.

Capability assertion

Bluetooth implements on the device on its own behalf. However, it can't implement on behalf of any connected endpoints.

Sample Object

{
  "type": "AlexaInterface",
  "interface": "Bluetooth",
  "version": "2.0",
  "configurations": {
    "profiles": [
      "AVRCP",
      "A2DP_SINK",
      "A2DP_SOURCE"
    ]
  }
}

Context

Context is a container that communicates the state of your client components to AVS. Context should reflect the state of your client components immediately before an event is fired.

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

Sample Context

{
  "header": {
    "namespace": "Bluetooth",
    "name": "BluetoothState"
  },
  "payload": {
    "alexaDevice": {
      "friendlyName": "{{STRING}}"
    },
    "pairedDevices": [
      {
        "supportedProfiles": [
          {
            "name": "{{STRING}}",
            "version": "{{STRING}}",
            "state": {
              "streaming": "{{STRING}}"
            }
          }
        ],
        "uniqueDeviceId": "{{STRING}}",
        "deviceCategory": "{{STRING}}",
        "friendlyName": "{{STRING}}",
        "connectionState": "{{STRING}}"
      }
    ]
  }
}

Payload Parameters

Streaming State

Use the following rules for any pairedDevice object that connects to a A2DP_SINK or A2DP_SOURCE profile. These rules determine the playback commands Alexa sends to the devices:

Directives

ScanDevices

This directive instructs your client to scan for discoverable Bluetooth devices.

• If the scan discovers a Bluetooth device Send the ScanDevicesReport event to AVS.
• If the scan fails: 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.

SetDeviceCategories

This directive updates the deviceCategory for each discovered device. When a new device pairs with these newly discovered devices, update the Bluetooth Context to include this deviceCategory.

Sample Message

{
  "directive": {
    "header": {
      "namespace": "Bluetooth",
      "name": "SetDeviceCategories",
      "messageId": "{{STRING}}"
    },
    "payload": {
      "devices": [
        {
          "uniqueDeviceId": "{{STRING}}",
          "deviceCategory": "{{STRING}}"
        }
      ]
    }
  }

Header Parameters

Payload Parameters

EnterDiscoverableMode

This directive instructs a client to initiate Bluetooth discovery mode. This mode allows a user to start Bluetooth pairing from a peer device, such as a smart phone.

• When your client to initiate discovery mode, send the EnterDiscoverableModeSucceeded event to AVS.
• If your client fails to initiate discovery mode, send a EnterDiscoverableModeFailed directive to AVS.

Sample Message

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

Header Parameters

Payload Parameters

ExitDiscoverableMode

This directive instructs a client to exit discovery mode. For example, AVS sends ExitDiscoverableMode if a user cancels Bluetooth pairing from the Amazon Alexa app.

Sample Message

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

Header Parameters

Payload Parameters

This directive has an empty payload.

PairDevices

This directive instructs a client to initiate pairing with a specific Bluetooth device. Use uniqueDeviceId to maintain a local mapping with the MAC address of the peer device.

• When your client pairs with the specified device, send a PairDevicesSucceeded event to AVS.
• If your client fails to pair with the specified device, send a PairDevicesFailed event to AVS.

Sample Message

{
  "directive": {
    "header": {
      "namespace": "Bluetooth",
      "name": "PairDevices",
      "messageId": "{{STRING}}"
    },
    "payload": {
      "devices": [
        {
          "uniqueDeviceId": "{{STRING}}"
        }
      ]
    }
  }
}

Header Parameters

Payload Parameters

Stop

This directive instructs the A2DP source to stop playback on the connected A2DP sink.

• When the directive processes, send the MediaControlStopSucceeded event.
• If the client fails to process the directive, send a MediaControlStopFailed event.

Sample Message

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

Header Parameters

Payload Parameters

Play

This directive instructs a connected Bluetooth device to start playback on the A2DP sink device. It only applies to devices that use a Bluetooth profile set to A2DP_SOURCE.

• When a client processes the directive, send the MediaControlPlaySucceeded event.
• If a client fails to process the directive, send the MediaControlPlayFailed event.

Sample Message

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

Header Parameters

Payload Parameters

Previous

This directive instructs the A2DP source to skip to the previous media item on the connected A2DP sink device.

• When the directive processes, send the MediaControlPreviousSucceeded event.
• If the client fails to process the directive, send the MediaControlPreviousFailed event.

Sample Message

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

Header Parameters

Payload Parameters

Next

This directive instructs the A2DP source to skip to the next media item on the connected A2DP sink device. For example, skipping to the next song in a playlist.

• When the directive processes, send the MediaControlNextSucceeded event.
• If the client fails to process the directive, send the MediaControlNextFailed event.

Sample Message

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

Header Parameters

Payload Parameters

UnpairDevices

This directive instructs a client to unpair from a specific Bluetooth device.

• When a client successfully unpairs with the specified Bluetooth device, send an UnpairDevicesSucceeded event to AVS
• If the client fails to unpair with the specified Bluetooth device, send an UnpairDevicesFailed event to AVS.

Sample Message

{
  "directive": {
    "header": {
      "namespace": "Bluetooth",
      "name": "UnpairDevices",
      "messageId": "{{STRING}}"
    },
    "payload": {
      "devices": [
        {
          "uniqueDeviceId": "{{STRING}}"
        }
      ]
    }
  }
}

Header Parameters

Payload Parameters

ConnectByDeviceIds

This directive instructs a client to establish a connection with a paired Bluetooth device using its uniqueDeviceId as the identifier.

• When a client establishes a connection with the specified device, send the ConnectByDeviceIdsSucceeded event to AVS.
• If the client fails to establish a connection with the specified device, send the ConnectByDevicesIdFailed event to AVS.

Sample Message

{
  "directive": {
    "header": {
      "namespace": "Bluetooth",
      "name": "ConnectByDeviceIds",
      "messageId": "{{STRING}}"
    },
    "payload": {
      "devices": [
        {
          "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 most recent device it previously connected to.

• When a client establishes a connection with the specified device, send the ConnectByProfileSucceeded event to AVS.
• If the client fails to establish a connection with the specified device, send the ConnectByProfileFailed event to AVS.

Use the name parameter to determine the Bluetooth profile of a device. SOURCE or SINK are the only two supported profiles. For example:

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

Sample Message

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

Header Parameters

Payload Parameters

DisconnectDevices

This directive instructs a client to disconnect from a specified Bluetooth device.

• When a client disconnects from a specified Bluetooth device, send the DisconnectDevicesSucceeded event.
• If the client fails to establish a connection with the specified device, send the DisconnectDevicesFailed event.

Sample Message

{
  "directive": {
    "header": {
      "namespace": "Bluetooth",
      "name": "DisconnectDevices",
      "messageId": "{{STRING}}"
    },
    "payload": {
      "devices": [
        {
          "uniqueDeviceId": "{{STRING}}"
        }
      ]
    }
  }
}

Header Parameters

Payload Parameters

Events

ScanDevicesReport

This event updates your list of discoverable Bluetooth devices. Send it periodically after receiving a ScanDevices directive.

Sample Message

{
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "ScanDevicesReport",
      "messageId": "{{STRING}}"
    },
    "payload": {
      "discoveredDevices": [
        {
          "uniqueDeviceId": "{{STRING}}",
          "friendlyName": "{{STRING}}",
          "truncatedMacAddress": "{{STRING}}",
          "metadata": {
            "classOfDevice": {{LONG}},
            "vendorId": {{LONG}},
            "productId": {{LONG}},
            "vendorDeviceSigId": {{LONG}},
            "vendorDeviceId": "{{STRING}}"
          }
        }
      ],
      "hasMore": {{BOOLEAN}}
    }
  }
}

Header Parameters

Payload Parameters

ScanDevicesFailed

This event checks if a scan operation has failed. If it detects a failure, it clears the list of discovered Bluetooth devices in the companion app. Only send this event after receiving a ScanDevices directive.

Sample Message

{
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "ScanDevicesFailed",
      "messageId": "{{STRING}}"
    },
    "payload": {
      "errorCode": {{LONG}}
    }
  }
}

Header Parameters

Payload Parameters

Error codes

Expand error code descriptions

SetDeviceCategoriesSucceeded

This event informs AVS that the Bluetooth device category successfully updated after receiving the SetDeviceCategories directive. Send SetDeviceCategoriesSucceeded after receiving the SetDeviceCategories directive.

Sample Message

{
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "SetDeviceCategoriesSucceeded",
      "messageId": "{{STRING}}"
    },
    "payload": {
      "devices": [
        {
          "uniqueDeviceId": "{{STRING}}",
          "deviceCategory": "{{STRING}}"
        }
      ]
    }
  }
}

Header Parameters

Payload Parameters

SetDeviceCategoriesFailed

This event informs AVS that the Bluetooth device category did not update. Send SetDeviceCategoriesFailed after receiving the SetDeviceCategories directive.

Resend all applicable metadata with a this event so AVS can re-determine the device category again. If the device category resolves, AVS sends a new SetDeviceCategories directive.

{
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "SetDeviceCategoriesFailed",
      "messageId": "{{STRING}}"
    },
    "payload": {
      "devices": [
        {
          "uniqueDeviceId": "{{STRING}}",
          "metadata": {
            "classOfDevice": {{LONG}},
            "vendorId": {{LONG}},
            "productId": {{LONG}},
            "vendorDeviceSigId": {{LONG}},
            "vendorDeviceId": "{{STRING}}"
          }
        }
      ]
    }
  }
}

Header Parameters

Payload Parameters

EnterDiscoverableModeSucceeded

Send this event when your client enters discovery mode.

Sample Message

{
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "EnterDiscoverableModeSucceeded",
      "messageId": "{{STRING}}"
    },
    "payload": {}
  }
}

Header Parameters

Payload Parameters

Sends an empty payload.

EnterDiscoverableModeFailed

This event informs AVS that your devices failed to initiate discovery mode after receiving the EnterDiscoverableMode directive. A failure can occur due to low-level protocol issues or driver issues. Send EnterDiscoverableModeFailed after the failure occurs.

Sample Message

{
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "EnterDiscoverableModeFailed",
      "messageId": "{{STRING}}"
    },
    "payload": {}
  }
}

Header Parameters

Payload Parameters

Sends an empty payload.

PairDevicesSucceeded

This event informs AVS that your devices successfully paired after receiving the PairDevices directive. Send PairDevicesSucceeded after the pairing occurs.

Sample Message

{
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "PairDevicesSucceeded",
      "messageId": "{{STRING}}"
    },
    "payload": {
      "devices": [
        {
          "uniqueDeviceId": "{{STRING}}",
          "deviceCategory": "{{STRING}}",
          "friendlyName": "{{STRING}}",
          "profiles": [
            {
              "name": "{{STRING}}",
              "version": "{{STRING}}"
            }
          ]
        }
      ]
    }
  }
}

Header Parameters

Payload Parameters

PairDevicesFailed

Send this event when your client fails to pair with a peer Bluetooth device.

Sample Message

{
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "PairDevicesFailed",
      "messageId": "{{STRING}}"
    },
    "payload": {
      "devices": [
        {
          "uniqueDeviceId": "{{STRING}}",
          "errorCode": {{LONG}}
        }
      ]
    }
  }
}

Header Parameters

Payload Parameters

UnpairDevicesSucceeded

This event informs AVS when a client successfully pairs with a device. Send UnpairDevicesSucceeded after the success occurs.

Sample Message

{
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "UnpairDevicesSucceeded",
      "messageId": "{{STRING}}"
    },
    "payload": {
      "devices": [
        {
          "uniqueDeviceId": "{{STRING}}"
        }
      ]
    }
  }
}

Header Parameters

Payload Parameters

UnpairDevicesFailed

This event informs AVS when a client fails to unpair with a Bluetooth device. Send UnpairDevicesFailed after the failure occurs.

Sample Message

{
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "UnpairDevicesFailed",
      "messageId": "{{STRING}}"
    },
    "payload": {
      "devices": [
        {
          "uniqueDeviceId": "{{STRING}}",
          "errorCode": "{{STRING}}"
        }
      ]
    }
  }
}

Header Parameters

Payload Parameters

ConnectByDeviceIdsSucceeded

This event informs AVS that a client established a connection with a paired Bluetooth device using its uniqueDeviceId as an identifier. Send ConnectByDeviceIdsSucceeded after successfully connecting

Sample Message

{
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "ConnectByDeviceIdsSucceeded",
      "messageId": "{{STRING}}"
    },
    "payload": {
      "devices": [
        {
          "uniqueDeviceId": "{{STRING}}",
          "friendlyName": "{{STRING}}"
        }
      ],
      "requester": "{{STRING}}"
    }
  }
}

Header Parameters

Payload Parameters

ConnectByDeviceIdsFailed

This event informs AVS that a client failed to establish a connection with a paired Bluetooth device using its uniqueDeviceId as an identifier. Send ConnectByDeviceIdsFailed after the failure occurs.

Sample Message

{
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "ConnectByDeviceIdsFailed",
      "messageId": "{{STRING}}"
    },
    "payload": {
      "devices": [
        {
          "uniqueDeviceId": "{{STRING}}",
          "friendlyName": "{{STRING}}",
          "errorCode": {{LONG}}
        }
      ],
      "requester": "{{STRING}}"
    }
  }
}

Header Parameters

Payload Parameters

ConnectByProfileSucceeded

This event informs AVS that a client established a connection with a paired Bluetooth device using the profile provided in the ConnectByProfile directive. Send ConnectByProfileSucceeded after the connection succeeds.

Sample Message

{
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "ConnectByProfileSucceeded",
      "messageId": "{{STRING}}"
    },
    "payload": {
      "device": {
        "uniqueDeviceId": "{{STRING}}",
      },
      "profileName": "{{STRING}}",
      "requester": "{{STRING}}"
    }
  }
}

Header Parameters

Payload Parameters

ConnectByProfileFailed

This event informs AVS that a client failed to establish a connection with a paired Bluetooth device using the profile provided in the ConnectByProfile directive. Send ConnectByProfileFailed after the failure occurs.

Sample Message

{
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "ConnectByProfileFailed",
      "messageId": "{{STRING}}"
    },
    "payload": {
      "requester": "{{STRING}}",
      "profileName": "{{STRING}}",
      "errorCode": {{LONG}}
    }
  }
}

Header Parameters

Payload Parameters

DisconnectDevicesSucceeded

This event informs AVS that a client disconnected from a paired Bluetooth device, after receiving a DisconnectDevices directive. Send DisconnectDevicesSucceeded after the disconnection succeeds.

Sample Message

{
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "DisconnectDevicesSucceeded",
      "messageId": "{{STRING}}"
    },
    "payload": {
      "devices": [
        {
          "uniqueDeviceId": "{{STRING}}",
          "friendlyName": "{{STRING}}"
        }
      ],
      "requester": "{{STRING}}"
    }
  }
}

Header Parameters

Payload Parameters

DisconnectDevicesFailed

This event informs AVS that a client failed to disconnect from a paired Bluetooth device, after receiving a DisconnectDevice directive. Send DisconnectDevicesFailed after the disconnection fails.

Sample Message

{
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "DisconnectDevicesFailed",
      "messageId": "{{STRING}}"
    },
    "payload": {
      "devices": [
        {
          "uniqueDeviceId": "{{STRING}}",
          "friendlyName": "{{STRING}}",
          "errorCode": {{LONG}}
        }
      ],
      "requester": "{{STRING}}"
    }
  }
}

Header Parameters

Payload Parameters

StreamingStarted

This event informs AVS that the Bluetooth streaming state of a connected device has started. Send StreamingStarted when the following state changes occur:

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

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

Payload Parameters

StreamingEnded

This event informs AVS that the Bluetooth streaming state of a connected device has stopped. Send the StreamingEnded event when the Bluetooth state changes from ACTIVE to PAUSED.

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

MediaControlPlaySucceeded

This event informs AVS that a connected Bluetooth device started audio playback. Send the MediaControlPlaySucceeded event after the A2DP source handles the Play directive.

Sample Message

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

Header Parameters

Payload Parameters

MediaControlPlayFailed

This event informs AVS that a connected Bluetooth device failed to start audio playback. Send the MediaControlPlayFailed event after the A2DP source fails to handles the Play directive.

Sample Message

{
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "MediaControlPlayFailed",
      "messageId": "{{STRING}}"
    },
    "payload": {
      "device": {
        "uniqueDeviceId": "{{STRING}}"
      },
      "errorCode": {{LONG}}
    }
  }
}

Header Parameters

Payload Parameters

MediaControlStopSucceeded

This event informs AVS that the A2DP source successfully handled the Stop directive.

Sample Message

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

Header Parameters

Payload Parameters

MediaControlStopFailed

This event informs AVS that the Stop directive failed to stop Media Playback on the A2DP source.

Sample Message

{
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "MediaControlStopFailed",
      "messageId": "{{STRING}}"
    },
    "payload": {
      "device": {
        "uniqueDeviceId": "{{STRING}}"
      },
      "errorCode": {{LONG}}
    }
  }
}

Header Parameters

Payload Parameters

MediaControlNextSucceeded

This event informs AVS that the A2DP source successfully handled the Next directive. Send the MediaControlNextSucceeded event after the success occurs.

Sample Message

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

Header Parameters

Payload Parameters

MediaControlNextFailed

This event informs AVS that the A2DP source failed to handle the Next directive. Send the MediaControlNextFailed event after the failure occurs.

Sample Message

{
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "MediaControlNextFailed",
      "messageId": "{{STRING}}"
    },
    "payload": {
      "device": {
        "uniqueDeviceId": "{{STRING}}"
      },
      "errorCode": {{LONG}}
    }
  }
}

Header Parameters

Payload Parameters

MediaControlPreviousSucceeded

This event informs AVS that the A2DP source processed the previous directive. Send the MediaControlPreviousSucceeded event after the success occurs.

Sample Message

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

Header Parameters

Payload Parameters

MediaControlPreviousFailed

This event informs AVS if the A2DP source fails to handle the Previous directive.

Sample Message

{
  "event": {
    "header": {
      "namespace": "Bluetooth",
      "name": "MediaControlPreviousFailed",
      "messageId": "{{STRING}}"
    },
    "payload": {
      "device": {
        "uniqueDeviceId": "{{STRING}}"
      },
      "errorCode": {{LONG}}
    }
  }
}

Header Parameters

Payload Parameters