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

#include <MPRISPlayer.h>

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

Public Member Functions

virtual ~MPRISPlayer ()
 Destructor. More...
 
- Public Member Functions inherited from alexaClientSDK::bluetoothImplementations::blueZ::DBusObject< MPRISPlayer >
virtual ~DBusObject ()=default
 
- Public Member Functions inherited from alexaClientSDK::bluetoothImplementations::blueZ::DBusObjectBase
virtual ~DBusObjectBase ()
 
bool registerWithDBus ()
 
void unregisterObject ()
 

Static Public Member Functions

static std::unique_ptr< MPRISPlayercreate (std::shared_ptr< DBusConnection > connection, std::shared_ptr< DBusProxy > media, std::shared_ptr< avsCommon::utils::bluetooth::BluetoothEventBus > eventBus, const std::string &playerPath=MPRIS_OBJECT_PATH)
 

Static Public Attributes

static const std::string MPRIS_OBJECT_PATH
 The default MPRIS object path for players. More...
 

Additional Inherited Members

- Public Types inherited from alexaClientSDK::bluetoothImplementations::blueZ::DBusObject< MPRISPlayer >
using commandHandler_t = void(MPRISPlayer ::*)(GVariant *parameters, GDBusMethodInvocation *invocation)
 
- Protected Member Functions inherited from alexaClientSDK::bluetoothImplementations::blueZ::DBusObject< MPRISPlayer >
 DBusObject (std::shared_ptr< DBusConnection > connection, std::string xmlInterfaceIntrospection, std::string objectPath, std::unordered_map< std::string, commandHandler_t > methodMap)
 
- Protected Member Functions inherited from alexaClientSDK::bluetoothImplementations::blueZ::DBusObjectBase
 DBusObjectBase (std::shared_ptr< DBusConnection > connection, const std::string &xmlInterfaceIntrospection, const std::string &objectPath, GDBusInterfaceMethodCallFunc methodCallFunc)
 
void onMethodCalledInternal (const char *methodName)
 

Constructor & Destructor Documentation

◆ ~MPRISPlayer()

virtual alexaClientSDK::bluetoothImplementations::blueZ::MPRISPlayer::~MPRISPlayer ( )
virtual

Destructor.

Member Function Documentation

◆ create()

static std::unique_ptr<MPRISPlayer> alexaClientSDK::bluetoothImplementations::blueZ::MPRISPlayer::create ( std::shared_ptr< DBusConnection connection,
std::shared_ptr< DBusProxy media,
std::shared_ptr< avsCommon::utils::bluetooth::BluetoothEventBus eventBus,
const std::string &  playerPath = MPRIS_OBJECT_PATH 
)
static

Creates an instance of the MPRISPlayer.

Parameters
connectionA DBusConnection object.
mediaThe org.bluez.Media1 object.
eventBusThe eventbus to notify of the AVRCPCommand.
playerPathThe object path to create the player at. This is defaulted to the path specified by MPRIS, but BlueZ will accept other paths as well.
Returns
An instance of the MPRISPlayer if successful, else a nullptr.

Member Data Documentation

◆ MPRIS_OBJECT_PATH

const std::string alexaClientSDK::bluetoothImplementations::blueZ::MPRISPlayer::MPRIS_OBJECT_PATH
static

The default MPRIS object path for players.


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