Namespaces
	test

Classes
class	BasicDeviceConnectionRule

class	Bluetooth

class	BluetoothEventState

class	BluetoothMediaInputTransformer

class	BluetoothStorageInterface
	A storage interface used for Bluetooth that should provide UUID to MAC mappings and maintain insertion order. More...

class	SQLiteBluetoothStorage
	A concrete implementation of `BluetoothStorageInterface` using SQLite. More...

Typedefs
using	MediaPlayerState = avsCommon::utils::mediaPlayer::MediaPlayerState

Functions
std::string	streamingStateToString (Bluetooth::StreamingState state)

std::ostream &	operator<< (std::ostream &stream, const Bluetooth::StreamingState state)

std::string	focusTransitionStateToString (Bluetooth::FocusTransitionState state)

std::ostream &	operator<< (std::ostream &stream, const Bluetooth::FocusTransitionState state)

std::string	scanningStateToString (Bluetooth::ScanningTransitionState state)

std::ostream &	operator<< (std::ostream &stream, const Bluetooth::ScanningTransitionState state)

static std::shared_ptr< avsCommon::avs::CapabilityConfiguration >	getBluetoothCapabilityConfiguration ()

static std::string	truncateWithDefault (const std::string &mac, const std::string &defaultString="XX:XX:XX:XX:XX:XX")

static std::string	truncateFriendlyName (const std::string &friendlyName)

static bool	supportsAvsProfile (std::shared_ptr< BluetoothDeviceInterface > device, const std::string &avsProfileName)

static bool	waitOnFuture (std::future< bool > future, std::string description="", std::chrono::milliseconds timeout=DEFAULT_FUTURE_TIMEOUT)

static std::string	convertToAVSStreamingState (const Bluetooth::StreamingState &state)

static bool	validateDeviceConnectionRules (std::unordered_set< std::shared_ptr< avsCommon::sdkInterfaces::bluetooth::BluetoothDeviceConnectionRuleInterface >> enabledConnectionRules)

static std::string	convertToAVSConnectedState (const DeviceState &state)

static bool	parseDirectivePayload (const std::string &payload, Document *document)

Variables
static const std::string	TAG {"Bluetooth"}
	String to identify log entries originating from this file. More...

static const std::string	NAMESPACE = "Bluetooth"
	The Bluetooth interface namespace. More...

static const NamespaceAndName	BLUETOOTH_STATE {NAMESPACE, "BluetoothState"}
	The Bluetooth state portion of the Context. More...

static const NamespaceAndName	SCAN_DEVICES {NAMESPACE, "ScanDevices"}
	The `ScanDevices` directive identifier. More...

static const NamespaceAndName	SCAN_DEVICES_REPORT {NAMESPACE, "ScanDevicesReport"}
	The `ScanDevicesReport` event. More...

static const NamespaceAndName	SCAN_DEVICES_FAILED {NAMESPACE, "ScanDevicesFailed"}
	The `ScanDevicesFailed` event. More...

static const NamespaceAndName	ENTER_DISCOVERABLE_MODE {NAMESPACE, "EnterDiscoverableMode"}
	The `EnterDiscoverableMode` directive identifier. More...

static const NamespaceAndName	ENTER_DISCOVERABLE_MODE_SUCCEEDED {NAMESPACE, "EnterDiscoverableModeSucceeded"}
	The `EnterDiscoverableModeSucceeded` event. More...

static const NamespaceAndName	ENTER_DISCOVERABLE_MODE_FAILED {NAMESPACE, "EnterDiscoverableModeFailed"}
	The `EnterDiscoverableModeFailed` event. More...

static const NamespaceAndName	EXIT_DISCOVERABLE_MODE {NAMESPACE, "ExitDiscoverableMode"}
	The `ExitDiscoverableMode` directive identifier. More...

static const NamespaceAndName	PAIR_DEVICES_SUCCEEDED {NAMESPACE, "PairDevicesSucceeded"}
	The `PairDevicesSucceeded` event. More...

static const NamespaceAndName	PAIR_DEVICES_FAILED {NAMESPACE, "PairDevicesFailed"}
	The `PairDevicesFailed` event. More...

static const NamespaceAndName	PAIR_DEVICES {NAMESPACE, "PairDevices"}
	The `PairDevices` directive identifier. More...

static const NamespaceAndName	UNPAIR_DEVICES {NAMESPACE, "UnpairDevices"}
	The `UnpairDevices` directive identifier. More...

static const NamespaceAndName	UNPAIR_DEVICES_SUCCEEDED {NAMESPACE, "UnpairDevicesSucceeded"}
	The `UnpairDevicesSucceeded` event. More...

static const NamespaceAndName	UNPAIR_DEVICES_FAILED {NAMESPACE, "UnpairDevicesFailed"}
	The `UnpairDevicesFailed` event. More...

static const NamespaceAndName	SET_DEVICE_CATEGORIES {NAMESPACE, "SetDeviceCategories"}
	The `SetDeviceCategories` directive identifier. More...

static const NamespaceAndName	SET_DEVICE_CATEGORIES_SUCCEEDED {NAMESPACE, "SetDeviceCategoriesSucceeded"}
	The `SetDeviceCategoriesSucceeded` event. More...

static const NamespaceAndName	SET_DEVICE_CATEGORIES_FAILED {NAMESPACE, "SetDeviceCategoriesFailed"}
	The `SetDeviceCategoriesFailed` event. More...

static const NamespaceAndName	CONNECT_BY_DEVICE_IDS {NAMESPACE, "ConnectByDeviceIds"}
	The `ConnectByDeviceIds` directive identifier. More...

static const NamespaceAndName	CONNECT_BY_DEVICE_IDS_SUCCEEDED {NAMESPACE, "ConnectByDeviceIdsSucceeded"}
	The `ConnectByDeviceIdsSucceeded` event. More...

static const NamespaceAndName	CONNECT_BY_DEVICE_IDS_FAILED {NAMESPACE, "ConnectByDeviceIdsFailed"}
	The `ConnectByDeviceIdsFailed` event. More...

static const NamespaceAndName	CONNECT_BY_PROFILE {NAMESPACE, "ConnectByProfile"}
	The `ConnectByProfile` directive identifier. More...

