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

Service org.bluez Interface org.bluez.MediaTransport1 Objectpath [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX/fdX Methodsfd,uint16,uint16Acquire() Acquire transport file descriptor and the MTU for read and write respectively. Possible Errors: org.bluez.Error.NotAuthorizedorg.bluez.Error.Failedfd,uint16,uint16TryAcquire() Acquire transport file descriptor only if the transport is in "pending" state at the time the message is received by BlueZ. Otherwise no request will be sent to the remote device and the function will just fail with org.bluez.Error.NotAvailable. Possible Errors: org.bluez.Error.NotAuthorizedorg.bluez.Error.Failedorg.bluez.Error.NotAvailablevoidRelease() Releases file descriptor. voidSelect() Applicable only for transports created by a broadcast sink. This moves the transport from 'idle' to 'broadcasting'. This allows the user to select which BISes he wishes to sync to via a 2 step process: 1) the user calls the method, changing the transport's state to broadcasting 2) the audio server detects that the transport is in the 'broadcasting' state and automatically acquires it Possible Errors: org.bluez.Error.NotAuthorizedvoidUnselect() Applicable only for transports created by a broadcast sink. This moves the transport from 'broadcasting' or 'active' to 'idle'. This allows the user to terminate the sync to a BIS to via a 2 step process: 1) the user calls this method, changing the transport's state to idle 2) the audio server detects this event and releases the transport Possible Errors: org.bluez.Error.NotAuthorizedPropertiesobjectDevice[readonly] Device object which the transport is connected to. stringUUID[readonly] UUID of the profile which the transport is for. byteCodec[readonly] Assigned number of codec that the transport support. The values should match the profile specification which is indicated by the UUID. array{byte}Configuration[readonly] Configuration blob, it is used as it is so the size and byte order must match. stringState[readonly] Indicates the state of the transport. Possible values are: "idle" not streaming "pending" streaming but not acquired "broadcasting" streaming but not acquired, applicable only for transports created by a broadcast sink "active" streaming and acquired uint16Delay[readwrite,optional] Transport delay in 1/10 of millisecond, this property is only writeable when the transport corresponds to a sink endpoint and it was acquired by the sender. uint16Volume[readwrite,optional] Indicates volume level of the transport, this property is only writeable when the transport was acquired by the sender. PossibleValues:0-127(A2DP) 0-255 (BAP) objectEndpoint[readonly,optional,experimental] Endpoint object which the transport is associated with. uint32Location[readonly,ISOonly,experimental] Indicates transport Audio Location. array{byte}Metadata[readwrite,ISOOnly,experimental] Indicates transport Metadata. array{object}Links[readonly,optional,CISonly,experimental] Linked transport objects which the transport is associated with. array{object}Links[readwrite,BISonly,experimental] For a Broadcast Sink, the BIG sync procedure requires all desired streams to be enumerated from the start and it cannot be later reconfigured by adding or removing BISes. To avoid terminating and recreating the BIG sync everytime a new transport is selected for acquire, all transports selected via Transport.Select need to be linked together. When the first transport is acquired via Transport.Acquire, all links are included in the BIG sync command. An acquired transport will create and set fds for all its links. Then, each link needs to be acquired separately, to get the fd and start receiving audio. dictQoS[readwrite,optional,ISOonly,experimental] Only present when QoS is configured. Possible values for Unicast: byteCIG Indicates configured CIG. Possible values: 0x00-0xef Valid ID range. 0xff Auto allocate. byteCIS Indicates configured CIS. Possible values: 0x00-0xef Valid ID range. 0xff Auto allocate. byteFraming Indicates configured framing. Possible values: 0x00 Unframed. 0x01 Framed. uint32PresentationDelay Indicates configured transport presentation delay (us). byteTargetLatency Indicates the requested target latency. Possible values: 0x01 Low Latency. 0x02 Balanced Latency/Reliability. 0x03 High Reliability. Possible values for Broadcast: byteBIG Indicates configured QoS BIG. byteBIS Indicates configured BIS. byteSyncFactor Indicates configured broadcast sync factor. bytePacking Indicates configured packing. byteFraming Indicates configured framing. array{byte}BCode Indicates the string used for encryption/decryption. byteencryption Indicates if the stream is encrypted. byteOptions Indicates configured broadcast options. uint16Skip Indicates configured broadcast skip. byteSyncTimeout Indicates configured broadcast sync timeout. byteSyncType Indicates configured broadcast sync CTE type. byteMSE Indicates configured broadcast MSE. uint16Timeout Indicates configured broadcast timeout. Possible values for both Unicast and Broadcast: uint32Interval Indicates configured ISO interval (us). uint16Latency Indicates configured transport latency (ms). uint16SDU Indicates configured maximum SDU. bytePHY Indicates configured PHY. Possible values: bit0 LE 1M bit1 LE 2M bit2 LE Coded byteRetransmissions Indicates configured retransmissions. BlueZ July 2024 ORG.BLUEZ.MEDIATRANSPORT(5)

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