alexaClientSDK::avsCommon::sdkInterfaces::bluetooth Namespace Reference

Namespaces
	services
	test

Classes
class	BluetoothDeviceConnectionRuleInterface
class	BluetoothDeviceInterface
	Represents a Bluetooth Device. More...
class	BluetoothDeviceManagerInterface
class	BluetoothHostControllerInterface

Enumerations
enum	DeviceState {   DeviceState::FOUND, DeviceState::UNPAIRED, DeviceState::PAIRED, DeviceState::IDLE,   DeviceState::DISCONNECTED, DeviceState::CONNECTED }

Functions
std::string	deviceStateToString (DeviceState state)
std::ostream &	operator<< (std::ostream &stream, const DeviceState state)

Enumeration Type Documentation

DeviceState

enum alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::DeviceState

strong

clang-format off Represents the state of the device. The state diagram is as follows:

+---—UNPAIRED----------—+ | | +---—UNPAIRED—+ | V | | FOUND -> PAIRED -> IDLE -> CONNECTED ^ | +DISCONNECTED-+ clang-format on

Enumerator
FOUND
UNPAIRED
PAIRED
IDLE
DISCONNECTED
CONNECTED

Function Documentation

deviceStateToString()

std::string alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::deviceStateToString ( DeviceState  state )

inline

Converts the DeviceState enum to a string.

Parameters

The	DeviceState to convert.

Returns

A string representation of the DeviceState.

operator<<()

std::ostream& alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::operator<< ( std::ostream &  stream, const DeviceState  state  )

inline

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

Parameters

An	ostream to send the DeviceState as a string.
The	DeviceState to convert.

Returns

The stream.