static const NamespaceAndName	CONNECT_BY_PROFILE_SUCCEEDED {NAMESPACE, "ConnectByProfileSucceeded"}
	The `ConnectByProfileSucceeded` event. More...

static const NamespaceAndName	CONNECT_BY_PROFILE_FAILED {NAMESPACE, "ConnectByProfileFailed"}
	The `ConnectByProfileFailed` event. More...

static const NamespaceAndName	DISCONNECT_DEVICES {NAMESPACE, "DisconnectDevices"}
	The `DisconnectDevices` directive identifier. More...

static const NamespaceAndName	DISCONNECT_DEVICES_SUCCEEDED {NAMESPACE, "DisconnectDevicesSucceeded"}
	The `DisconnectDevicesSucceeded` event. More...

static const NamespaceAndName	DISCONNECT_DEVICES_FAILED {NAMESPACE, "DisconnectDevicesFailed"}
	The `DisconnectDevicesFailed` event. More...

static const NamespaceAndName	PLAY {NAMESPACE, "Play"}
	The `Play` directive identifier. More...

static const NamespaceAndName	MEDIA_CONTROL_PLAY_SUCCEEDED {NAMESPACE, "MediaControlPlaySucceeded"}
	The `MediaControlPlaySucceeded` event. More...

static const NamespaceAndName	MEDIA_CONTROL_PLAY_FAILED {NAMESPACE, "MediaControlPlayFailed"}
	The `MediaControlPlayFailed` event. More...

static const NamespaceAndName	STOP {NAMESPACE, "Stop"}
	The `Stop` directive identifier. More...

static const NamespaceAndName	MEDIA_CONTROL_STOP_SUCCEEDED {NAMESPACE, "MediaControlStopSucceeded"}
	The `MediaControlStopSucceeded` event. More...

static const NamespaceAndName	MEDIA_CONTROL_STOP_FAILED {NAMESPACE, "MediaControlStopFailed"}
	The `MediaControlStopFailed` event. More...

static const NamespaceAndName	NEXT {NAMESPACE, "Next"}
	The `Next` directive identifier. More...

static const NamespaceAndName	MEDIA_CONTROL_NEXT_SUCCEEDED {NAMESPACE, "MediaControlNextSucceeded"}
	The `MediaControlNextSucceeded` event. More...

static const NamespaceAndName	MEDIA_CONTROL_NEXT_FAILED {NAMESPACE, "MediaControlNextFailed"}
	The `MediaControlNextFailed` event. More...

static const NamespaceAndName	PREVIOUS {NAMESPACE, "Previous"}
	The `Previous` directive identifier. More...

static const NamespaceAndName	MEDIA_CONTROL_PREVIOUS_SUCCEEDED {NAMESPACE, "MediaControlPreviousSucceeded"}
	The `MediaControlPreviousSucceeded` event. More...

static const NamespaceAndName	MEDIA_CONTROL_PREVIOUS_FAILED {NAMESPACE, "MediaControlPreviousFailed"}
	The `MediaControlPreviousFailed` event. More...

static const NamespaceAndName	STREAMING_STARTED {NAMESPACE, "StreamingStarted"}
	The `StreamingStarted` event. More...

static const NamespaceAndName	STREAMING_ENDED {NAMESPACE, "StreamingEnded"}
	The `StreamingEnded` event. More...

static const std::string	CHANNEL_NAME = FocusManagerInterface::CONTENT_CHANNEL_NAME
	The `Channel` name. More...

static const std::string	ACTIVITY_ID = "Bluetooth"
	Activity ID for use by FocusManager. More...

static const unsigned int	MAX_CONNECT_BY_PROFILE_COUNT = 2
	Max number of paired devices connect by profile should atempt connect to. More...

static const std::chrono::milliseconds	CMD_DELAY {100}
	A delay to deal with devices that can't process consecutive AVRCP commands. More...

static const std::chrono::milliseconds	INITIALIZE_SOURCE_DELAY {1000}

static const std::chrono::seconds	DEFAULT_FUTURE_TIMEOUT {45}

static const std::chrono::minutes	TRANSIENT_FOCUS_DURATION {2}

static const char	ALEXA_DEVICE_NAME_KEY [] = "alexaDevice"
	A key for the alexa (host) device. More...

static const char	DEVICE_KEY [] = "device"
	A key for a device. More...

static const char	DEVICES_KEY [] = "devices"
	A key for a devices. More...

static const char	DISCOVERED_DEVICES_KEY [] = "discoveredDevices"
	A key for discovered devices. More...

static const char	HAS_MORE_KEY [] = "hasMore"
	A key to indicate if more devices are to be reported. More...

static const std::string	EMPTY_PAYLOAD = "{}"
	An empty payload. More...

static const char	FRIENDLY_NAME_KEY [] = "friendlyName"
	The friendly name. More...

static const char	NAME_KEY [] = "name"
	The name key for a profile. More...

static const char	VERSION_KEY [] = "version"
	The version key for a profile. More...

static const char	PAIRED_DEVICES_KEY [] = "pairedDevices"
	Identifying paired devices. More...

static const char	PROFILE_KEY [] = "profile"
	Identifying a profile. More...

static const char	PROFILES_KEY [] = "profiles"
	Identifying an array of profiles. More...

static const char	PROFILE_NAME_KEY [] = "profileName"
	Identifying a profile name. More...

static const char	REQUESTER_KEY [] = "requester"
	Identifying the requester of the operation. More...

static const char	STREAMING_KEY [] = "streaming"
	A key indicating streaming status. More...

static const char	STATE_KEY [] = "state"
	A key indicating state. More...

static const char	SUPPORTED_PROFILES_KEY [] = "supportedProfiles"
	Indicates the supported profiles. More...

static const char	TRUNCATED_MAC_ADDRESS_KEY [] = "truncatedMacAddress"
	The truncated mac address. More...

static const char	UNIQUE_DEVICE_ID_KEY [] = "uniqueDeviceId"
	The uuid generated to identify a device. More...

static const char	METADATA_KEY [] = "metadata"
	The metadata. More...

