Blob: org.bluez.MediaAssistant.rst

Blob id: 8650d8abb3794a8f593519dd3ce2d9f83f27c37d

Size: 1.7 KB

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
========================
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,...}/dev_{BDADDR}/src_{BDADDR}/sid#/bis#

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.

	:object Device [ISO only, State=local only]:

		Push to a specific device. Device must be connected and with
		an active BASS session.

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
:"local": assistant object was created for a local 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.