AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Namespaces | Classes | Typedefs | Functions | Variables
alexaClientSDK::acsdkBluetooth Namespace Reference

Namespaces

 test
 

Classes

class  BasicDeviceConnectionRule
 
class  BasicDeviceConnectionRulesProvider
 
class  Bluetooth
 
class  BluetoothEventState
 
class  BluetoothMediaInputTransformer
 
class  BluetoothNotifier
 
class  DeviceConnectionRulesAdapter
 
class  SQLiteBluetoothStorage
 A concrete implementation of BluetoothStorageInterface using SQLite. More...
 

Typedefs

using BluetoothComponent = acsdkManufactory::Component< std::shared_ptr< acsdkBluetoothInterfaces::BluetoothLocalInterface >, std::shared_ptr< acsdkBluetoothInterfaces::BluetoothNotifierInterface >, acsdkManufactory::Import< std::shared_ptr< acsdkApplicationAudioPipelineFactoryInterfaces::ApplicationAudioPipelineFactoryInterface > >, acsdkManufactory::Import< std::shared_ptr< acsdkBluetoothInterfaces::BluetoothDeviceConnectionRulesProviderInterface > >, acsdkManufactory::Import< std::shared_ptr< acsdkBluetoothInterfaces::BluetoothStorageInterface > >, acsdkManufactory::Import< std::shared_ptr< acsdkShutdownManagerInterfaces::ShutdownNotifierInterface > >, acsdkManufactory::Import< std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface > >, acsdkManufactory::Import< std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > >, acsdkManufactory::Import< acsdkManufactory::Annotated< avsCommon::sdkInterfaces::AudioFocusAnnotation, avsCommon::sdkInterfaces::FocusManagerInterface > >, acsdkManufactory::Import< std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > >, acsdkManufactory::Import< std::shared_ptr< avsCommon::sdkInterfaces::PlaybackRouterInterface > >, acsdkManufactory::Import< std::shared_ptr< avsCommon::sdkInterfaces::bluetooth::BluetoothDeviceManagerInterface > >, acsdkManufactory::Import< acsdkManufactory::Annotated< avsCommon::sdkInterfaces::endpoints::DefaultEndpointAnnotation, avsCommon::sdkInterfaces::endpoints::EndpointCapabilitiesRegistrarInterface > >, acsdkManufactory::Import< std::shared_ptr< avsCommon::utils::bluetooth::BluetoothEventBus > >, acsdkManufactory::Import< std::shared_ptr< registrationManager::CustomerDataManagerInterface > >>
 

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)
 
BluetoothComponent getComponent ()
 

Variables

static const constexpr char * BLUETOOTH_MEDIA_PLAYER_NAME = "BluetoothMediaPlayer"
 String to identify the Bluetooth media player to render audio. More...
 

Typedef Documentation

◆ BluetoothComponent

using alexaClientSDK::acsdkBluetooth::BluetoothComponent = typedef acsdkManufactory::Component< std::shared_ptr<acsdkBluetoothInterfaces::BluetoothLocalInterface>, std::shared_ptr<acsdkBluetoothInterfaces::BluetoothNotifierInterface>, acsdkManufactory::Import< std::shared_ptr<acsdkApplicationAudioPipelineFactoryInterfaces::ApplicationAudioPipelineFactoryInterface> >, acsdkManufactory::Import< std::shared_ptr<acsdkBluetoothInterfaces::BluetoothDeviceConnectionRulesProviderInterface> >, acsdkManufactory::Import<std::shared_ptr<acsdkBluetoothInterfaces::BluetoothStorageInterface> >, acsdkManufactory::Import<std::shared_ptr<acsdkShutdownManagerInterfaces::ShutdownNotifierInterface> >, acsdkManufactory::Import<std::shared_ptr<avsCommon::sdkInterfaces::ContextManagerInterface> >, acsdkManufactory::Import<std::shared_ptr<avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface> >, acsdkManufactory::Import<acsdkManufactory::Annotated< avsCommon::sdkInterfaces::AudioFocusAnnotation, avsCommon::sdkInterfaces::FocusManagerInterface> >, acsdkManufactory::Import<std::shared_ptr<avsCommon::sdkInterfaces::MessageSenderInterface> >, acsdkManufactory::Import<std::shared_ptr<avsCommon::sdkInterfaces::PlaybackRouterInterface> >, acsdkManufactory::Import<std::shared_ptr<avsCommon::sdkInterfaces::bluetooth::BluetoothDeviceManagerInterface> >, acsdkManufactory::Import<acsdkManufactory::Annotated< avsCommon::sdkInterfaces::endpoints::DefaultEndpointAnnotation, avsCommon::sdkInterfaces::endpoints::EndpointCapabilitiesRegistrarInterface> >, acsdkManufactory::Import<std::shared_ptr<avsCommon::utils::bluetooth::BluetoothEventBus> >, acsdkManufactory::Import<std::shared_ptr<registrationManager::CustomerDataManagerInterface> >>

Manufactory Component definition for the BluetoothNotifierInterface.

Function Documentation

◆ focusTransitionStateToString()

std::string alexaClientSDK::acsdkBluetooth::focusTransitionStateToString ( Bluetooth::FocusTransitionState  state)
inline

Converts an enum FocusTransitionState to a string.

Parameters
stateThe FocusTransitionState.
Returns
The string form of the enum.

◆ getComponent()

BluetoothComponent alexaClientSDK::acsdkBluetooth::getComponent ( )

Get the Manufactory component for creating an instance of BluetoothNotifierInterface.

Returns
The Manufactory component for creating an instance of BluetoothNotifierInterface.

◆ operator<<() [1/3]

std::ostream& alexaClientSDK::acsdkBluetooth::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
streamAn ostream to send the StreamingState as a string.
stateThe StreamingState to convert.
Returns
The stream.

◆ operator<<() [2/3]

std::ostream& alexaClientSDK::acsdkBluetooth::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
streamAn ostream to send the FocusTransitionState as a string.
stateThe FocusTransitionState to convert.
Returns
The stream.

◆ operator<<() [3/3]

std::ostream& alexaClientSDK::acsdkBluetooth::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
streamAn ostream to send the ScanningTransitionState as a string.
stateThe ScanningTransitionState to convert.
Returns
The stream.

◆ scanningStateToString()

std::string alexaClientSDK::acsdkBluetooth::scanningStateToString ( Bluetooth::ScanningTransitionState  state)
inline

Converts an enum ScanningTransitionState to a string.

Parameters
stateThe ScanningTransitionState.
Returns
The string form of the enum.

◆ streamingStateToString()

std::string alexaClientSDK::acsdkBluetooth::streamingStateToString ( Bluetooth::StreamingState  state)
inline

Converts an enum to a string.

Parameters
stateThe StreamingState.
Returns
The string form of the enum.

Variable Documentation

◆ BLUETOOTH_MEDIA_PLAYER_NAME

const constexpr char* alexaClientSDK::acsdkBluetooth::BLUETOOTH_MEDIA_PLAYER_NAME = "BluetoothMediaPlayer"
static

String to identify the Bluetooth media player to render audio.

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