static const char	VENDOR_ID_KEY [] = "vendorId"
	The Vendor Id. More...

static const char	PRODUCT_ID_KEY [] = "productId"
	The Product Id. More...

static const char	CLASS_OF_DEVICE_KEY [] = "classOfDevice"
	The Class of Device. More...

static const char	VENDOR_DEVICE_SIG_ID_KEY [] = "vendorDeviceSigId"
	The Vendor Device SigID. More...

static const char	VENDOR_DEVICE_ID_KEY [] = "vendorDeviceId"
	The Vendor Device ID. More...

static const char	DEVICE_CATEGORY_KEY [] = "deviceCategory"
	Identifying a device category. More...

static const char	CONNECTION_STATE_KEY [] = "connectionState"
	Identifying the connection status of a device. More...

static const std::string	AVS_A2DP_SOURCE = "A2DP-SOURCE"
	A2DP Source. More...

static const std::string	AVS_A2DP_SINK = "A2DP-SINK"
	A2DP Sink. More...

static const std::string	AVS_A2DP = "A2DP"
	General A2DP. More...

static const std::string	AVS_AVRCP = "AVRCP"

static const std::string	AVS_HFP = "HFP"
	HFP. More...

static const std::string	AVS_HID = "HID"
	HID. More...

static const std::string	AVS_SPP = "SPP"
	SPP. More...

static const std::map< std::string, std::string >	AVS_PROFILE_MAP
	A mapping of Bluetooth service UUIDs to AVS profile identifiers. More...

static const std::map< DeviceCategory, std::unordered_set< std::string > >	DEVICECATEGORY_PROFILES_MAP

static const std::string	BLUETOOTH_CAPABILITY_INTERFACE_TYPE = "AlexaInterface"

static const std::string	BLUETOOTH_CAPABILITY_INTERFACE_NAME = "Bluetooth"
	Bluetooth interface name. More...

static const std::string	BLUETOOTH_CAPABILITY_INTERFACE_VERSION = "2.0"
	Bluetooth interface version. Version 1.0 works with StreamingStarted and StreamingEnded. More...

static const std::string	BLUETOOTH_CAPABILITY_CONFIGURATION_VALUE
	Bluetooth configurations value. More...

static const std::string	TAG {"BluetoothMediaInputTransformer"}
	String to identify log entries originating from this file. More...

static const std::string	BLUETOOTH_CONFIGURATION_ROOT_KEY = "bluetooth"
	Configuration root. More...

static const std::string	BLUETOOTH_DB_FILE_PATH_KEY = "databaseFilePath"
	The node identifying the database. More...

static const std::string	UUID_TABLE_NAME = "uuidMapping"
	Table name. More...

static const std::string	COLUMN_UUID = "uuid"
	The UUID column. More...

static const std::string	COLUMN_MAC = "mac"
	The MAC address column. More...

static const std::string	COLUMN_CATEGORY = "category"
	The Category column. More...

Typedef Documentation

◆ MediaPlayerState

using alexaClientSDK::capabilityAgents::bluetooth::MediaPlayerState = typedef avsCommon::utils::mediaPlayer::MediaPlayerState

Function Documentation

◆ convertToAVSConnectedState()

static std::string alexaClientSDK::capabilityAgents::bluetooth::convertToAVSConnectedState ( const DeviceState & state )

static

Utility function to squash DeviceState into the connection state that AVS has defined.

Parameters

state The DeviceState

Returns: A string representing the connection state.

◆ convertToAVSStreamingState()

static std::string alexaClientSDK::capabilityAgents::bluetooth::convertToAVSStreamingState ( const Bluetooth::StreamingState & state )

static

Utility function to squash StreamingState into the streaming states that AVS has defined.

Parameters

state The StreamingState.

Returns: A string representing the streaming state.

◆ focusTransitionStateToString()

std::string alexaClientSDK::capabilityAgents::bluetooth::focusTransitionStateToString ( Bluetooth::FocusTransitionState state )

inline

Converts an enum FocusTransitionState to a string.

Parameters

state The FocusTransitionState.

Returns: The string form of the enum.

◆ getBluetoothCapabilityConfiguration()

static std::shared_ptr<avsCommon::avs::CapabilityConfiguration> alexaClientSDK::capabilityAgents::bluetooth::getBluetoothCapabilityConfiguration ( )

static

Creates the Bluetooth capability configuration.

Returns: The Bluetooth capability configuration.

◆ operator<<() [1/3]

std::ostream& alexaClientSDK::capabilityAgents::bluetooth::operator<<	(	std::ostream &	stream,
		const Bluetooth::StreamingState	state
	)

inline

Overload for the StreamingState enum. This will write the StreamingState as a string to the provided stream.

Parameters

stream	An ostream to send the `StreamingState` as a string.
state	The `StreamingState` to convert.

Returns: The stream.

◆ operator<<() [2/3]

std::ostream& alexaClientSDK::capabilityAgents::bluetooth::operator<<	(	std::ostream &	stream,
		const Bluetooth::FocusTransitionState	state
	)

inline

Overload for the FocusTransitionState enum. This will write the FocusTransitionState as a string to the provided stream.

Parameters

stream	An ostream to send the `FocusTransitionState` as a string.
state	The `FocusTransitionState` to convert.

Returns: The stream.

◆ operator<<() [3/3]

std::ostream& alexaClientSDK::capabilityAgents::bluetooth::operator<<	(	std::ostream &	stream,
		const Bluetooth::ScanningTransitionState	state
	)

inline

Overload for the ScanningTransitionState enum. This will write the ScanningTransitionState as a string to the provided stream.

Parameters

stream	An ostream to send the `ScanningTransitionState` as a string.
state	The `ScanningTransitionState` to convert.

Returns: The stream.

◆ parseDirectivePayload()

static bool alexaClientSDK::capabilityAgents::bluetooth::parseDirectivePayload	(	const std::string &	payload,
		Document *	document
	)

static

◆ scanningStateToString()

std::string alexaClientSDK::capabilityAgents::bluetooth::scanningStateToString ( Bluetooth::ScanningTransitionState state )

inline

Converts an enum ScanningTransitionState to a string.

