1ORG.BLUEZ.MEDIAENDPOINT(5)Linux System AdministrationORG.BLUEZ.MEDIAENDPOINT(5)
2
3
4

NAME

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

INTERFACE

9       Service
10              unique name (Server role) org.bluez (Client role)
11
12       Interface
13              org.bluez.MediaEndpoint1
14
15       Object path
16              freely     definable     (Server     role)     [variable    pre‐
17              fix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX/sepX (Client role)
18
19   Methods
20   void SetConfiguration(object transport, dict properties)
21          Set configuration for the transport.
22
23          object transport
24                 Configured transport object.
25
26          dict properties
27                 Configured org.bluez.MediaTransport(5) properties.
28
29          For client role transport must be set with a server endpoint  object
30          which will be configured and the properties must contain the follow‐
31          ing properties:
32
33          array{byte} Capabilities [Mandatory]
34                 See Capabilities property.
35
36          array{byte} Metadata [ISO only]
37                 See Metadata property.
38
39          dict QoS [ISO only]
40                 See org.bluez.MediaTransport(5) QoS property.
41
42   array{byte} SelectConfiguration(array{byte} capabilities)
43          Select preferable configuration from the supported capabilities.
44
45          Returns a configuration which can be used to setup a transport,  see
46          org.bluez.MediaTransport(5) for possible values.
47
48          Note:  There is no need to cache the selected configuration since on
49          success the configuration is send back as parameter of SetConfigura‐
50          tion.
51
52   dict SelectProperties(dict capabilities)
53          Select BAP unicast configuration from the supported capabilities:
54
55          object Endpoint
56
57          array{byte} Capabilities
58
59          array{byte} Metadata
60
61          uint32 Locations
62
63          dict QoS
64
65                 byte Framing
66
67                 byte PHY
68
69                 uint16 MaximumLatency
70
71                 uint32 MinimumDelay
72
73                 uint32 MaximumDelay
74
75                 uint32 PreferredMinimumDelay
76
77                 uint32 PreferredMaximumDelay
78
79          See MediaEndpoint Properties for their possible values.
80
81          Returns a configuration which can be used to setup a transport:
82
83          array{byte} Capabilities
84
85          array{byte} Metadata [optional]
86
87          dict QoS
88
89          See SetConfiguration for their possible values.
90
91          Note:  There  is  no  need to cache the selected properties since on
92          success the configuration is send back as parameter of SetConfigura‐
93          tion.
94
95   void ClearConfiguration(object transport)
96          Clear transport configuration.
97
98   void Release()
99          This method gets called when the service daemon unregisters the end‐
100          point. An endpoint can use it to do cleanup tasks. There is no  need
101          to  unregister the endpoint, because when this method gets called it
102          has already been unregistered.
103
104   MediaEndpoint Properties
105   string UUID [readonly, optional]
106          UUID of the profile which the endpoint is for.
107
108   byte Codec [readonly, optional]
109          Assigned number of codec that the endpoint implements.   The  values
110          should  match  the  profile  specification which is indicated by the
111          UUID.
112
113   uint32_t Vendor [readonly, Optional]
114          Vendor-specific Company ID, Codec ID tuple that the endpoint  imple‐
115          ments.
116
117          It  shall  be  set  to  appropriate value when Vendor Specific Codec
118          (0xff) is used.
119
120   array{byte} Capabilities [readonly, optional]
121          Capabilities blob, it is used as it is so the size  and  byte  order
122          must match.
123
124   array{byte} Metadata [readonly, Optional]
125          Metadata  blob,  it is used as it is so the size and byte order must
126          match.
127
128   object Device [readonly, optional]
129          Device object which the endpoint is belongs to.
130
131   bool DelayReporting [readonly, optional]
132          Indicates if endpoint supports Delay Reporting.
133
134   uint32 Locations [readonly, optional, ISO only, experimental]
135          Indicates endpoint supported locations.
136
137   uint16 SupportedContext [readonly, optional, ISO only, experimental]
138          Indicates endpoint supported audio context.
139
140   uint16 Context [readonly, optional, ISO only, experimental]
141          Indicates endpoint available audio context.
142
143   dict QoS [readonly, optional, ISO only, experimental]
144          Indicates QoS capabilities.
145
146          byte Framing
147                 Indicates endpoint support framing.
148
149                 Possible Values:
150
151                 0x00   Unframed PDUs supported.
152
153                 0x01   Unframed PDUs not supported.
154
155          byte PHY
156                 Indicates endpoint preferred PHY.
157
158                 Possible values:
159
160                 bit 0  LE 1M preferred.
161
162                 bit 1  LE 2M preferred.
163
164                 bit 2  LE Coded preferred.
165
166          byte Retransmissions
167                 Indicates endpoint preferred number of retransmissions.
168
169          uint16 MaximumLatency
170                 Indicates endpoint maximum latency.
171
172          uint32 MinimumDelay
173                 Indicates endpoint minimum presentation delay.
174
175          uint32 MaximumDelay
176                 Indicates endpoint maximum presentation delay.
177
178          uint32 PreferredMinimumDelay
179                 Indicates endpoint preferred minimum presentation delay.
180
181          uint32 PreferredMaximumDelay
182                 Indicates endpoint preferred maximum presentation delay.
183
184
185
186
187BlueZ                           September 2023      ORG.BLUEZ.MEDIAENDPOINT(5)