From 32afb9df424c27d47955c0c7c5596d809b9641c1 Mon Sep 17 00:00:00 2001
From: Luiz Augusto von Dentz <luiz.von.dentz@intel.com>
Date: Wed, 27 Sep 2023 14:53:50 -0700
Subject: [PATCH] doc/MediaEndpoint: Move QoS capabilities to its own dict
 property

This moves QoS capabilities to its own dict property just as it was done
for MediaTransport QoS configuration.
---
 doc/org.bluez.MediaEndpoint.rst | 132 ++++++++++++++------------------
 1 file changed, 57 insertions(+), 75 deletions(-)

diff --git a/doc/org.bluez.MediaEndpoint.rst b/doc/org.bluez.MediaEndpoint.rst
index cba8cb3ed..0e201ff9d 100644
--- a/doc/org.bluez.MediaEndpoint.rst
+++ b/doc/org.bluez.MediaEndpoint.rst
@@ -41,57 +41,31 @@ void SetConfiguration(object transport, dict properties)
 
 		See Metadata property.
 
-	:uint32 Location [ISO only]:
+	:dict QoS [ISO only]:
 
-		See Location property.
-
-	:byte Framing [ISO only]:
-
-		See Framing property.
-
-	:byte PHY [ISO only]:
-
-		See PHY property.
-
-	:uint16 MaximumLatency [ISO only]:
-
-		See MaximumLatency property.
-
-	:uint32 MinimumDelay [ISO only]:
-
-		See MinimumDelay property.
-
-	:uint32 MaximumDelay [ISO only]:
-
-		See MaximumDelay property.
-
-	:uint32 PreferredMinimumDelay [ISO only]:
-
-		See PreferredMinimumDelay property.
-
-	:uint32 PreferredMaximumDelay [ISO only]:
-
-		See PreferredMaximumDelay property.
+		See **org.bluez.MediaTransport(5)** QoS property.
 
 array{byte} SelectConfiguration(array{byte} capabilities)
 `````````````````````````````````````````````````````````
 
 	Select preferable configuration from the supported capabilities.
 
-	Returns a configuration which can be used to setup a transport.
+	Returns a configuration which can be used to setup a transport, see
+	**org.bluez.MediaTransport(5)** for possible values.
 
 	Note: There is no need to cache the selected configuration since on
 	success the configuration is send back as parameter of SetConfiguration.
 
-dict SelectProperties(dict properties)
-``````````````````````````````````````
+dict SelectProperties(dict capabilities)
+````````````````````````````````````````
 
-	Select preferable properties from the supported properties:
+	Select configuration from the supported capabilities:
 
 	:object Endpoint [ISO only]:
 	:Refer to SetConfiguration for the list of other possible properties.:
 
-	Returns propeties which can be used to setup a transport.
+	Returns a configuration which can be used to setup a transport, see
+	**org.bluez.MediaTransport(5)** for possible values.
 
 	Note: There is no need to cache the selected properties since on
 	success the configuration is send back as parameter of SetConfiguration.
@@ -154,71 +128,79 @@ bool DelayReporting [readonly, optional]
 
 	Indicates if endpoint supports Delay Reporting.
 
-byte Framing [ISO only]
-```````````````````````
+uint32 Locations [readonly, optional, ISO only, experimental]
+`````````````````````````````````````````````````````````````
+
+	Indicates endpoint supported locations.
+
+uint16 SupportedContext [readonly, optional, ISO only, experimental]
+````````````````````````````````````````````````````````````````````
 
-	Indicates endpoint support framing.
+	Indicates endpoint supported audio context.
 
-byte PHY [ISO only]
-```````````````````
+uint16 Context [readonly, optional, ISO only, experimental]
+```````````````````````````````````````````````````````````
 
-	Indicates endpoint supported PHY.
+	Indicates endpoint available audio context.
 
-	Possible values:
+dict QoS [readonly, optional, ISO only, experimental]
+`````````````````````````````````````````````````````
 
-	:bit 0:
+	Indicates QoS capabilities.
 
-		LE 1M
+	:byte Framing:
 
-	:bit 1:
+		Indicates endpoint support framing.
 
-		LE 2M
 
-	:bit 2:
+		Possible Values:
 
-		LE Coded
+		:0x00:
 
-byte Retransmissions [ISO only]
-```````````````````````````````
+			Unframed PDUs supported.
 
-	Indicates endpoint preferred number of retransmissions.
+		:0x01:
 
-uint16_t MaximumLatency [ISO only]
-``````````````````````````````````
+			Unframed PDUs not supported.
 
-	Indicates endpoint maximum latency.
+	:byte PHY:
 
-uint32_t MinimumDelay [ISO only]
-````````````````````````````````
+		Indicates endpoint preferred PHY.
 
-	Indicates endpoint minimum presentation delay.
+		Possible values:
 
-uint32_t MaximumDelay [ISO only]
-````````````````````````````````
+		:bit 0:
 
-	Indicates endpoint maximum presentation delay.
+			LE 1M preferred.
 
-uint32_t PreferredMinimumDelay [ISO only]
-`````````````````````````````````````````
+		:bit 1:
 
-	Indicates endpoint preferred minimum presentation delay.
+			LE 2M preferred.
 
-uint32_t PreferredMaximumDelay [ISO only]
-`````````````````````````````````````````
+		:bit 2:
 
-	Indicates endpoint preferred maximum presentation delay.
+			LE Coded preferred.
 
-uint32 Location [ISO only]
-``````````````````````````
+	:byte Retransmissions:
 
-	Indicates endpoint supported locations.
+		Indicates endpoint preferred number of retransmissions.
 
-uint16 SupportedContext [ISO only]
-``````````````````````````````````
+	:uint16 MaximumLatency:
 
-	Indicates endpoint supported audio context.
+		Indicates endpoint maximum latency.
 
-uint16 Context [ISO only]
-`````````````````````````
+	:uint32 MinimumDelay:
 
-	Indicates endpoint available audio context.
+		Indicates endpoint minimum presentation delay.
+
+	:uint32 MaximumDelay:
+
+		Indicates endpoint maximum presentation delay.
+
+	:uint32 PreferredMinimumDelay:
+
+		Indicates endpoint preferred minimum presentation delay.
+
+	:uint32 PreferredMaximumDelay:
+
+		Indicates endpoint preferred maximum presentation delay.
-- 
2.47.3