org.bluez.MediaEndpoint - Man Page

BlueZ D-Bus MediaEndpoint API documentation

Interface

Service: unique name (Server role) org.bluez (Client role)
Interface: org.bluez.MediaEndpoint1
Object path: freely definable (Server role) [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX/sepX (Client role)

void SetConfiguration(object transport, dict properties)

Set configuration for the transport.

object transport: Configured transport object.
dict properties: Configured org.bluez.MediaTransport(5) properties.

For client role transport must be set with a server endpoint object which will be configured and the properties must contain the following properties:

array{byte} Capabilities [Mandatory]: See Capabilities property.
array{byte} Metadata [ISO only]: See Metadata property.
dict QoS [ISO only]: See org.bluez.MediaTransport(5) QoS property.

array{byte} SelectConfiguration(array{byte} capabilities)

Select preferable configuration from the supported capabilities.

Returns a configuration which can be used to setup a transport, see org.bluez.MediaTransport(5) for possible values.

Note: There is no need to cache the selected configuration since on success the configuration is send back as parameter of SetConfiguration.

dict SelectProperties(dict capabilities)

Select BAP unicast configuration from the supported capabilities:

object Endpoint

array{byte} Capabilities

array{byte} Metadata

uint32 Locations

uint32_t ChannelAllocation

dict QoS

byte Framing

byte PHY

uint16 MaximumLatency

uint32 MinimumDelay

uint32 MaximumDelay

uint32 PreferredMinimumDelay

uint32 PreferredMaximumDelay

See MediaEndpoint Properties for their possible values.

Returns a configuration which can be used to setup a transport:

array{byte} Capabilities

array{byte} Metadata [optional]

dict QoS

See SetConfiguration for their possible values.

Note: There is no need to cache the selected properties since on success the configuration is send back as parameter of SetConfiguration.

void ClearConfiguration(object transport)

Clear transport configuration.

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