diff mbox series

[BlueZ,v2,2/2] doc: describe new ISO Transport properties

Message ID 6a9a8ad4f432b2c5e1d9e290e8eba6ebfd7985f4.1678918574.git.pav@iki.fi (mailing list archive)
State Accepted
Commit 39260c3cfa056321feaf1d49fe8db92e17b386f0
Headers show
Series [BlueZ,v2,1/2] transport: add CIG/CIS/PHY properties, don't show unset QoS properties | 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 March 15, 2023, 10:16 p.m. UTC 
Document the currently undocumented transport QoS properties.
---

Notes:
    v2: Fix errors in v1. Don't update Delay, implementation may change.

 doc/media-api.txt | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)
diff mbox series

Patch

diff --git a/doc/media-api.txt b/doc/media-api.txt
index 281f72c1e..3746ccd55 100644
--- a/doc/media-api.txt
+++ b/doc/media-api.txt
@@ -804,3 +804,43 @@  Properties	object Device [readonly]
 
 			Linked transport objects which the transport is
 			associated with.
+
+		byte CIG [ISO only, optional, experimental]
+
+			Indicates configured QoS CIG.
+			Only present when QoS is configured.
+
+		byte CIS [ISO only, optional, experimental]
+
+			Indicates configured QoS CIS.
+			Only present when QoS is configured.
+
+		uint32 Interval [ISO only, optional, experimental]
+
+			Indicates configured QoS interval.
+			Only present when QoS is configured.
+
+		boolean Framing [ISO only, optional, experimental]
+
+			Indicates configured QoS framing.
+			Only present when QoS is configured.
+
+		byte PHY [ISO only, optional, experimental]
+
+			Indicates configured QoS PHY.
+			Only present when QoS is configured.
+
+		uint16 SDU [ISO only, optional, experimental]
+
+			Indicates configured QoS SDU.
+			Only present when QoS is configured.
+
+		byte Retransmissions [ISO only, optional, experimental]
+
+			Indicates configured QoS retransmissions.
+			Only present when QoS is configured.
+
+		uint16 Latency [ISO only, optional, experimental]
+
+			Indicates configured QoS latency.
+			Only present when QoS is configured.