Parameters

state The ScanningTransitionState.

Returns: The string form of the enum.

◆ streamingStateToString()

std::string alexaClientSDK::capabilityAgents::bluetooth::streamingStateToString ( Bluetooth::StreamingState state )

inline

Converts an enum to a string.

Parameters

state The StreamingState.

Returns: The string form of the enum.

◆ supportsAvsProfile()

static bool alexaClientSDK::capabilityAgents::bluetooth::supportsAvsProfile	(	std::shared_ptr< BluetoothDeviceInterface >	device,
		const std::string &	avsProfileName
	)

static

Utility function to evaluate whether a device supports a specific AVS profile.

Parameters

device	The device.
avsProfileName	The AVS Profile to match against.
A	bool indicating whether the device supports the specific profile.

Returns: A bool indicating success.

◆ truncateFriendlyName()

static std::string alexaClientSDK::capabilityAgents::bluetooth::truncateFriendlyName ( const std::string & friendlyName )

static

Utility function to truncate a Bluetooth device friendly name.

Parameters

friendlyName The Bluetooth device friendly name.

Returns: The truncated friendly name.

◆ truncateWithDefault()

static std::string alexaClientSDK::capabilityAgents::bluetooth::truncateWithDefault	(	const std::string &	mac,
		const std::string &	defaultString = `"XX:XX:XX:XX:XX:XX"`
	)

static

Utility function to truncate a MAC address.

Parameters

mac	The mac address.
defaultString	The default truncated mac address to return if the mac address is invalid.

Returns: The truncated mac address.

◆ validateDeviceConnectionRules()

static bool alexaClientSDK::capabilityAgents::bluetooth::validateDeviceConnectionRules ( std::unordered_set< std::shared_ptr< avsCommon::sdkInterfaces::bluetooth::BluetoothDeviceConnectionRuleInterface >> enabledConnectionRules )

static

Utility function to evaluate whether connection rules are valid. Device categories defined in the BasicDeviceConnectionRule are enabled by the Bluetoooth CapabilityAgent by default and are not allowed to be overwritten.

Parameters

enabledConnectionRules a set of device connection rules defined by customers.

Returns: A bool indicating success.

◆ waitOnFuture()

static bool alexaClientSDK::capabilityAgents::bluetooth::waitOnFuture	(	std::future< bool >	future,
		std::string	description = `""`,
		std::chrono::milliseconds	timeout = `DEFAULT_FUTURE_TIMEOUT`
	)

static

Wait for a a future function to be resolved.

Parameters

future	The future
description	The desription of the future function.
timeout	The timeout given to the future.

Returns: A bool indicating the future success.

Variable Documentation

◆ ACTIVITY_ID

const std::string alexaClientSDK::capabilityAgents::bluetooth::ACTIVITY_ID = "Bluetooth"

static

Activity ID for use by FocusManager.

◆ ALEXA_DEVICE_NAME_KEY

const char alexaClientSDK::capabilityAgents::bluetooth::ALEXA_DEVICE_NAME_KEY[] = "alexaDevice"

static

A key for the alexa (host) device.

◆ AVS_A2DP

const std::string alexaClientSDK::capabilityAgents::bluetooth::AVS_A2DP = "A2DP"

static

General A2DP.

◆ AVS_A2DP_SINK

const std::string alexaClientSDK::capabilityAgents::bluetooth::AVS_A2DP_SINK = "A2DP-SINK"

static

A2DP Sink.

◆ AVS_A2DP_SOURCE

const std::string alexaClientSDK::capabilityAgents::bluetooth::AVS_A2DP_SOURCE = "A2DP-SOURCE"

static

A2DP Source.

◆ AVS_AVRCP

const std::string alexaClientSDK::capabilityAgents::bluetooth::AVS_AVRCP = "AVRCP"

static

AVS identifies this as just AVRCP. It technically refers to AVRCPTarget, since the presence of this profile will dictate whether AVS will send down Media control directives.

◆ AVS_HFP

const std::string alexaClientSDK::capabilityAgents::bluetooth::AVS_HFP = "HFP"

static

HFP.

◆ AVS_HID

const std::string alexaClientSDK::capabilityAgents::bluetooth::AVS_HID = "HID"

static

HID.

◆ AVS_PROFILE_MAP

const std::map<std::string, std::string> alexaClientSDK::capabilityAgents::bluetooth::AVS_PROFILE_MAP

static

Initial value:

{
    {std::string(A2DPSourceInterface::UUID), AVS_A2DP_SOURCE},
    {std::string(A2DPSinkInterface::UUID), AVS_A2DP_SINK},
    {std::string(AVRCPTargetInterface::UUID), AVS_AVRCP},
    {std::string(HFPInterface::UUID), AVS_HFP},
    {std::string(HIDInterface::UUID), AVS_HID},
    {std::string(SPPInterface::UUID), AVS_SPP}}

A mapping of Bluetooth service UUIDs to AVS profile identifiers.

◆ AVS_SPP

const std::string alexaClientSDK::capabilityAgents::bluetooth::AVS_SPP = "SPP"

static

SPP.

◆ BLUETOOTH_CAPABILITY_CONFIGURATION_VALUE

const std::string alexaClientSDK::capabilityAgents::bluetooth::BLUETOOTH_CAPABILITY_CONFIGURATION_VALUE

static

Initial value:

= R"(
{
    "profiles": [
        "AVRCP",
        "A2DP_SINK",
        "A2DP_SOURCE"
    ]
}
)"

Bluetooth configurations value.

◆ BLUETOOTH_CAPABILITY_INTERFACE_NAME

const std::string alexaClientSDK::capabilityAgents::bluetooth::BLUETOOTH_CAPABILITY_INTERFACE_NAME = "Bluetooth"

static

Bluetooth interface name.

◆ BLUETOOTH_CAPABILITY_INTERFACE_TYPE

const std::string alexaClientSDK::capabilityAgents::bluetooth::BLUETOOTH_CAPABILITY_INTERFACE_TYPE = "AlexaInterface"

static

Bluetooth capability constants Bluetooth interface type

◆ BLUETOOTH_CAPABILITY_INTERFACE_VERSION

