RE: doc: Add initial MediaAssistant rst

RE: doc: Add initial MediaAssistant rst

[bluez.test.bot]

[-- Attachment #1: Type: text/plain, Size: 949 bytes --]

This is automated email and please do not reply to this email!

Dear submitter,

Thank you for submitting the patches to the linux bluetooth mailing list.
This is a CI test results with your patch series:
PW Link:https://patchwork.kernel.org/project/bluetooth/list/?series=867170

---Test result---

Test Summary:
CheckPatch                    PASS      0.27 seconds
GitLint                       PASS      0.20 seconds
BuildEll                      PASS      24.99 seconds
BluezMake                     PASS      1772.75 seconds
MakeCheck                     PASS      13.57 seconds
MakeDistcheck                 PASS      180.39 seconds
CheckValgrind                 PASS      255.01 seconds
CheckSmatch                   PASS      358.25 seconds
bluezmakeextell               PASS      120.46 seconds
IncrementalBuild              PASS      1548.34 seconds
ScanBuild                     PASS      1026.80 seconds



---
Regards,
Linux Bluetooth

[PATCH BlueZ v2 0/1] doc: Add initial MediaAssistant rst

[Iulia Tanasescu]

This proposes a new D-Bus API to be used by the BAP Broadcast Assistant
role.

The Push method on a MediaAssistant object sends stream information to
the peer device. The stream information refers to stream metadata and
the Broadacast_Code to decrypt the stream, in case it is encrypted.

Compared to the last patch version, this updates the proposed
MediaAssistant props, to include stream metadata and a QoS dict,
with the encryption status and the Broadacast_Code.

These props will be provided by the user to the Push method. If the
user does not wish to enter new values for the props, the values
discovered in the stream BASE will be sent to the peer.

Iulia Tanasescu (1):
  doc: Add initial MediaAssistant rst

 Makefile.am                      |  6 +--
 doc/org.bluez.MediaAssistant.rst | 74 ++++++++++++++++++++++++++++++++
 2 files changed, 77 insertions(+), 3 deletions(-)
 create mode 100644 doc/org.bluez.MediaAssistant.rst


base-commit: be0b08770e9214592e89589b2dc069426c0d9b91
-- 
2.39.2

[PATCH BlueZ v2 1/1] doc: Add initial MediaAssistant rst

[Iulia Tanasescu]

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 | 74 ++++++++++++++++++++++++++++++++
 2 files changed, 77 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..4aac89536
--- /dev/null
+++ b/doc/org.bluez.MediaAssistant.rst
@@ -0,0 +1,74 @@
+========================
+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(dict properties)
+````````````````````````````````````````````````````````
+
+	Send stream information to the remote device.
+
+	:dict properties:
+
+	Indicate stream properties that will be sent to the peer.
+
+	Values:
+
+		:array{byte} Metadata [ISO only]:
+
+			See Metadata property.
+
+		:dict QoS [ISO only]:
+
+			See QoS property.
+
+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
+
+array{byte} Metadata [readwrite, ISO Only, experimental]
+````````````````````````````````````````````````````````
+
+	Indicates stream Metadata.
+
+dict QoS [readwrite, ISO only, experimental]
+`````````````````````````````````````````````````````
+
+	Indicates stream QoS capabilities.
+
+	Values:
+
+	:byte Encryption:
+
+		Indicates whether the stream is encrypted.
+
+	:array{byte} BCode
+
+		Indicates Broadcast_Code to decrypt stream.
-- 
2.39.2

RE: doc: Add initial MediaAssistant rst

[bluez.test.bot]

[-- Attachment #1: Type: text/plain, Size: 949 bytes --]

This is automated email and please do not reply to this email!

Dear submitter,

Thank you for submitting the patches to the linux bluetooth mailing list.
This is a CI test results with your patch series:
PW Link:https://patchwork.kernel.org/project/bluetooth/list/?series=868086

---Test result---

Test Summary:
CheckPatch                    PASS      0.36 seconds
GitLint                       PASS      0.27 seconds
BuildEll                      PASS      24.60 seconds
BluezMake                     PASS      1737.66 seconds
MakeCheck                     PASS      13.50 seconds
MakeDistcheck                 PASS      181.06 seconds
CheckValgrind                 PASS      256.46 seconds
CheckSmatch                   PASS      355.81 seconds
bluezmakeextell               PASS      119.44 seconds
IncrementalBuild              PASS      1561.86 seconds
ScanBuild                     PASS      1033.72 seconds



---
Regards,
Linux Bluetooth

Re: [PATCH BlueZ v2 0/1] doc: Add initial MediaAssistant rst

[patchwork-bot+bluetooth]

Hello:

This patch was applied to bluetooth/bluez.git (master)
by Luiz Augusto von Dentz <luiz.von.dentz@intel.com>:

On Wed,  3 Jul 2024 17:58:38 +0300 you wrote:
> This proposes a new D-Bus API to be used by the BAP Broadcast Assistant
> role.
> 
> The Push method on a MediaAssistant object sends stream information to
> the peer device. The stream information refers to stream metadata and
> the Broadacast_Code to decrypt the stream, in case it is encrypted.
> 
> [...]

Here is the summary with links:
  - [BlueZ,v2,1/1] doc: Add initial MediaAssistant rst
    https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=66a76c268d05

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html