[BlueZ,v2,09/14] doc/media: Document Links property for broadcast

Commit Message

Iulia Tanasescu Oct. 25, 2024, 12:21 p.m. UTC

This adds the "Links" property for broadcast.
---
 doc/org.bluez.MediaTransport.rst | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

Patch

diff --git a/doc/org.bluez.MediaTransport.rst b/doc/org.bluez.MediaTransport.rst
index 4d998b2a8..4838d69d0 100644
--- a/doc/org.bluez.MediaTransport.rst
+++ b/doc/org.bluez.MediaTransport.rst
@@ -144,11 +144,26 @@  array{byte} Metadata [readwrite, ISO Only, experimental]
 
 	Indicates transport Metadata.
 
-array{object} Links [readonly, optional, ISO only, experimental]
+array{object} Links [readonly, optional, CIS only, experimental]
 ````````````````````````````````````````````````````````````````
 
 	Linked transport objects which the transport is associated with.
 
+array{object} Links [readwrite, BIS only, 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.
+
 dict QoS [readwrite, optional, ISO only, experimental]
 ``````````````````````````````````````````````````````