const std::string alexaClientSDK::capabilityAgents::bluetooth::BLUETOOTH_CAPABILITY_INTERFACE_VERSION = "2.0"

static

Bluetooth interface version. Version 1.0 works with StreamingStarted and StreamingEnded.

◆ BLUETOOTH_CONFIGURATION_ROOT_KEY

const std::string alexaClientSDK::capabilityAgents::bluetooth::BLUETOOTH_CONFIGURATION_ROOT_KEY = "bluetooth"

static

Configuration root.

◆ BLUETOOTH_DB_FILE_PATH_KEY

const std::string alexaClientSDK::capabilityAgents::bluetooth::BLUETOOTH_DB_FILE_PATH_KEY = "databaseFilePath"

static

The node identifying the database.

◆ BLUETOOTH_STATE

const NamespaceAndName alexaClientSDK::capabilityAgents::bluetooth::BLUETOOTH_STATE {NAMESPACE, "BluetoothState"}

static

The Bluetooth state portion of the Context.

◆ CHANNEL_NAME

const std::string alexaClientSDK::capabilityAgents::bluetooth::CHANNEL_NAME = FocusManagerInterface::CONTENT_CHANNEL_NAME

static

The Channel name.

◆ CLASS_OF_DEVICE_KEY

const char alexaClientSDK::capabilityAgents::bluetooth::CLASS_OF_DEVICE_KEY[] = "classOfDevice"

static

The Class of Device.

◆ CMD_DELAY

const std::chrono::milliseconds alexaClientSDK::capabilityAgents::bluetooth::CMD_DELAY {100}

static

A delay to deal with devices that can't process consecutive AVRCP commands.

◆ COLUMN_CATEGORY

const std::string alexaClientSDK::capabilityAgents::bluetooth::COLUMN_CATEGORY = "category"

static

The Category column.

◆ COLUMN_MAC

const std::string alexaClientSDK::capabilityAgents::bluetooth::COLUMN_MAC = "mac"

static

The MAC address column.

◆ COLUMN_UUID

const std::string alexaClientSDK::capabilityAgents::bluetooth::COLUMN_UUID = "uuid"

static

The UUID column.

◆ CONNECT_BY_DEVICE_IDS

const NamespaceAndName alexaClientSDK::capabilityAgents::bluetooth::CONNECT_BY_DEVICE_IDS {NAMESPACE, "ConnectByDeviceIds"}

static

The ConnectByDeviceIds directive identifier.

◆ CONNECT_BY_DEVICE_IDS_FAILED

const NamespaceAndName alexaClientSDK::capabilityAgents::bluetooth::CONNECT_BY_DEVICE_IDS_FAILED {NAMESPACE, "ConnectByDeviceIdsFailed"}

static

The ConnectByDeviceIdsFailed event.

◆ CONNECT_BY_DEVICE_IDS_SUCCEEDED

const NamespaceAndName alexaClientSDK::capabilityAgents::bluetooth::CONNECT_BY_DEVICE_IDS_SUCCEEDED {NAMESPACE, "ConnectByDeviceIdsSucceeded"}

static

The ConnectByDeviceIdsSucceeded event.

◆ CONNECT_BY_PROFILE

const NamespaceAndName alexaClientSDK::capabilityAgents::bluetooth::CONNECT_BY_PROFILE {NAMESPACE, "ConnectByProfile"}

static

The ConnectByProfile directive identifier.

◆ CONNECT_BY_PROFILE_FAILED

const NamespaceAndName alexaClientSDK::capabilityAgents::bluetooth::CONNECT_BY_PROFILE_FAILED {NAMESPACE, "ConnectByProfileFailed"}

static

The ConnectByProfileFailed event.

◆ CONNECT_BY_PROFILE_SUCCEEDED

const NamespaceAndName alexaClientSDK::capabilityAgents::bluetooth::CONNECT_BY_PROFILE_SUCCEEDED {NAMESPACE, "ConnectByProfileSucceeded"}

static

The ConnectByProfileSucceeded event.

◆ CONNECTION_STATE_KEY

const char alexaClientSDK::capabilityAgents::bluetooth::CONNECTION_STATE_KEY[] = "connectionState"

static

Identifying the connection status of a device.

◆ DEFAULT_FUTURE_TIMEOUT

const std::chrono::seconds alexaClientSDK::capabilityAgents::bluetooth::DEFAULT_FUTURE_TIMEOUT {45}

static

The maximum about of time to block on a future from the Bluetooth implementation before it should be rejected.

◆ DEVICE_CATEGORY_KEY

const char alexaClientSDK::capabilityAgents::bluetooth::DEVICE_CATEGORY_KEY[] = "deviceCategory"

static

Identifying a device category.

◆ DEVICE_KEY

const char alexaClientSDK::capabilityAgents::bluetooth::DEVICE_KEY[] = "device"

static

A key for a device.

◆ DEVICECATEGORY_PROFILES_MAP

const std::map<DeviceCategory, std::unordered_set<std::string> > alexaClientSDK::capabilityAgents::bluetooth::DEVICECATEGORY_PROFILES_MAP

static

Initial value:

{
    {DeviceCategory::REMOTE_CONTROL, {std::string(SPPInterface::UUID), std::string(HIDInterface::UUID)}},
    {DeviceCategory::GADGET, {std::string(SPPInterface::UUID), std::string(HIDInterface::UUID)}}}

A mapping of DeviceCategory to its dependent service UUIDs. List all necessary profiles needed for a device with the following DeviceCategory: 1)DeviceCategory::REMOTE_CONTROL 2)DeviceCategory::GADGET All other categories are already enforced to have correct dependent profiles by BasicDeviceConnectionRule.

◆ DEVICES_KEY

const char alexaClientSDK::capabilityAgents::bluetooth::DEVICES_KEY[] = "devices"

static

A key for a devices.

◆ DISCONNECT_DEVICES

const NamespaceAndName alexaClientSDK::capabilityAgents::bluetooth::DISCONNECT_DEVICES {NAMESPACE, "DisconnectDevices"}

static

The DisconnectDevices directive identifier.

◆ DISCONNECT_DEVICES_FAILED

