org.bluez.Media(5) Linux System Administration org.bluez.Media(5)

# [Name](#Name)

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

# [Interface](#Interface)

[**Service**](#Service)

org.bluez

[**Interface**](#Interface~2)

org.bluez.Media1

[**Object path**](#Object)

\[variable prefix]/{hci0,hci1,...}

[**Used by**](#Used)

[**bluetoothctl-endpoint(1)**](/man/os/bluez/bluetoothctl-endpoint.1)

## [Methods](#Methods)

## [void RegisterEndpoint(object endpoint, dict properties)](#void_RegisterEndpoint%28object_endpoint,_dict_properties%29)

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:

[**string UUID**](#string)

UUID of the profile which the endpoint is for.

UUID must be in the list of SupportedUUIDS.

[**byte Codec**](#byte)

Assigned number of codec that the endpoint implements. The values should match the profile specification which is indicated by the UUID.

[**uint32\_t Vendor \[Optional\]**](#uint32_t)

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**](#array_byte_)

Capabilities blob, it is used as it is so the size and byte order must match.

[**array{byte} Metadata \[Optional\]**](#array_byte_~2)

Metadata blob, it is used as it is so the size and byte order must match.

Possible Errors:

[**org.bluez.Error.InvalidArguments**](#org.bluez.Error.InvalidArguments)

[**org.bluez.Error.NotSupported**](#org.bluez.Error.NotSupported)

emitted when interface for the end-point is disabled

Examples:

[**bluetoothctl**](#bluetoothctl)

&gt; endpoint.register &lt;UUID&gt; &lt;codec\[:company]&gt; \[capabilities...]

## [void UnregisterEndpoint(object endpoint)](#void_UnregisterEndpoint%28object_endpoint%29)

Unregister sender end point.

Examples:

[**bluetoothctl**](#bluetoothctl~2)

&gt; endpoint.unregister &lt;UUID/object&gt;

## [void RegisterPlayer(object player, dict properties)](#void_RegisterPlayer%28object_player,_dict_properties%29)

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:

&lt;http://specifications.freedesktop.org/mpris-spec/latest/&gt;

Note: If the sender disconnects its objects are automatically unregistered.

Possible Errors:

[**org.bluez.Error.InvalidArguments**](#org.bluez.Error.InvalidArguments~2)

[**org.bluez.Error.NotSupported**](#org.bluez.Error.NotSupported~2)

## [void UnregisterPlayer(object player)](#void_UnregisterPlayer%28object_player%29)

Unregister sender media player.

## [void RegisterApplication(object root, dict options)](#void_RegisterApplication%28object_root,_dict_options%29)

Register endpoints an player objects within root object which must implement **org.freedesktop.DBus.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.InvalidArguments**](#org.bluez.Error.InvalidArguments~3)

[**org.bluez.Error.AlreadyExists**](#org.bluez.Error.AlreadyExists)

## [void UnregisterApplication(object application)](#void_UnregisterApplication%28object_application%29)

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.InvalidArguments**](#org.bluez.Error.InvalidArguments~4)

[**org.bluez.Error.DoesNotExist**](#org.bluez.Error.DoesNotExist)

## [Properties](#Properties)

## [array{string} SupportedUUIDs \[readonly\]](#array_string__SupportedUUIDs__readonly_)

List of 128-bit UUIDs that represents the supported Endpoint registration.

## [array{string} SupportedFeatures \[readonly\]](#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.

April 2025 BlueZ

---

Document: org.bluez.Media(5) from bluez 5.87-r3 (Chainguard OS)
Source: https://github.com/bluez/bluez
