alexaClientSDK::avsCommon::utils::bluetooth Namespace Reference

Classes
class	A2DPSinkRecord
	A SDP record representing A2DPSink. More...
class	A2DPSourceRecord
	A SDP record representing A2DPSource. More...
class	AVRCPControllerRecord
	A SDP record representing AVRCPController. More...
class	AVRCPTargetRecord
	A SDP record representing AVRCPTarget. More...
class	BluetoothDeviceManagerInitializedEvent
class	BluetoothEvent
	Base class for a BluetoothEvent. More...
class	BluetoothEventBus
class	BluetoothEventListenerInterface
struct	BluetoothEventTypeHash
	Helper struct to allow enum class to be a key in collections. More...
class	DeviceDiscoveredEvent
class	DeviceRemovedEvent
class	DeviceStateChangedEvent
class	FormattedAudioStreamAdapter
class	FormattedAudioStreamAdapterListener
class	HFPRecord
	A SDP record representing HFP. More...
class	HIDRecord
	A SDP record representing HID. More...
class	MediaCommandReceivedEvent
class	MediaStreamingStateChangedEvent
class	ScanningStateChangedEvent
class	SDPRecord
	Base class for an SDPRecord object used. More...
class	SPPRecord
	A SDP record representing SPP. More...
class	ToggleA2DPProfileStateChangedEvent

Enumerations
enum	A2DPRole { A2DPRole::NONE, A2DPRole::SINK, A2DPRole::SOURCE }
	An Enum representing the current A2DP role. More...
enum	BluetoothEventType {   BluetoothEventType::DEVICE_DISCOVERED, BluetoothEventType::DEVICE_REMOVED, BluetoothEventType::DEVICE_STATE_CHANGED, BluetoothEventType::STREAMING_STATE_CHANGED,   BluetoothEventType::MEDIA_COMMAND_RECEIVED, BluetoothEventType::BLUETOOTH_DEVICE_MANAGER_INITIALIZED, BluetoothEventType::SCANNING_STATE_CHANGED, BluetoothEventType::TOGGLE_A2DP_PROFILE_STATE_CHANGED }
	The different Bluetooth event types. More...
enum	MediaStreamingState { MediaStreamingState::IDLE, MediaStreamingState::PENDING, MediaStreamingState::ACTIVE }
	An Enum representing the current state of the stream. More...

Functions
std::string	a2DPRoleToString (A2DPRole value)
std::ostream &	operator<< (std::ostream &stream, const A2DPRole a2DPRole)
std::string	mediaStreamingStateToString (MediaStreamingState value)
std::ostream &	operator<< (std::ostream &stream, const MediaStreamingState state)

Enumeration Type Documentation

A2DPRole

enum alexaClientSDK::avsCommon::utils::bluetooth::A2DPRole

strong

An Enum representing the current A2DP role.

Enumerator
NONE	Does not support A2DP.
SINK	AVS device acting as an A2DPSink.
SOURCE	AVS device acting as an A2DPSource.

BluetoothEventType

enum alexaClientSDK::avsCommon::utils::bluetooth::BluetoothEventType

strong

The different Bluetooth event types.

Enumerator
DEVICE_DISCOVERED	Represents when a device is discovered.
DEVICE_REMOVED	Represents when a device is removed.
DEVICE_STATE_CHANGED	Represents when the state of a device changes.
STREAMING_STATE_CHANGED	Represents when the A2DP streaming state changes.
MEDIA_COMMAND_RECEIVED	Represents when a media command has been received.
BLUETOOTH_DEVICE_MANAGER_INITIALIZED	When the BluetoothDeviceManager has initialized.
SCANNING_STATE_CHANGED	When the scanning state of the host has changed.
TOGGLE_A2DP_PROFILE_STATE_CHANGED	Request to connect/disconnect a certain profile.

MediaStreamingState

enum alexaClientSDK::avsCommon::utils::bluetooth::MediaStreamingState

strong

An Enum representing the current state of the stream.

Enumerator
IDLE	Currently not streaming.
PENDING	Currently acquiring the stream.
ACTIVE	Currently streaming.

Function Documentation

a2DPRoleToString()

std::string alexaClientSDK::avsCommon::utils::bluetooth::a2DPRoleToString ( A2DPRole  value )

inline

Converts the A2DPRole enum to a string.

Parameters

The	A2DPRole to convert.

Returns

A string representation of the A2DPRole.

mediaStreamingStateToString()

std::string alexaClientSDK::avsCommon::utils::bluetooth::mediaStreamingStateToString ( MediaStreamingState  value )

inline

Converts the MediaStreamingState enum to a string.

Parameters

The	MediaStreamingState to convert.

Returns

A string representation of the MediaStreamingState.

operator<<() [1/2]

std::ostream& alexaClientSDK::avsCommon::utils::bluetooth::operator<< ( std::ostream &  stream, const A2DPRole  a2DPRole  )

inline

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

Parameters

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

Returns

The stream.

operator<<() [2/2]

std::ostream& alexaClientSDK::avsCommon::utils::bluetooth::operator<< ( std::ostream &  stream, const MediaStreamingState  state  )

inline

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

Parameters

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

Returns

The stream.