diff mbox series

[BlueZ,2/2] doc: clarify org.bluez.MediaEndpoint documentation

Message ID d5bf0d4ac79bd447d78adad743ed5ae7e8f47048.1696157794.git.pav@iki.fi (mailing list archive)
State New, archived
Headers show
Series [BlueZ,1/2] bap: use documented MediaEndpoint property names consistently | expand

Checks

Context Check Description
tedd_an/pre-ci_am success Success
tedd_an/CheckPatch success CheckPatch PASS
tedd_an/GitLint success Gitlint PASS
tedd_an/IncrementalBuild success Incremental Build PASS

Commit Message

Pauli Virtanen Oct. 1, 2023, 10:57 a.m. UTC
Document the actual input and output parameter values used in
SelectProperties. These differ from SetConfiguration.

Mention SelectProperties is used for unicast only.

Document SetConfiguration input parameters.
---
 doc/org.bluez.MediaEndpoint.rst | 42 ++++++++++++++++++++++++++-------
 1 file changed, 34 insertions(+), 8 deletions(-)

Comments

Luiz Augusto von Dentz Oct. 2, 2023, 9:07 p.m. UTC | #1
Hi Pauli,

On Sun, Oct 1, 2023 at 5:06 AM Pauli Virtanen <pav@iki.fi> wrote:
>
> Document the actual input and output parameter values used in
> SelectProperties. These differ from SetConfiguration.
>
> Mention SelectProperties is used for unicast only.
>
> Document SetConfiguration input parameters.
> ---
>  doc/org.bluez.MediaEndpoint.rst | 42 ++++++++++++++++++++++++++-------
>  1 file changed, 34 insertions(+), 8 deletions(-)
>
> diff --git a/doc/org.bluez.MediaEndpoint.rst b/doc/org.bluez.MediaEndpoint.rst
> index 0e201ff9d..11b7280bd 100644
> --- a/doc/org.bluez.MediaEndpoint.rst
> +++ b/doc/org.bluez.MediaEndpoint.rst
> @@ -24,14 +24,24 @@ Interface
>  Methods
>  -------
>
> +.. _SetConfiguration:
> +
>  void SetConfiguration(object transport, dict properties)
>  ````````````````````````````````````````````````````````
>
>         Set configuration for the transport.
>
> -       For client role transport must be set with a server endpoint oject which
> -       will be configured and the properties must contain the following
> -       properties:
> +       :object transport:
> +
> +               Configured transport object.
> +
> +       :dict properties:
> +
> +               Configured **org.bluez.MediaTransport(5)** properties.
> +
> +       For client role transport must be set with a server endpoint
> +       object which will be configured and the properties must
> +       contain the following properties:
>
>         :array{byte} Capabilities [Mandatory]:
>
> @@ -59,13 +69,29 @@ array{byte} SelectConfiguration(array{byte} capabilities)
>  dict SelectProperties(dict capabilities)
>  ````````````````````````````````````````
>
> -       Select configuration from the supported capabilities:
> +       Select BAP unicast configuration from the supported capabilities:
>
> -       :object Endpoint [ISO only]:
> -       :Refer to SetConfiguration for the list of other possible properties.:
> +       :object Endpoint:
> +       :array{byte} Capabilities:
> +       :array{byte} Metadata:
> +       :uint32 Locations:

The idea is these below are passed as in one container as in
MediaEndpoint.QoS, looks like I missed changing the handling on
pac_select since bluetoothctl doesn't check it but most likely
pipewire does.

> +       :byte Framing:
> +       :byte PHY:
> +       :uint16 MaximumLatency:
> +       :uint32 MinimumDelay:
> +       :uint32 MaximumDelay:
> +       :uint32 PreferredMinimumDelay:
> +       :uint32 PreferredMaximumDelay:
>
> -       Returns a configuration which can be used to setup a transport, see
> -       **org.bluez.MediaTransport(5)** for possible values.
> +       See `MediaEndpoint Properties`_ for their possible values.
> +
> +       Returns a configuration which can be used to setup a transport:
> +
> +       :array{byte} Capabilities:
> +       :array{byte} Metadata [optional]:
> +       :dict QoS:
> +
> +       See `SetConfiguration`_ for their possible values.

Interesting, need to check if the references works on manpages as well.

>         Note: There is no need to cache the selected properties since on
>         success the configuration is send back as parameter of SetConfiguration.
> --
> 2.41.0
>
diff mbox series

Patch

diff --git a/doc/org.bluez.MediaEndpoint.rst b/doc/org.bluez.MediaEndpoint.rst
index 0e201ff9d..11b7280bd 100644
--- a/doc/org.bluez.MediaEndpoint.rst
+++ b/doc/org.bluez.MediaEndpoint.rst
@@ -24,14 +24,24 @@  Interface
 Methods
 -------
 
+.. _SetConfiguration:
+
 void SetConfiguration(object transport, dict properties)
 ````````````````````````````````````````````````````````
 
 	Set configuration for the transport.
 
-	For client role transport must be set with a server endpoint oject which
-	will be configured and the properties must contain the following
-	properties:
+	:object transport:
+
+		Configured transport object.
+
+	:dict properties:
+
+		Configured **org.bluez.MediaTransport(5)** properties.
+
+	For client role transport must be set with a server endpoint
+	object which will be configured and the properties must
+	contain the following properties:
 
 	:array{byte} Capabilities [Mandatory]:
 
@@ -59,13 +69,29 @@  array{byte} SelectConfiguration(array{byte} capabilities)
 dict SelectProperties(dict capabilities)
 ````````````````````````````````````````
 
-	Select configuration from the supported capabilities:
+	Select BAP unicast configuration from the supported capabilities:
 
-	:object Endpoint [ISO only]:
-	:Refer to SetConfiguration for the list of other possible properties.:
+	:object Endpoint:
+	:array{byte} Capabilities:
+	:array{byte} Metadata:
+	:uint32 Locations:
+	:byte Framing:
+	:byte PHY:
+	:uint16 MaximumLatency:
+	:uint32 MinimumDelay:
+	:uint32 MaximumDelay:
+	:uint32 PreferredMinimumDelay:
+	:uint32 PreferredMaximumDelay:
 
-	Returns a configuration which can be used to setup a transport, see
-	**org.bluez.MediaTransport(5)** for possible values.
+	See `MediaEndpoint Properties`_ for their possible values.
+
+	Returns a configuration which can be used to setup a transport:
+
+	:array{byte} Capabilities:
+	:array{byte} Metadata [optional]:
+	:dict QoS:
+
+	See `SetConfiguration`_ for their possible values.
 
 	Note: There is no need to cache the selected properties since on
 	success the configuration is send back as parameter of SetConfiguration.