const NamespaceAndName alexaClientSDK::capabilityAgents::bluetooth::DISCONNECT_DEVICES_FAILED {NAMESPACE, "DisconnectDevicesFailed"}

static

The DisconnectDevicesFailed event.

◆ DISCONNECT_DEVICES_SUCCEEDED

const NamespaceAndName alexaClientSDK::capabilityAgents::bluetooth::DISCONNECT_DEVICES_SUCCEEDED {NAMESPACE, "DisconnectDevicesSucceeded"}

static

The DisconnectDevicesSucceeded event.

◆ DISCOVERED_DEVICES_KEY

const char alexaClientSDK::capabilityAgents::bluetooth::DISCOVERED_DEVICES_KEY[] = "discoveredDevices"

static

A key for discovered devices.

◆ EMPTY_PAYLOAD

const std::string alexaClientSDK::capabilityAgents::bluetooth::EMPTY_PAYLOAD = "{}"

static

An empty payload.

◆ ENTER_DISCOVERABLE_MODE

const NamespaceAndName alexaClientSDK::capabilityAgents::bluetooth::ENTER_DISCOVERABLE_MODE {NAMESPACE, "EnterDiscoverableMode"}

static

The EnterDiscoverableMode directive identifier.

◆ ENTER_DISCOVERABLE_MODE_FAILED

const NamespaceAndName alexaClientSDK::capabilityAgents::bluetooth::ENTER_DISCOVERABLE_MODE_FAILED {NAMESPACE, "EnterDiscoverableModeFailed"}

static

The EnterDiscoverableModeFailed event.

◆ ENTER_DISCOVERABLE_MODE_SUCCEEDED

const NamespaceAndName alexaClientSDK::capabilityAgents::bluetooth::ENTER_DISCOVERABLE_MODE_SUCCEEDED {NAMESPACE, "EnterDiscoverableModeSucceeded"}

static

The EnterDiscoverableModeSucceeded event.

◆ EXIT_DISCOVERABLE_MODE

const NamespaceAndName alexaClientSDK::capabilityAgents::bluetooth::EXIT_DISCOVERABLE_MODE {NAMESPACE, "ExitDiscoverableMode"}

static

The ExitDiscoverableMode directive identifier.

◆ FRIENDLY_NAME_KEY

const char alexaClientSDK::capabilityAgents::bluetooth::FRIENDLY_NAME_KEY[] = "friendlyName"

static

The friendly name.

◆ HAS_MORE_KEY

const char alexaClientSDK::capabilityAgents::bluetooth::HAS_MORE_KEY[] = "hasMore"

static

A key to indicate if more devices are to be reported.

◆ INITIALIZE_SOURCE_DELAY

const std::chrono::milliseconds alexaClientSDK::capabilityAgents::bluetooth::INITIALIZE_SOURCE_DELAY {1000}

static

We get the stream faster than a peer device can process an AVRCP command (for example NEXT/PAUSE). Wait a bit before we get the stream so we don't get any buffers from before the command was processed.

◆ MAX_CONNECT_BY_PROFILE_COUNT

const unsigned int alexaClientSDK::capabilityAgents::bluetooth::MAX_CONNECT_BY_PROFILE_COUNT = 2

static

Max number of paired devices connect by profile should atempt connect to.

◆ MEDIA_CONTROL_NEXT_FAILED

const NamespaceAndName alexaClientSDK::capabilityAgents::bluetooth::MEDIA_CONTROL_NEXT_FAILED {NAMESPACE, "MediaControlNextFailed"}

static

The MediaControlNextFailed event.

◆ MEDIA_CONTROL_NEXT_SUCCEEDED

const NamespaceAndName alexaClientSDK::capabilityAgents::bluetooth::MEDIA_CONTROL_NEXT_SUCCEEDED {NAMESPACE, "MediaControlNextSucceeded"}

static

The MediaControlNextSucceeded event.

◆ MEDIA_CONTROL_PLAY_FAILED

const NamespaceAndName alexaClientSDK::capabilityAgents::bluetooth::MEDIA_CONTROL_PLAY_FAILED {NAMESPACE, "MediaControlPlayFailed"}

static

The MediaControlPlayFailed event.

◆ MEDIA_CONTROL_PLAY_SUCCEEDED

const NamespaceAndName alexaClientSDK::capabilityAgents::bluetooth::MEDIA_CONTROL_PLAY_SUCCEEDED {NAMESPACE, "MediaControlPlaySucceeded"}

static

The MediaControlPlaySucceeded event.

◆ MEDIA_CONTROL_PREVIOUS_FAILED

const NamespaceAndName alexaClientSDK::capabilityAgents::bluetooth::MEDIA_CONTROL_PREVIOUS_FAILED {NAMESPACE, "MediaControlPreviousFailed"}

static

The MediaControlPreviousFailed event.

◆ MEDIA_CONTROL_PREVIOUS_SUCCEEDED

const NamespaceAndName alexaClientSDK::capabilityAgents::bluetooth::MEDIA_CONTROL_PREVIOUS_SUCCEEDED {NAMESPACE, "MediaControlPreviousSucceeded"}

static

The MediaControlPreviousSucceeded event.

◆ MEDIA_CONTROL_STOP_FAILED

const NamespaceAndName alexaClientSDK::capabilityAgents::bluetooth::MEDIA_CONTROL_STOP_FAILED {NAMESPACE, "MediaControlStopFailed"}

static

The MediaControlStopFailed event.

◆ MEDIA_CONTROL_STOP_SUCCEEDED

const NamespaceAndName alexaClientSDK::capabilityAgents::bluetooth::MEDIA_CONTROL_STOP_SUCCEEDED {NAMESPACE, "MediaControlStopSucceeded"}

static

The MediaControlStopSucceeded event.

◆ METADATA_KEY

const char alexaClientSDK::capabilityAgents::bluetooth::METADATA_KEY[] = "metadata"

static

The metadata.

◆ NAME_KEY

const char alexaClientSDK::capabilityAgents::bluetooth::NAME_KEY[] = "name"

static

The name key for a profile.

◆ NAMESPACE

