AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | Static Public Member Functions | List of all members
alexaClientSDK::bluetoothImplementations::blueZ::BlueZDeviceManager Class Reference

#include <BlueZDeviceManager.h>

Inheritance diagram for alexaClientSDK::bluetoothImplementations::blueZ::BlueZDeviceManager:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::bluetoothImplementations::blueZ::BlueZDeviceManager:
Collaboration graph
[legend]

Public Member Functions

virtual ~BlueZDeviceManager () override
 
std::shared_ptr< MediaEndpointgetMediaEndpoint ()
 
std::string getAdapterPath () const
 
avsCommon::utils::bluetooth::MediaStreamingState getMediaStreamingState ()
 
BluetoothDeviceManagerInterface Functions
std::shared_ptr< avsCommon::sdkInterfaces::bluetooth::BluetoothHostControllerInterfacegetHostController () override
 
std::list< std::shared_ptr< avsCommon::sdkInterfaces::bluetooth::BluetoothDeviceInterface > > getDiscoveredDevices () override
 
std::shared_ptr< avsCommon::utils::bluetooth::BluetoothEventBusgetEventBus () override
 
void doShutdown () override
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::BluetoothDeviceManagerInterface
virtual ~BluetoothDeviceManagerInterface ()=default
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::utils::RequiresShutdown
 RequiresShutdown (const std::string &name)
 
virtual ~RequiresShutdown ()
 Destructor. More...
 
const std::string & name () const
 
void shutdown ()
 
bool isShutdown () const
 

Static Public Member Functions

static std::shared_ptr< BlueZDeviceManagercreate (std::shared_ptr< avsCommon::utils::bluetooth::BluetoothEventBus > eventBus)
 

Additional Inherited Members

Detailed Description

Internal BlueZ implementation of BluetoothDeviceManagerInterface.

Constructor & Destructor Documentation

◆ ~BlueZDeviceManager()

alexaClientSDK::bluetoothImplementations::blueZ::BlueZDeviceManager::~BlueZDeviceManager ( )
overridevirtual

Destructor.

Member Function Documentation

◆ create()

std::shared_ptr< BlueZDeviceManager > alexaClientSDK::bluetoothImplementations::blueZ::BlueZDeviceManager::create ( std::shared_ptr< avsCommon::utils::bluetooth::BluetoothEventBus eventBus)
static

Factory method to create a class.

Parameters
eventBusBluethoothEvent typed EventBus to be used for event routing.
Returns
A new instance of BlueZDeviceManager on success, nullptr otherwise.

◆ doShutdown()

void alexaClientSDK::bluetoothImplementations::blueZ::BlueZDeviceManager::doShutdown ( )
overridevirtual

Prepares/enables this object to be deleted. This should be the last function called on this object prior to deleting (or resetting) its shared_ptr.

Warning
  • Attempting to call functions on this object after calling shutdown() can result in undefined behavior.
  • Neglecting to call shutdown() on this object can result in resource leaks or other undefined behavior.

Implements alexaClientSDK::avsCommon::utils::RequiresShutdown.

◆ getAdapterPath()

std::string alexaClientSDK::bluetoothImplementations::blueZ::BlueZDeviceManager::getAdapterPath ( ) const

Get the DBus object path of the current bluetooth hardware adapter used by this device manager.

Returns
DBus object path of the current bluetooth hardware adapter used by this device manager.

◆ getDiscoveredDevices()

std::list< std::shared_ptr< avsCommon::sdkInterfaces::bluetooth::BluetoothDeviceInterface > > alexaClientSDK::bluetoothImplementations::blueZ::BlueZDeviceManager::getDiscoveredDevices ( )
overridevirtual

Get a list of devices the Host Controller is aware of. This list must contain:

i) Paired devices. ii) Devices found during the scanning process.

Implements alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::BluetoothDeviceManagerInterface.

◆ getEventBus()

std::shared_ptr< avsCommon::utils::bluetooth::BluetoothEventBus > alexaClientSDK::bluetoothImplementations::blueZ::BlueZDeviceManager::getEventBus ( )
overridevirtual

Get the BluetoothEventBus used by this device manager to post bluetooth related events.

Returns
A BluetoothEventBus object associated with the device manager.

Implements alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::BluetoothDeviceManagerInterface.

◆ getHostController()

std::shared_ptr< BluetoothHostControllerInterface > alexaClientSDK::bluetoothImplementations::blueZ::BlueZDeviceManager::getHostController ( )
overridevirtual

Get BluetoothHostControllerInterface instance

Returns
Pointer to a BluetoothHostControllerInterface instance

Implements alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::BluetoothDeviceManagerInterface.

◆ getMediaEndpoint()

std::shared_ptr< MediaEndpoint > alexaClientSDK::bluetoothImplementations::blueZ::BlueZDeviceManager::getMediaEndpoint ( )

Get the SINK MediaEndpoint associated with the device manager

Returns
MediaEndpoint instance

◆ getMediaStreamingState()

avsCommon::utils::bluetooth::MediaStreamingState alexaClientSDK::bluetoothImplementations::blueZ::BlueZDeviceManager::getMediaStreamingState ( )

Get the current media streaming state.

Returns
MediaStreamingState

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

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