AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::acsdkBluetoothInterfaces::BluetoothLocalInterface Class Referenceabstract

#include <BluetoothLocalInterface.h>

Inheritance diagram for alexaClientSDK::acsdkBluetoothInterfaces::BluetoothLocalInterface:
Inheritance graph
[legend]

Public Member Functions

virtual ~BluetoothLocalInterface ()=default
 
virtual void setDiscoverableMode (bool discoverable)=0
 
virtual void setScanMode (bool scanning)=0
 
virtual void pair (const std::string &addr)=0
 
virtual void unpair (const std::string &addr)=0
 
virtual void connect (const std::string &addr)=0
 
virtual void disconnect (const std::string &addr)=0
 

Detailed Description

Interface to be implemented by class containing business logic for Bluetooth operations.

Constructor & Destructor Documentation

◆ ~BluetoothLocalInterface()

virtual alexaClientSDK::acsdkBluetoothInterfaces::BluetoothLocalInterface::~BluetoothLocalInterface ( )
virtualdefault

Destructor

Member Function Documentation

◆ connect()

virtual void alexaClientSDK::acsdkBluetoothInterfaces::BluetoothLocalInterface::connect ( const std::string &  addr)
pure virtual

Connect with the device matching the given MAC address.

Parameters
macThe MAC address associated with the device.

Implemented in alexaClientSDK::acsdkBluetooth::Bluetooth.

◆ disconnect()

virtual void alexaClientSDK::acsdkBluetoothInterfaces::BluetoothLocalInterface::disconnect ( const std::string &  addr)
pure virtual

Disconnect from the device matching the given MAC address.

Parameters
macThe MAC address associated with the device.

Implemented in alexaClientSDK::acsdkBluetooth::Bluetooth.

◆ pair()

virtual void alexaClientSDK::acsdkBluetoothInterfaces::BluetoothLocalInterface::pair ( const std::string &  addr)
pure virtual

Pair with the device matching the given MAC address.

Parameters
macThe MAC address associated with the device.

Implemented in alexaClientSDK::acsdkBluetooth::Bluetooth.

◆ setDiscoverableMode()

virtual void alexaClientSDK::acsdkBluetoothInterfaces::BluetoothLocalInterface::setDiscoverableMode ( bool  discoverable)
pure virtual

Puts the device into the desired discoverable mode.

Parameters
discoverableA bool indicating whether it should be discoverable.

Implemented in alexaClientSDK::acsdkBluetooth::Bluetooth.

◆ setScanMode()

virtual void alexaClientSDK::acsdkBluetoothInterfaces::BluetoothLocalInterface::setScanMode ( bool  scanning)
pure virtual

Puts the device into the desired scan mode.

Parameters
scanningA bool indicating whether it should be scanning.

Implemented in alexaClientSDK::acsdkBluetooth::Bluetooth.

◆ unpair()

virtual void alexaClientSDK::acsdkBluetoothInterfaces::BluetoothLocalInterface::unpair ( const std::string &  addr)
pure virtual

Unpair with the device matching the given MAC address.

Parameters
macThe MAC address associated with the device.

Implemented in alexaClientSDK::acsdkBluetooth::Bluetooth.


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

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