Blob: org.bluez.ProfileManager.rst

Blob id: bde179f69e69c1c0295f78baa7d3cc19110f5d7d

Size: 3.2 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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
========================
org.bluez.ProfileManager
========================

--------------------------------------------
BlueZ D-Bus ProfileManager API documentation
--------------------------------------------

:Version: BlueZ
:Date: October 2023
:Manual section: 5
:Manual group: Linux System Administration

Interface
=========

:Service:	org.bluez
:Interface:	org.bluez.ProfileManager1
:Object path:	/org/bluez

Methods
-------

void RegisterProfile(object profile, string uuid, dict options)
```````````````````````````````````````````````````````````````

Registers profile agent.

The object path defines the path of the profile that will be called when there
is a connection and must implement **org.bluez.Profile(5)** interface.

If an application disconnects from the bus all its registered profiles will be
removed.

Possible uuid values:

:"0000111f-0000-1000-8000-00805f9b34fb":

	HFP AG, default profile Version is 1.7, profile Features is 0b001001 and
	RFCOMM channel is 13. Authentication is required.

:"0000111e-0000-1000-8000-00805f9b34fb":

	HFP HS, default profile Version is 1.7, profile Features is 0b000000 and
	RFCOMM channel is 7. Authentication is required.

:"00001112-0000-1000-8000-00805f9b34fb":

	HSP AG, default profile Version is 1.2, RFCOMM channel is 12 and
	Authentication is required. Does not support any Features, option is
	ignored.

:"00001108-0000-1000-8000-00805f9b34fb":

	HSP HS, default profile Version is 1.2, profile Features is 0b0 and
	RFCOMM channel is 6. Authentication is required.

	Features is one bit value, specify capability of Remote Audio Volume
	Control (by default turned off).

:"<vendor UUID>":

	Vendor defined UUID, no defaults, must set options.

Possible options values:

:string Name:

	Human readable name for the profile

:string Service:

	The primary service class UUID (if different from the actual profile
	UUID).

:string Role:

	For asymmetric profiles that do not have UUIDs available to uniquely
	identify each side this parameter allows specifying the precise local
	role.

	Possible values:

	:"client":
	:"server":

:uint16 Channel:

	RFCOMM channel number that is used for client and server UUIDs.

	If applicable it will be used in the SDP record as well.

:uint16 PSM:

	PSM number that is used for client and server UUIDs.

	If applicable it will be used in the SDP record as well.

:boolean RequireAuthentication:

	Pairing is required before connections will be established.

	No devices will be connected if not paired.

:boolean RequireAuthorization:

	Request authorization before any connection will be established.

:boolean AutoConnect:

	In case of a client UUID this will force connection of the RFCOMM or
	L2CAP channels when a remote device is connected.

:string ServiceRecord:

	Provide a manual SDP record.

:uint16 Version:

	Profile version (for SDP record)

:uint16 Features:

	Profile features (for SDP record)

Possible errors:

:org.bluez.Error.InvalidArguments:
:org.bluez.Error.AlreadyExists:

void UnregisterProfile(object profile)
``````````````````````````````````````

Unregisters profile object that has been previously registered using
**RegisterProfile**.

The object path parameter must match the same value that has been used on
registration.

Possible errors:

:org.bluez.Error.DoesNotExist: