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

A BlueZ implementation of the AVRCPTargetInterface. More...

#include <BlueZAVRCPTarget.h>

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

Public Member Functions

BluetoothServiceInterface methods
std::shared_ptr< avsCommon::sdkInterfaces::bluetooth::services::SDPRecordInterfacegetRecord () override
 
void setup () override
 Called for any necessary setup of the service. More...
 
void cleanup () override
 Called for any necessary cleanup of the service. More...
 
AVRCPTargetInterface methods
bool play () override
 
bool pause () override
 
bool next () override
 
bool previous () override
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::services::AVRCPTargetInterface
virtual ~AVRCPTargetInterface ()=default
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::services::BluetoothServiceInterface
virtual ~BluetoothServiceInterface ()=default
 Destructor. More...
 

Static Public Member Functions

static std::shared_ptr< BlueZAVRCPTargetcreate (std::shared_ptr< DBusProxy > mediaControlProxy)
 

Additional Inherited Members

- Static Public Attributes inherited from alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::services::AVRCPTargetInterface
static constexpr const char * UUID = "0000110c-0000-1000-8000-00805f9b34fb"
 The Service UUID. More...
 
static constexpr const char * NAME = "A/V_RemoteControlTarget"
 The Service Name. More...
 

Detailed Description

A BlueZ implementation of the AVRCPTargetInterface.

Member Function Documentation

◆ cleanup()

void alexaClientSDK::bluetoothImplementations::blueZ::BlueZAVRCPTarget::cleanup ( )
overridevirtual

Called for any necessary cleanup of the service.

Implements alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::services::BluetoothServiceInterface.

◆ create()

static std::shared_ptr<BlueZAVRCPTarget> alexaClientSDK::bluetoothImplementations::blueZ::BlueZAVRCPTarget::create ( std::shared_ptr< DBusProxy mediaControlProxy)
static

Creates a BlueZAVRCPTarget instance.

Parameters
deviceA pointer to an instance of a DBusProxy for an org.bluez.MediaControl1 interface.
Returns
An instance of AVRCPTarget if successful, else a nullptr.

◆ getRecord()

std::shared_ptr<avsCommon::sdkInterfaces::bluetooth::services::SDPRecordInterface> alexaClientSDK::bluetoothImplementations::blueZ::BlueZAVRCPTarget::getRecord ( )
overridevirtual

Returns an SDPRecord for the service.

Returns
A SDPRecordInterface for the service.

Implements alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::services::BluetoothServiceInterface.

◆ next()

bool alexaClientSDK::bluetoothImplementations::blueZ::BlueZAVRCPTarget::next ( )
overridevirtual

Sends a next command to the device supporting AVRCPTarget.

Returns
A boolean indicating the success of the function.

Implements alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::services::AVRCPTargetInterface.

◆ pause()

bool alexaClientSDK::bluetoothImplementations::blueZ::BlueZAVRCPTarget::pause ( )
overridevirtual

Sends a pause command to the device supporting AVRCPTarget.

Returns
A boolean indicating the success of the function.

Implements alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::services::AVRCPTargetInterface.

◆ play()

bool alexaClientSDK::bluetoothImplementations::blueZ::BlueZAVRCPTarget::play ( )
overridevirtual

Sends a play command to the device supporting AVRCPTarget.

Returns
A boolean indicating the success of the function.

Implements alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::services::AVRCPTargetInterface.

◆ previous()

bool alexaClientSDK::bluetoothImplementations::blueZ::BlueZAVRCPTarget::previous ( )
overridevirtual

Sends a previous command to the device supporting AVRCPTarget.

Returns
A boolean indicating the success of the function.

Implements alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::services::AVRCPTargetInterface.

◆ setup()

void alexaClientSDK::bluetoothImplementations::blueZ::BlueZAVRCPTarget::setup ( )
overridevirtual

Called for any necessary setup of the service.

Implements alexaClientSDK::avsCommon::sdkInterfaces::bluetooth::services::BluetoothServiceInterface.


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

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