doc/media: Document Links property for broadcast

This adds the "Links" property for broadcast.
This commit is contained in:
Iulia Tanasescu 2024-10-25 15:21:41 +03:00 committed by Luiz Augusto von Dentz
parent e0e3c922f7
commit 5b1dfd2721

View File

@ -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]
``````````````````````````````````````````````````````