1ORG.BLUEZ.MEDIATRANSPORT(5)Linux System AdministratioOnRG.BLUEZ.MEDIATRANSPORT(5)
2
3
4

NAME

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

INTERFACE

9       Service
10              org.bluez
11
12       Interface
13              org.bluez.MediaTransport1
14
15       Object path
16              [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX/fdX
17
18   Methods
19   fd, uint16, uint16 Acquire()
20          Acquire transport file descriptor and the MTU for read and write re‐
21          spectively.
22
23          Possible Errors:
24
25          org.bluez.Error.NotAuthorized
26
27          org.bluez.Error.Failed
28
29   fd, uint16, uint16 TryAcquire()
30          Acquire transport file descriptor only if the transport is in "pend‐
31          ing"  state  at the time the message is received by BlueZ. Otherwise
32          no request will be sent to the remote device and the  function  will
33          just fail with org.bluez.Error.NotAvailable.
34
35          Possible Errors:
36
37          org.bluez.Error.NotAuthorized
38
39          org.bluez.Error.Failed
40
41          org.bluez.Error.NotAvailable
42
43   void Release()
44          Releases file descriptor.
45
46   Properties
47   object Device [readonly]
48          Device object which the transport is connected to.
49
50   string UUID [readonly]
51          UUID of the profile which the transport is for.
52
53   byte Codec [readonly]
54          Assigned  number  of  codec  that the transport support.  The values
55          should match the profile specification which  is  indicated  by  the
56          UUID.
57
58   array{byte} Configuration [readonly]
59          Configuration  blob,  it is used as it is so the size and byte order
60          must match.
61
62   string State [readonly]
63          Indicates the state of the transport. Possible values are:
64
65          "idle" not streaming
66
67          "pending"
68                 streaming but not acquired
69
70          "active"
71                 streaming and acquired
72
73   uint16 Delay [readwrite, optional]
74          Transport delay in 1/10 of millisecond, this property is only write‐
75          able when the transport was acquired by the sender.
76
77   uint16 Volume [readwrite, optional]
78          Indicates  volume  level  of  the  transport,  this property is only
79          writeable when the transport was acquired by the sender.
80
81          Possible Values: 0-127
82
83   object Endpoint [readonly, optional, experimental]
84          Endpoint object which the transport is associated with.
85
86   uint32 Location [readonly, ISO only, experimental]
87          Indicates transport Audio Location.
88
89   array{byte} Metadata [readwrite, ISO Only, experimental]
90          Indicates transport Metadata.
91
92   array{object} Links [readonly, optional, ISO only, experimental]
93          Linked transport objects which the transport is associated with.
94
95   dict QoS [readonly, optional, ISO only, experimental]
96          Only present when QoS is configured.
97
98          Possible values for Unicast:
99
100          byte CIG
101                 Indicates configured CIG.
102
103                 Possible values:
104
105                 0x00 - 0xef
106                        Valid ID range.
107
108                 0xff   Auto allocate.
109
110          byte CIS
111                 Indicates configured CIS.
112
113                 Possible values:
114
115                 0x00 - 0xef
116                        Valid ID range.
117
118                 0xff   Auto allocate.
119
120          byte Framing
121                 Indicates configured framing.
122
123                 Possible values:
124
125                 0x00   Unframed.
126
127                 0x01   Framed.
128
129          uint32 PresentationDelay
130                 Indicates configured transport presentation delay (us).
131
132          byte TargetLatency
133                 Indicates the requested target latency.
134
135                 Possible values:
136
137                 0x01   Low Latency.
138
139                 0x02   Balanced Latency/Reliability.
140
141                 0x03   High Reliability.
142
143          Possible values for Broadcast:
144
145          byte BIG
146                 Indicates configured QoS BIG.
147
148          byte BIS
149                 Indicates configured BIS.
150
151          byte SyncFactor
152                 Indicates configured broadcast sync factor.
153
154          byte Packing
155                 Indicates configured packing.
156
157          byte Framing
158                 Indicates configured framing.
159
160          byte Options
161                 Indicates configured broadcast options.
162
163          uint16 Skip
164                 Indicates configured broadcast skip.
165
166          byte SyncTimeout
167                 Indicates configured broadcast sync timeout.
168
169          byte SyncType
170                 Indicates configured broadcast sync CTE type.
171
172          byte MSE
173                 Indicates configured broadcast MSE.
174
175          uint16 Timeout
176                 Indicates configured broadcast timeout.
177
178          Possible values for both Unicast and Broadcast:
179
180          uint32 Interval
181                 Indicates configured ISO interval (us).
182
183          uint16 Latency
184                 Indicates configured transport latency (ms).
185
186          uint16 SDU
187                 Indicates configured maximum SDU.
188
189          byte PHY
190                 Indicates configured PHY.
191
192                 Possible values:
193
194                 bit 0  LE 1M
195
196                 bit 1  LE 2M
197
198                 bit 2  LE Coded
199
200          byte Retransmissions
201                 Indicates configured retransmissions.
202
203
204
205
206BlueZ                           September 2023     ORG.BLUEZ.MEDIATRANSPORT(5)