Blob: bluetoothctl-transport.rst

Blob id: 77d8457a5d6fabe6305a4451e72e8e84392568b4

Size: 2.9 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
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
======================
bluetoothctl-transport
======================

-----------------------
Media Transport Submenu
-----------------------

:Version: BlueZ
:Copyright: Free use of this software is granted under the terms of the GNU
            Lesser General Public Licenses (LGPL).
:Date: November 2022
:Manual section: 1
:Manual group: Linux System Administration

SYNOPSIS
========

**bluetoothctl** [--options] [transport.commands]

Media Transport Commands
=========================

list
----

List available transports.

:Usage: **> list**

show
----

Show transport information.

:Usage: **> show [transport]**

acquire
-------

Acquire transport.

:Usage: **> acquire <transport> [transport1...]**

Note:

If running the setup with an audio server that has LE Audio support (such as PipeWire) it will
automatically acquire transports according to the configured roles.

select
-------

Select transport. For transports created on a Broadcast Sink device only. This moves
the transport to the "broadcasting" state, pending acquire.

:Usage: **> select <transport> [transport1...]**

Note:

If the select command receives a list of transports, they will first be linked using the
"Links" MediaTransport property. They will then be selected one by one, by calling
the "Select" MediaTransport method. After the first transport is acquired, the Broadcast
Sink will create fds for the associated stream and all its links. Each link can then be
acquired one by one, setting the fd for the transport and starting to receive audio.

The select command does not require a local endpoint to be registered beforehand. This is
because if the setup runs with an audio server that has LE Audio support (such as PipeWire),
the audio server is the one to register endpoints and the transports are created as a result.
Once a transport is selected, the audio server will automatically acquire.

unselect
--------

Unselect transport. For transports created on a Broadcast Sink device only. This moves
the transport to the "idle" state, pending release by the audio server. If the transport
was acquired by bluetoothctl it can be released straight away, without having to be
unselected.

:Usage: **> unselect <transport> [transport1...]**

Note:
If running the setup with an audio server that has LE Audio support (such as PipeWire), it will
prompt it to automatically release the transport.

release
-------

Release transport.

:Usage: **> release <transport> [transport1...]**

Note:

Transports acquired by an audio server, can only be released by said audio server.

send
----

Send contents of a file.

:Usage: **> send <transport> <filename>**

receive
-------

Get/Set file to receive.

:Usage: **> receive <transport> [filename]**

volume
------

Get/Set transport volume.

:Usage: **> volume <transport> [value]**

RESOURCES
=========

http://www.bluez.org

REPORTING BUGS
==============

linux-bluetooth@vger.kernel.org