const std::string alexaClientSDK::capabilityAgents::bluetooth::NAMESPACE = "Bluetooth"

static

The Bluetooth interface namespace.

◆ NEXT

const NamespaceAndName alexaClientSDK::capabilityAgents::bluetooth::NEXT {NAMESPACE, "Next"}

static

The Next directive identifier.

◆ PAIR_DEVICES

const NamespaceAndName alexaClientSDK::capabilityAgents::bluetooth::PAIR_DEVICES {NAMESPACE, "PairDevices"}

static

The PairDevices directive identifier.

◆ PAIR_DEVICES_FAILED

const NamespaceAndName alexaClientSDK::capabilityAgents::bluetooth::PAIR_DEVICES_FAILED {NAMESPACE, "PairDevicesFailed"}

static

The PairDevicesFailed event.

◆ PAIR_DEVICES_SUCCEEDED

const NamespaceAndName alexaClientSDK::capabilityAgents::bluetooth::PAIR_DEVICES_SUCCEEDED {NAMESPACE, "PairDevicesSucceeded"}

static

The PairDevicesSucceeded event.

◆ PAIRED_DEVICES_KEY

const char alexaClientSDK::capabilityAgents::bluetooth::PAIRED_DEVICES_KEY[] = "pairedDevices"

static

Identifying paired devices.

◆ PLAY

const NamespaceAndName alexaClientSDK::capabilityAgents::bluetooth::PLAY {NAMESPACE, "Play"}

static

The Play directive identifier.

◆ PREVIOUS

const NamespaceAndName alexaClientSDK::capabilityAgents::bluetooth::PREVIOUS {NAMESPACE, "Previous"}

static

The Previous directive identifier.

◆ PRODUCT_ID_KEY

const char alexaClientSDK::capabilityAgents::bluetooth::PRODUCT_ID_KEY[] = "productId"

static

The Product Id.

◆ PROFILE_KEY

const char alexaClientSDK::capabilityAgents::bluetooth::PROFILE_KEY[] = "profile"

static

Identifying a profile.

◆ PROFILE_NAME_KEY

const char alexaClientSDK::capabilityAgents::bluetooth::PROFILE_NAME_KEY[] = "profileName"

static

Identifying a profile name.

◆ PROFILES_KEY

const char alexaClientSDK::capabilityAgents::bluetooth::PROFILES_KEY[] = "profiles"

static

Identifying an array of profiles.

◆ REQUESTER_KEY

const char alexaClientSDK::capabilityAgents::bluetooth::REQUESTER_KEY[] = "requester"

static

Identifying the requester of the operation.

◆ SCAN_DEVICES

const NamespaceAndName alexaClientSDK::capabilityAgents::bluetooth::SCAN_DEVICES {NAMESPACE, "ScanDevices"}

static

The ScanDevices directive identifier.

◆ SCAN_DEVICES_FAILED

const NamespaceAndName alexaClientSDK::capabilityAgents::bluetooth::SCAN_DEVICES_FAILED {NAMESPACE, "ScanDevicesFailed"}

static

The ScanDevicesFailed event.

◆ SCAN_DEVICES_REPORT

const NamespaceAndName alexaClientSDK::capabilityAgents::bluetooth::SCAN_DEVICES_REPORT {NAMESPACE, "ScanDevicesReport"}

static

The ScanDevicesReport event.

◆ SET_DEVICE_CATEGORIES

const NamespaceAndName alexaClientSDK::capabilityAgents::bluetooth::SET_DEVICE_CATEGORIES {NAMESPACE, "SetDeviceCategories"}

static

The SetDeviceCategories directive identifier.

◆ SET_DEVICE_CATEGORIES_FAILED

const NamespaceAndName alexaClientSDK::capabilityAgents::bluetooth::SET_DEVICE_CATEGORIES_FAILED {NAMESPACE, "SetDeviceCategoriesFailed"}

static

The SetDeviceCategoriesFailed event.

◆ SET_DEVICE_CATEGORIES_SUCCEEDED

const NamespaceAndName alexaClientSDK::capabilityAgents::bluetooth::SET_DEVICE_CATEGORIES_SUCCEEDED {NAMESPACE, "SetDeviceCategoriesSucceeded"}

static

The SetDeviceCategoriesSucceeded event.

◆ STATE_KEY

const char alexaClientSDK::capabilityAgents::bluetooth::STATE_KEY[] = "state"

static

A key indicating state.

◆ STOP

const NamespaceAndName alexaClientSDK::capabilityAgents::bluetooth::STOP {NAMESPACE, "Stop"}

static

The Stop directive identifier.

◆ STREAMING_ENDED

const NamespaceAndName alexaClientSDK::capabilityAgents::bluetooth::STREAMING_ENDED {NAMESPACE, "StreamingEnded"}

static

The StreamingEnded event.

◆ STREAMING_KEY

const char alexaClientSDK::capabilityAgents::bluetooth::STREAMING_KEY[] = "streaming"

static

A key indicating streaming status.

◆ STREAMING_STARTED

const NamespaceAndName alexaClientSDK::capabilityAgents::bluetooth::STREAMING_STARTED {NAMESPACE, "StreamingStarted"}

static

The StreamingStarted event.

◆ SUPPORTED_PROFILES_KEY

const char alexaClientSDK::capabilityAgents::bluetooth::SUPPORTED_PROFILES_KEY[] = "supportedProfiles"

static

Indicates the supported profiles.

◆ TAG [1/2]

const std::string alexaClientSDK::capabilityAgents::bluetooth::TAG {"BluetoothMediaInputTransformer"}

static

String to identify log entries originating from this file.

◆ TAG [2/2]

const std::string alexaClientSDK::capabilityAgents::bluetooth::TAG {"Bluetooth"}

static

String to identify log entries originating from this file.

◆ TRANSIENT_FOCUS_DURATION

const std::chrono::minutes alexaClientSDK::capabilityAgents::bluetooth::TRANSIENT_FOCUS_DURATION {2}

static

The amount of time that the Bluetooth CA can hold onto the foreground channel and keep another CA in the background. If the time that the Bluetooth CA is in the foreground exceeds this value then other CAs will completely lose focus. If the Bluetooth CA loses focus within that time frame then the other CA which had focus will regain it and resume normal operation.

