org.bluez.Media - BlueZ D-Bus Media API documentation
Contents
Interface
Service
org.bluez
Interface
org.bluez.Media1
Objectpath
[variable prefix]/{hci0,hci1,...}
MethodsvoidRegisterEndpoint(objectendpoint,dictproperties)
Register a local end point to sender, the sender can register as many end points as it likes.
Note: If the sender disconnects the end points are automatically unregistered.
possible properties:
stringUUID
UUID of the profile which the endpoint is for.
UUID must be in the list of SupportedUUIDS.
byteCodec
Assigned number of codec that the endpoint implements. The values should match the profile
specification which is indicated by the UUID.
uint32_tVendor[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
Capabilities blob, it is used as it is so the size and byte order must match.
array{byte}Metadata[Optional]
Metadata blob, it is used as it is so the size and byte order must match.
Possible Errors:
org.bluez.Error.InvalidArgumentsorg.bluez.Error.NotSupported
emitted when interface for the end-point is disabled
voidUnregisterEndpoint(objectendpoint)
Unregister sender end point.
voidRegisterPlayer(objectplayer,dictproperties)
Register a media player object to sender, the sender can register as many objects as it likes.
Object must implement at least org.mpris.MediaPlayer2.Player as defined in MPRIS 2.2 spec:
<http://specifications.freedesktop.org/mpris-spec/latest/>
Note: If the sender disconnects its objects are automatically unregistered.
Possible Errors:
org.bluez.Error.InvalidArgumentsorg.bluez.Error.NotSupportedvoidUnregisterPlayer(objectplayer)
Unregister sender media player.
voidRegisterApplication(objectroot,dictoptions)
Register endpoints an player objects within root object which must implement ObjectManager.
The application object path together with the D-Bus system bus connection ID define the identification
of the application.
Possible errors:
org.bluez.Error.InvalidArgumentsorg.bluez.Error.AlreadyExistsvoidUnregisterApplication(objectapplication)
This unregisters the services that has been previously registered. The object path parameter must
match the same value that has been used on registration.
Possible errors:
org.bluez.Error.InvalidArgumentsorg.bluez.Error.DoesNotExistPropertiesarray{string}SupportedUUIDs[readonly]
List of 128-bit UUIDs that represents the supported Endpoint registration.
array{string}SupportedFeatures[readonly]
List of strings that represent supported special features. Possible values:
"tx-timestamping"
Bluetooth TX timestamping in media stream sockets is supported by BlueZ and kernel.
Applications may check kernel support for specific timestamp types via SIOCETHTOOL.
BlueZ April 2025 ORG.BLUEZ.MEDIA(5)
Name
org.bluez.Media - BlueZ D-Bus Media API documentation
