diff mbox series

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

Message ID 20241024110223.77254-10-iulia.tanasescu@nxp.com
State New
Headers show
Series bap: Add support for Broadcast Sink AC 13 | expand

Commit Message

Iulia Tanasescu Oct. 24, 2024, 11:02 a.m. UTC
This adds details about the "Links" property for broadcast.
---
 doc/org.bluez.MediaTransport.rst | 3 +++
 1 file changed, 3 insertions(+)

Comments

Luiz Augusto von Dentz Oct. 24, 2024, 7:35 p.m. UTC | #1
Hi Iulia,

On Thu, Oct 24, 2024 at 7:03 AM Iulia Tanasescu <iulia.tanasescu@nxp.com> wrote:
>
> This adds details about the "Links" property for broadcast.
> ---
>  doc/org.bluez.MediaTransport.rst | 3 +++
>  1 file changed, 3 insertions(+)
>
> diff --git a/doc/org.bluez.MediaTransport.rst b/doc/org.bluez.MediaTransport.rst
> index 4d998b2a8..2173e0177 100644
> --- a/doc/org.bluez.MediaTransport.rst
> +++ b/doc/org.bluez.MediaTransport.rst
> @@ -149,6 +149,9 @@ array{object} Links [readonly, optional, ISO only, experimental]
>
>         Linked transport objects which the transport is associated with.
>
> +       For Broadcast transports, the property is writable and it is
> +       not optional.

We might update the heading and perhaps use CIS only and BIS only
instead of ISO only, perhaps we need to have 2 entries for Links in
order to document this properly so we don't have to mix the behavior
of CIS and BIS transports together.

Also perhaps stating why we are linking BISes of the same BIG together
might be a good idea, so again people don't think it was a mistake not
knowing that we did that in order to avoid having to redo the BIG sync
procedure everytime the Transport.Acquire is invoked.

> +
>  dict QoS [readwrite, optional, ISO only, experimental]
>  ``````````````````````````````````````````````````````
>
> --
> 2.43.0
>
diff mbox series

Patch

diff --git a/doc/org.bluez.MediaTransport.rst b/doc/org.bluez.MediaTransport.rst
index 4d998b2a8..2173e0177 100644
--- a/doc/org.bluez.MediaTransport.rst
+++ b/doc/org.bluez.MediaTransport.rst
@@ -149,6 +149,9 @@  array{object} Links [readonly, optional, ISO only, experimental]
 
 	Linked transport objects which the transport is associated with.
 
+	For Broadcast transports, the property is writable and it is
+	not optional.
+
 dict QoS [readwrite, optional, ISO only, experimental]
 ``````````````````````````````````````````````````````