This adds initial documentation for the MediaAssistant D-Bus API, to
be used by a Broadcast Assistant application to interract with the
BlueZ implementation (BASS Client).
---
Makefile.am | 6 +-
doc/org.bluez.MediaAssistant.rst | 97 ++++++++++++++++++++++++++++++++
2 files changed, 100 insertions(+), 3 deletions(-)
create mode 100644 doc/org.bluez.MediaAssistant.rst
diff --git a/Makefile.am b/Makefile.am
index 0ae721111..46a8cfb49 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -362,7 +362,7 @@ man_MANS += doc/org.bluez.Adapter.5 doc/org.bluez.Device.5 \
man_MANS += doc/org.bluez.Media.5 doc/org.bluez.MediaControl.5 \
doc/org.bluez.MediaPlayer.5 doc/org.bluez.MediaFolder.5 \
doc/org.bluez.MediaItem.5 doc/org.bluez.MediaEndpoint.5 \
- doc/org.bluez.MediaTransport.5
+ doc/org.bluez.MediaTransport.5 doc/org.bluez.MediaAssistant.5
man_MANS += doc/org.bluez.GattManager.5 doc/org.bluez.GattProfile.5 \
doc/org.bluez.GattService.5 \
doc/org.bluez.GattCharacteristic.5 \
@@ -395,7 +395,7 @@ manual_pages += doc/org.bluez.Adapter.5 doc/org.bluez.Device.5 \
manual_pages += doc/org.bluez.Media.5 doc/org.bluez.MediaControl.5 \
doc/org.bluez.MediaPlayer.5 doc/org.bluez.MediaFolder.5 \
doc/org.bluez.MediaItem.5 doc/org.bluez.MediaEndpoint.5 \
- doc/org.bluez.MediaTransport.5
+ doc/org.bluez.MediaTransport.5 doc/org.bluez.MediaAssistant.5
manual_pages += doc/org.bluez.GattManager.5 doc/org.bluez.GattProfile.5 \
doc/org.bluez.GattService.5 \
doc/org.bluez.GattCharacteristic.5 \
@@ -475,7 +475,7 @@ EXTRA_DIST += doc/org.bluez.Adapter.rst doc/org.bluez.Device.rst \
EXTRA_DIST += doc/org.bluez.Media.rst doc/org.bluez.MediaControl.rst \
doc/org.bluez.MediaPlayer.rst doc/org.bluez.MediaFolder.rst \
doc/org.bluez.MediaItem.rst doc/org.bluez.MediaEndpoint.rst \
- doc/org.bluez.MediaTransport.rst
+ doc/org.bluez.MediaTransport.rst doc/org.bluez.MediaAssistant.rst
EXTRA_DIST += doc/org.bluez.GattManager.rst doc/org.bluez.GattProfile.rst\
doc/org.bluez.GattService.rst \
diff --git a/doc/org.bluez.MediaAssistant.rst b/doc/org.bluez.MediaAssistant.rst
new file mode 100644
index 000000000..a6fdef393
--- /dev/null
+++ b/doc/org.bluez.MediaAssistant.rst
@@ -0,0 +1,97 @@
+========================
+org.bluez.MediaAssistant
+========================
+
+--------------------------------------------
+BlueZ D-Bus MediaAssistant API documentation
+--------------------------------------------
+
+:Version: BlueZ
+:Date: June 2024
+:Manual section: 5
+:Manual group: Linux System Administration
+
+Interface
+=========
+
+:Service: org.bluez
+:Interface: org.bluez.MediaAssistant1
+:Object path: /org/bluez/{hci0,hci1,...}/src_XX_XX_XX_XX_XX_XX/dev_YY_YY_YY_YY_YY_YY/bisZ
+
+Methods
+-------
+
+void Push(array{byte} Broadcast_Code)
+````````````````````````````````````````````````````````
+
+ Send stream information to the remote device. If the stream
+ is unencrypted, the Broadcast_Code is set to 0. Otherwise,
+ it contains the key to decrypt the stream.
+
+Properties
+----------
+
+string State [readonly]
+```````````````````````
+
+ Indicates the state of the assistant object. Possible values are:
+
+ :"idle": assistant object was created for the stream
+ :"pending": assistant object was pushed (stream information was sent to the peer)
+ :"requesting": remote device requires Broadcast_Code
+ :"active": remote device started receiving stream
+
+dict QoS [readonly, ISO only, experimental]
+`````````````````````````````````````````````````````
+
+ Indicates QoS capabilities.
+
+ Values:
+
+ :byte BIG:
+
+ Indicates BIG id.
+
+ :byte Encryption:
+
+ Indicates whether the stream is encrypted.
+
+ :array{byte} BCode
+
+ Indicates Broadcast_Code to decrypt stream.
+
+ :byte Options:
+
+ Indicates configured broadcast options.
+
+ :uint16 Skip:
+
+ Indicates configured broadcast skip.
+
+ :byte SyncTimeout:
+
+ Indicates configured broadcast sync timeout.
+
+ :byte SyncType:
+
+ Indicates configured broadcast sync CTE type.
+
+ :byte MSE:
+
+ Indicates configured broadcast MSE.
+
+ :uint16 Timeout:
+
+ Indicates configured broadcast timeout.
+
+ :uint32 Interval:
+
+ Indicates configured ISO interval (us).
+
+ :uint16 Latency:
+
+ Indicates configured transport latency (ms).
+
+ :uint16 SDU:
+
+ Indicates configured maximum SDU.
\ No newline at end of file
--
2.39.2
