org.bluez.MediaEndpoint - BlueZ D-Bus MediaEndpoint API documentation

Service unique name (Server role) org.bluez (Client role) Interface org.bluez.MediaEndpoint1 Objectpath freely definable (Server role) [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX/sepX (Client role) MethodsvoidSetConfiguration(objecttransport,dictproperties) Set configuration for the transport. objecttransport Configured transport object. dictproperties 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[ISOonly] See Metadata property. dictQoS[ISOonly] 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. dictSelectProperties(dictcapabilities) Select BAP unicast configuration from the supported capabilities: objectEndpointarray{byte}Capabilitiesarray{byte}Metadatauint32Locationsuint32_tChannelAllocationdictQoSbyteFramingbytePHYuint16MaximumLatencyuint32MinimumDelayuint32MaximumDelayuint32PreferredMinimumDelayuint32PreferredMaximumDelay See MediaEndpoint Properties for their possible values. Returns a configuration which can be used to setup a transport: array{byte}Capabilitiesarray{byte}Metadata[optional]dictQoS 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. voidClearConfiguration(objecttransport) Clear transport configuration. Serverrole: [ISO only] Close the stream associated with the given transport. If the path given is the path of this endpoint, all its streams are closed. voidReconfigure(dictproperties) [ISO only] Reconfigure a BAP unicast endpoint. This closes all existing streams of the endpoint, and restarts the configuration selection flow which e.g. triggers calls to SelectProperties allowing the sound server to modify the configuration. The following arguments are taken in properties: booleanDefer[optional] If True, mark endpoint for reconfiguration, but postpone it until a non-deferred Reconfigure() operation is made on an endpoint of the same device. This is necessary to use when reconfiguring source and sink streams with the intention that they be combined into the same CIG, possibly forming bidirectional CIS. voidRelease() 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. MediaEndpointPropertiesstringUUID[readonly,optional] UUID of the profile which the endpoint is for. byteCodec[readonly,optional] Assigned number of codec that the endpoint implements. The values should match the profile specification which is indicated by the UUID. uint32_tVendor[readonly,Optional] Vendor-specific Company ID, Codec ID tuple that the endpoint implements. It shall be set to appropriate value when Vendor Specific Codec (0xff) is used. array{byte}Capabilities[readonly,optional] Capabilities blob, it is used as it is so the size and byte order must match. array{byte}Metadata[readonly,Optional] Metadata blob, it is used as it is so the size and byte order must match. objectDevice[readonly,optional] Device object which the endpoint is belongs to. boolDelayReporting[readonly,optional] Indicates if endpoint supports Delay Reporting. uint32Locations[readonly,optional,ISOonly,experimental] Indicates endpoint supported locations. uint16SupportedContext[readonly,optional,ISOonly,experimental] Indicates endpoint supported audio context. uint16Context[readonly,optional,ISOonly,experimental] Indicates endpoint available audio context. dictQoS[readonly,optional,ISOonly,experimental] Indicates QoS capabilities. byteFraming Indicates endpoint support framing. Possible Values: 0x00 Unframed PDUs supported. 0x01 Unframed PDUs not supported. bytePHY Indicates endpoint preferred PHY. Possible values: bit0 LE 1M preferred. bit1 LE 2M preferred. bit2 LE Coded preferred. byteRetransmissions Indicates endpoint preferred number of retransmissions. uint16MaximumLatency Indicates endpoint maximum latency. uint32MinimumDelay Indicates endpoint minimum presentation delay. uint32MaximumDelay Indicates endpoint maximum presentation delay. uint32PreferredMinimumDelay Indicates endpoint preferred minimum presentation delay. uint32PreferredMaximumDelay Indicates endpoint preferred maximum presentation delay. BlueZ September 2023 ORG.BLUEZ.MEDIAENDPOINT(5)

org.bluez.MediaEndpoint - BlueZ D-Bus MediaEndpoint API documentation