.\" Man page generated from reStructuredText
.\" by the Docutils 0.23 manpage writer.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "org.bluez.MediaAssistant" "5" "June 2024" "BlueZ" "Linux System Administration"
.SH Name
org.bluez.MediaAssistant \- BlueZ D-Bus MediaAssistant API documentation
.SH Interface
.INDENT 0.0
.TP
.B Service
org.bluez
.TP
.B Interface
org.bluez.MediaAssistant1
.TP
.B Object path
/org/bluez/{hci0,hci1,...}/dev_{BDADDR}/src_{BDADDR}/sid#/bis#
.TP
.B Used by
\fBbluetoothctl\-assistant(1)\fP
.UNINDENT
.SS Methods
.SS void Push(dict properties)
.sp
Send stream information to the remote device.
.sp
If the assistant is in the \(dqactive\(dq state, this method uses
BASS_Modify_Source to update the existing source on the remote device
instead of adding a new one with BASS_Add_Source.
.INDENT 0.0
.TP
.B dict properties
.UNINDENT
.sp
Indicate stream properties that will be sent to the peer.
.sp
Values:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B array{byte} Metadata [ISO only]
See Metadata property.
.TP
.B dict QoS [ISO only]
See QoS property.
.TP
.B object Device [ISO only, State=local only]
Push to a specific device. Device must be connected and with
an active BASS session.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Examples:
.INDENT 0.0
.TP
.B bluetoothctl
> assistant.push <assistant>
.UNINDENT
.SS Properties
.SS string State [readonly]
.sp
Indicates the state of the assistant object. Possible values are:
.INDENT 0.0
.TP
.B \(dqidle\(dq
assistant object was created for the stream
.TP
.B \(dqpending\(dq
assistant object was pushed (stream information was sent to the peer)
.TP
.B \(dqrequesting\(dq
remote device requires Broadcast_Code
.TP
.B \(dqactive\(dq
remote device started receiving stream
.TP
.B \(dqlocal\(dq
assistant object was created for a local stream
.UNINDENT
.SS array{byte} Metadata [readwrite, ISO Only, experimental]
.sp
Indicates stream Metadata.
.SS dict QoS [readwrite, ISO only, experimental]
.sp
Indicates stream QoS capabilities.
.sp
Values:
.INDENT 0.0
.TP
.B byte Encryption
Indicates whether the stream is encrypted.
.UNINDENT
.sp
:array{byte} BCode
.INDENT 0.0
.INDENT 3.5
Indicates Broadcast_Code to decrypt stream.
.UNINDENT
.UNINDENT
.\" End of generated man page.