AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Classes | Enumerations | Functions | Variables
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)
 
static const std::string TAG ("FormattedAudioStreamAdapter")
 String to identify log entries originating from this file. More...
 

Variables

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

Enumeration Type Documentation

◆ A2DPRole

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

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

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
TheA2DPRole 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
TheMediaStreamingState 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
Anostream to send the A2DPRole as a string.
TheA2DPRole 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
Anostream to send the MediaStreamingState as a string.
TheMediaStreamingState to convert.
Returns
The stream.

◆ TAG()

static const std::string alexaClientSDK::avsCommon::utils::bluetooth::TAG ( "FormattedAudioStreamAdapter"  )
static

String to identify log entries originating from this file.

Variable Documentation

◆ TAG

const std::string alexaClientSDK::avsCommon::utils::bluetooth::TAG {"BluetoothEventBus"}
static

String to identify log entries originating from this file.

AlexaClientSDK 1.26.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0