alexaClientSDK::capabilityAgents::bluetooth::BasicDeviceConnectionRule Class Reference

#include <BasicDeviceConnectionRule.h>

Inheritance diagram for alexaClientSDK::capabilityAgents::bluetooth::BasicDeviceConnectionRule:

Collaboration diagram for alexaClientSDK::capabilityAgents::bluetooth::BasicDeviceConnectionRule:

Public Member Functions
BluetoothDeviceConnectionRuleInterface
bool	shouldExplicitlyConnect () override
bool	shouldExplicitlyDisconnect () override
std::set< std::shared_ptr< BluetoothDeviceInterface > >	devicesToDisconnect (std::map< DeviceCategory, std::set< std::shared_ptr< BluetoothDeviceInterface >>> connectedDevices) override
std::set< DeviceCategory >	getDeviceCategories () override
std::set< std::string >	getDependentProfiles () override
Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::BluetoothDeviceConnectionRuleInterface
virtual	~BluetoothDeviceConnectionRuleInterface ()=default

Static Public Member Functions
static std::shared_ptr< BasicDeviceConnectionRule >	create ()

Detailed Description

A class represents the basic connection rule the following Bluetooth device needs to follow: 1) DeviceCategory::PHONE 2) DeviceCategory::AUDIO_VIDEO 3) DeviceCategory::OTHER 4) DeviceCategory::UNKNOWN

This rule is created by default and enforces Bluetooth devices falling into the above DeviceCategory to follow. Any rule change for a certain DeviceCategory in the above list might need to refactor the Bluetooth CapabilityAgent.

Member Function Documentation

create()

std::shared_ptr< BasicDeviceConnectionRule > alexaClientSDK::capabilityAgents::bluetooth::BasicDeviceConnectionRule::create ( )

static

A factory method to create a new instance of BasicDeviceConnectionRule.

Returns

an instance of BasicConnectionRule.

devicesToDisconnect()

std::set< std::shared_ptr< BluetoothDeviceInterface > > alexaClientSDK::capabilityAgents::bluetooth::BasicDeviceConnectionRule::devicesToDisconnect ( std::map< DeviceCategory, std::set< std::shared_ptr< BluetoothDeviceInterface >>>  connectedDevices )

overridevirtual

The rule to get a set of Bluetooth devices needed to disconnect when the Bluetooth device connects.

Parameters

connectedDevices

the current connected devices.

Returns

the set of Bluetooth devices needed to disconnect.

Bluetooth CapabilityAgent only supports single A2DP device connected at one time. Need to disconnect the connected A2DP device(if available) whenever a new A2DP connects.

Implements alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::BluetoothDeviceConnectionRuleInterface.

getDependentProfiles()

std::set< std::string > alexaClientSDK::capabilityAgents::bluetooth::BasicDeviceConnectionRule::getDependentProfiles ( )

overridevirtual

Get the set of profile uuids which support those device categories defined in the connection rule.

Returns

The set of profile uuids.

Implements alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::BluetoothDeviceConnectionRuleInterface.

getDeviceCategories()

std::set< DeviceCategory > alexaClientSDK::capabilityAgents::bluetooth::BasicDeviceConnectionRule::getDeviceCategories ( )

overridevirtual

Get the set of device categories using the connection rule.

Returns

The set of DeviceCategory of the connection rule.

Implements alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::BluetoothDeviceConnectionRuleInterface.

shouldExplicitlyConnect()

bool alexaClientSDK::capabilityAgents::bluetooth::BasicDeviceConnectionRule::shouldExplicitlyConnect ( )

overridevirtual

The rule to explicitly connect the Bluetooth device after pair.

Returns

true if the caller needs to handle connect logic.

Implements alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::BluetoothDeviceConnectionRuleInterface.

shouldExplicitlyDisconnect()

bool alexaClientSDK::capabilityAgents::bluetooth::BasicDeviceConnectionRule::shouldExplicitlyDisconnect ( )

overridevirtual

The rule to explicitly disconnect the Bluetooth device before unpair.

Returns

true if the caller needs to handle disconnect logic.

Implements alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::BluetoothDeviceConnectionRuleInterface.

---

The documentation for this class was generated from the following files:

• /home/ANT.AMAZON.COM/womw/workplace/1.19_release/doxy/avs-device-sdk/CapabilityAgents/Bluetooth/include/Bluetooth/BasicDeviceConnectionRule.h
• /home/ANT.AMAZON.COM/womw/workplace/1.19_release/doxy/avs-device-sdk/CapabilityAgents/Bluetooth/src/BasicDeviceConnectionRule.cpp