BluezQt 5.109.0
Classes | Public Types | Signals | Public Member Functions | List of all members
BluezQt::MediaEndpoint

Bluetooth MediaEndpoint. More...

Classes

struct  Configuration
 Configuration for MediaEndpoint construction. More...
 

Public Types

enum class  Codec { Sbc , Aac }
 Codec which this MediaEndpoint supports. More...
 
enum class  Role { AudioSource , AudioSink }
 Role which this MediaEndpoint acts as. More...
 

Signals

void configurationCleared (const QString &transportObjectPath)
 Indicates that configuration was cleared for transport.
 
void configurationSelected (const QByteArray &capabilities, const QByteArray &configuration)
 Indicates that configuration was selected.
 
void configurationSet (const QString &transportObjectPath, const QVariantMap &properties)
 Indicates that configuration was set for transport.
 

Public Member Functions

 MediaEndpoint (const Configuration &configuration, QObject *parent=nullptr)
 Creates a new MediaEndpoint object.
 
 ~MediaEndpoint () override
 Destroys a MediaEndpoint object.
 
virtual void clearConfiguration (const QString &transportObjectPath)
 Clear transport configuration.
 
virtual QDBusObjectPath objectPath () const
 D-Bus object path of the MediaEndpoint.
 
virtual const QVariantMap & properties () const
 Properties of the endpoint.
 
virtual void release ()
 Indicates that the MediaEndpoint was unregistered.
 
virtual void selectConfiguration (const QByteArray &capabilities, const Request< QByteArray > &request)
 Select preferable configuration from the supported capabilities.
 
virtual void setConfiguration (const QString &transportObjectPath, const QVariantMap &properties)
 Set configuration for the transport.
 

Detailed Description

Bluetooth MediaEndpoint.

This class represents a Bluetooth MediaEndpoint.

Member Enumeration Documentation

◆ Codec

enum class BluezQt::MediaEndpoint::Codec
strong

Codec which this MediaEndpoint supports.

◆ Role

enum class BluezQt::MediaEndpoint::Role
strong

Role which this MediaEndpoint acts as.

Constructor & Destructor Documentation

◆ MediaEndpoint()

BluezQt::MediaEndpoint::MediaEndpoint ( const Configuration configuration,
QObject *  parent = nullptr 
)
explicit

Creates a new MediaEndpoint object.

Parameters
parent

◆ ~MediaEndpoint()

BluezQt::MediaEndpoint::~MediaEndpoint ( )
override

Destroys a MediaEndpoint object.

Member Function Documentation

◆ clearConfiguration()

virtual void BluezQt::MediaEndpoint::clearConfiguration ( const QString &  transportObjectPath)
virtual

Clear transport configuration.

◆ configurationCleared

void BluezQt::MediaEndpoint::configurationCleared ( const QString &  transportObjectPath)
signal

Indicates that configuration was cleared for transport.

◆ configurationSelected

void BluezQt::MediaEndpoint::configurationSelected ( const QByteArray &  capabilities,
const QByteArray &  configuration 
)
signal

Indicates that configuration was selected.

◆ configurationSet

void BluezQt::MediaEndpoint::configurationSet ( const QString &  transportObjectPath,
const QVariantMap &  properties 
)
signal

Indicates that configuration was set for transport.

◆ objectPath()

virtual QDBusObjectPath BluezQt::MediaEndpoint::objectPath ( ) const
virtual

D-Bus object path of the MediaEndpoint.

The path where the MediaEndpoint will be registered.

Note
You must provide valid object path!
Returns
object path of MediaEndpoint

◆ properties()

virtual const QVariantMap & BluezQt::MediaEndpoint::properties ( ) const
virtual

Properties of the endpoint.

Returns
Properties of the endpoint

◆ release()

virtual void BluezQt::MediaEndpoint::release ( )
virtual

Indicates that the MediaEndpoint was unregistered.

This method gets called when the Bluetooth daemon unregisters the MediaEndpoint.

An MediaEndpoint can use it to do cleanup tasks. There is no need to unregister the MediaEndpoint, because when this method gets called it has already been unregistered.

◆ selectConfiguration()

virtual void BluezQt::MediaEndpoint::selectConfiguration ( const QByteArray &  capabilities,
const Request< QByteArray > &  request 
)
virtual

Select preferable configuration from the supported capabilities.

Note
There is no need to cache the selected configuration since on success the configuration is send back as parameter of SetConfiguration.
Parameters
capabilitiessupported capabilities
requestrequest to be used for sending reply

◆ setConfiguration()

virtual void BluezQt::MediaEndpoint::setConfiguration ( const QString &  transportObjectPath,
const QVariantMap &  properties 
)
virtual

Set configuration for the transport.

Parameters
transporttransport to be configured
propertiesproperties to be set for transport