◆ TRUNCATED_MAC_ADDRESS_KEY

const char alexaClientSDK::capabilityAgents::bluetooth::TRUNCATED_MAC_ADDRESS_KEY[] = "truncatedMacAddress"

static

The truncated mac address.

◆ UNIQUE_DEVICE_ID_KEY

const char alexaClientSDK::capabilityAgents::bluetooth::UNIQUE_DEVICE_ID_KEY[] = "uniqueDeviceId"

static

The uuid generated to identify a device.

◆ UNPAIR_DEVICES

const NamespaceAndName alexaClientSDK::capabilityAgents::bluetooth::UNPAIR_DEVICES {NAMESPACE, "UnpairDevices"}

static

The UnpairDevices directive identifier.

◆ UNPAIR_DEVICES_FAILED

const NamespaceAndName alexaClientSDK::capabilityAgents::bluetooth::UNPAIR_DEVICES_FAILED {NAMESPACE, "UnpairDevicesFailed"}

static

The UnpairDevicesFailed event.

◆ UNPAIR_DEVICES_SUCCEEDED

const NamespaceAndName alexaClientSDK::capabilityAgents::bluetooth::UNPAIR_DEVICES_SUCCEEDED {NAMESPACE, "UnpairDevicesSucceeded"}

static

The UnpairDevicesSucceeded event.

◆ UUID_TABLE_NAME

const std::string alexaClientSDK::capabilityAgents::bluetooth::UUID_TABLE_NAME = "uuidMapping"

static

Table name.

◆ VENDOR_DEVICE_ID_KEY

const char alexaClientSDK::capabilityAgents::bluetooth::VENDOR_DEVICE_ID_KEY[] = "vendorDeviceId"

static

The Vendor Device ID.

◆ VENDOR_DEVICE_SIG_ID_KEY

const char alexaClientSDK::capabilityAgents::bluetooth::VENDOR_DEVICE_SIG_ID_KEY[] = "vendorDeviceSigId"

static

The Vendor Device SigID.

◆ VENDOR_ID_KEY

const char alexaClientSDK::capabilityAgents::bluetooth::VENDOR_ID_KEY[] = "vendorId"

static

The Vendor Id.

◆ VERSION_KEY

const char alexaClientSDK::capabilityAgents::bluetooth::VERSION_KEY[] = "version"

static

The version key for a profile.

Namespaces

Classes

Typedefs

Functions

Variables

Typedef Documentation

◆ MediaPlayerState

Function Documentation

◆ convertToAVSConnectedState()

◆ convertToAVSStreamingState()

◆ focusTransitionStateToString()

◆ getBluetoothCapabilityConfiguration()

◆ operator<<() [1/3]

◆ operator<<() [2/3]

◆ operator<<() [3/3]

◆ parseDirectivePayload()

◆ scanningStateToString()

◆ streamingStateToString()

◆ supportsAvsProfile()

◆ truncateFriendlyName()

◆ truncateWithDefault()

◆ validateDeviceConnectionRules()

◆ waitOnFuture()

Variable Documentation

◆ ACTIVITY_ID

◆ ALEXA_DEVICE_NAME_KEY

◆ AVS_A2DP

◆ AVS_A2DP_SINK

◆ AVS_A2DP_SOURCE

◆ AVS_AVRCP

◆ AVS_HFP

◆ AVS_HID

◆ AVS_PROFILE_MAP

◆ AVS_SPP

◆ BLUETOOTH_CAPABILITY_CONFIGURATION_VALUE

◆ BLUETOOTH_CAPABILITY_INTERFACE_NAME

◆ BLUETOOTH_CAPABILITY_INTERFACE_TYPE

◆ BLUETOOTH_CAPABILITY_INTERFACE_VERSION

◆ BLUETOOTH_CONFIGURATION_ROOT_KEY

◆ BLUETOOTH_DB_FILE_PATH_KEY

◆ BLUETOOTH_STATE

◆ CHANNEL_NAME

◆ CLASS_OF_DEVICE_KEY

◆ CMD_DELAY

◆ COLUMN_CATEGORY

◆ COLUMN_MAC

◆ COLUMN_UUID

◆ CONNECT_BY_DEVICE_IDS

◆ CONNECT_BY_DEVICE_IDS_FAILED

◆ CONNECT_BY_DEVICE_IDS_SUCCEEDED

◆ CONNECT_BY_PROFILE

◆ CONNECT_BY_PROFILE_FAILED

◆ CONNECT_BY_PROFILE_SUCCEEDED

◆ CONNECTION_STATE_KEY

◆ DEFAULT_FUTURE_TIMEOUT

◆ DEVICE_CATEGORY_KEY

◆ DEVICE_KEY

◆ DEVICECATEGORY_PROFILES_MAP

◆ DEVICES_KEY

◆ DISCONNECT_DEVICES

◆ DISCONNECT_DEVICES_FAILED

◆ DISCONNECT_DEVICES_SUCCEEDED

◆ DISCOVERED_DEVICES_KEY

◆ EMPTY_PAYLOAD

◆ ENTER_DISCOVERABLE_MODE

◆ ENTER_DISCOVERABLE_MODE_FAILED

◆ ENTER_DISCOVERABLE_MODE_SUCCEEDED

◆ EXIT_DISCOVERABLE_MODE

◆ FRIENDLY_NAME_KEY

◆ HAS_MORE_KEY

◆ INITIALIZE_SOURCE_DELAY

◆ MAX_CONNECT_BY_PROFILE_COUNT

◆ MEDIA_CONTROL_NEXT_FAILED

◆ MEDIA_CONTROL_NEXT_SUCCEEDED

◆ MEDIA_CONTROL_PLAY_FAILED

◆ MEDIA_CONTROL_PLAY_SUCCEEDED

◆ MEDIA_CONTROL_PREVIOUS_FAILED

◆ MEDIA_CONTROL_PREVIOUS_SUCCEEDED

◆ MEDIA_CONTROL_STOP_FAILED

◆ MEDIA_CONTROL_STOP_SUCCEEDED