summaryrefslogtreecommitdiff
path: root/doc/profile-api.txt
diff options
context:
space:
mode:
authorMarcel Holtmann <marcel@holtmann.org>2012-11-09 20:19:18 +0100
committerMarcel Holtmann <marcel@holtmann.org>2012-11-09 20:21:45 +0100
commit437959a0b5c3dedef7e50606f8c96c8e84ee12d9 (patch)
tree2e050366bb4d76455cf7fbbc7343e4f7a9c64348 /doc/profile-api.txt
parent33176c1252467f24fcd4971cc45c7c80ec86cb45 (diff)
downloadbluez-437959a0b5c3dedef7e50606f8c96c8e84ee12d9.tar.gz
doc: Create separate Profile Manager interface
Diffstat (limited to 'doc/profile-api.txt')
-rw-r--r--doc/profile-api.txt87
1 files changed, 85 insertions, 2 deletions
diff --git a/doc/profile-api.txt b/doc/profile-api.txt
index d41075045..97b0ea6db 100644
--- a/doc/profile-api.txt
+++ b/doc/profile-api.txt
@@ -1,14 +1,97 @@
BlueZ D-Bus Profile API description
***********************************
-Copyright (C) 2012 Intel Corporation. All rights reserved.
+
+Profile Manager hierarchy
+=========================
+
+Service org.bluez
+Interface org.bluez.ProfileManager1
+Object path /org/bluez
+
+ void RegisterProfile(object profile, string uuid, dict options)
+
+ This registers a profile implementation.
+
+ If an application disconnects from the bus all
+ its registered profiles will be removed.
+
+ HFP HS UUID: 0000111e-0000-1000-8000-00805f9b34fb
+
+ Default RFCOMM channel is 6. And this requires
+ authentication.
+
+ Available options:
+
+ string Name
+
+ Human readable name for the profile
+
+ 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.
+
+ Possible errors: org.bluez.Error.InvalidArguments
+ org.bluez.Error.AlreadyExists
+
+ void UnregisterProfile(object profile)
+
+ This unregisters the profile that has been previously
+ registered. The object path parameter must match the
+ same value that has been used on registration.
+
+ Possible errors: org.bluez.Error.DoesNotExist
Profile hierarchy
=================
Service unique name
-Interface org.bluez.Profile
+Interface org.bluez.Profile1
Object path freely definable
Methods void Release()