Blame doc/profile-api.txt

Packit 34410b
BlueZ D-Bus Profile API description
Packit 34410b
***********************************
Packit 34410b
Packit 34410b
Packit 34410b
Profile Manager hierarchy
Packit 34410b
=========================
Packit 34410b
Packit 34410b
Service		org.bluez
Packit 34410b
Interface	org.bluez.ProfileManager1
Packit 34410b
Object path	/org/bluez
Packit 34410b
Packit 34410b
		void RegisterProfile(object profile, string uuid, dict options)
Packit 34410b
Packit 34410b
			This registers a profile implementation.
Packit 34410b
Packit 34410b
			If an application disconnects from the bus all
Packit 34410b
			its registered profiles will be removed.
Packit 34410b
Packit 34410b
			HFP HS UUID: 0000111e-0000-1000-8000-00805f9b34fb
Packit 34410b
Packit 34410b
				Default RFCOMM channel is 6. And this requires
Packit 34410b
				authentication.
Packit 34410b
Packit 34410b
			Available options:
Packit 34410b
Packit 34410b
				string Name
Packit 34410b
Packit 34410b
					Human readable name for the profile
Packit 34410b
Packit 34410b
				string Service
Packit 34410b
Packit 34410b
					The primary service class UUID
Packit 34410b
					(if different from the actual
Packit 34410b
					 profile UUID)
Packit 34410b
Packit 34410b
				string Role
Packit 34410b
Packit 34410b
					For asymmetric profiles that do not
Packit 34410b
					have UUIDs available to uniquely
Packit 34410b
					identify each side this
Packit 34410b
					parameter allows specifying the
Packit 34410b
					precise local role.
Packit 34410b
Packit 34410b
					Possible values: "client", "server"
Packit 34410b
Packit 34410b
				uint16 Channel
Packit 34410b
Packit 34410b
					RFCOMM channel number that is used
Packit 34410b
					for client and server UUIDs.
Packit 34410b
Packit 34410b
					If applicable it will be used in the
Packit 34410b
					SDP record as well.
Packit 34410b
Packit 34410b
				uint16 PSM
Packit 34410b
Packit 34410b
					PSM number that is used for client
Packit 34410b
					and server UUIDs.
Packit 34410b
Packit 34410b
					If applicable it will be used in the
Packit 34410b
					SDP record as well.
Packit 34410b
Packit 34410b
				boolean RequireAuthentication
Packit 34410b
Packit 34410b
					Pairing is required before connections
Packit 34410b
					will be established. No devices will
Packit 34410b
					be connected if not paired.
Packit 34410b
Packit 34410b
				boolean RequireAuthorization
Packit 34410b
Packit 34410b
					Request authorization before any
Packit 34410b
					connection will be established.
Packit 34410b
Packit 34410b
				boolean AutoConnect
Packit 34410b
Packit 34410b
					In case of a client UUID this will
Packit 34410b
					force connection of the RFCOMM or
Packit 34410b
					L2CAP channels when a remote device
Packit 34410b
					is connected.
Packit 34410b
Packit 34410b
				string ServiceRecord
Packit 34410b
Packit 34410b
					Provide a manual SDP record.
Packit 34410b
Packit 34410b
				uint16 Version
Packit 34410b
Packit 34410b
					Profile version (for SDP record)
Packit 34410b
Packit 34410b
				uint16 Features
Packit 34410b
Packit 34410b
					Profile features (for SDP record)
Packit 34410b
Packit 34410b
			Possible errors: org.bluez.Error.InvalidArguments
Packit 34410b
			                 org.bluez.Error.AlreadyExists
Packit 34410b
Packit 34410b
		void UnregisterProfile(object profile)
Packit 34410b
Packit 34410b
			This unregisters the profile that has been previously
Packit 34410b
			registered. The object path parameter must match the
Packit 34410b
			same value that has been used on registration.
Packit 34410b
Packit 34410b
			Possible errors: org.bluez.Error.DoesNotExist
Packit 34410b
Packit 34410b
Packit 34410b
Profile hierarchy
Packit 34410b
=================
Packit 34410b
Packit 34410b
Service		unique name
Packit 34410b
Interface	org.bluez.Profile1
Packit 34410b
Object path	freely definable
Packit 34410b
Packit 34410b
Methods		void Release() [noreply]
Packit 34410b
Packit 34410b
			This method gets called when the service daemon
Packit 34410b
			unregisters the profile. A profile can use it to do
Packit 34410b
			cleanup tasks. There is no need to unregister the
Packit 34410b
			profile, because when this method gets called it has
Packit 34410b
			already been unregistered.
Packit 34410b
Packit 34410b
		void NewConnection(object device, fd, dict fd_properties)
Packit 34410b
Packit 34410b
			This method gets called when a new service level
Packit 34410b
			connection has been made and authorized.
Packit 34410b
Packit 34410b
			Common fd_properties:
Packit 34410b
Packit 34410b
			uint16 Version		Profile version (optional)
Packit 34410b
			uint16 Features		Profile features (optional)
Packit 34410b
Packit 34410b
			Possible errors: org.bluez.Error.Rejected
Packit 34410b
			                 org.bluez.Error.Canceled
Packit 34410b
Packit 34410b
		void RequestDisconnection(object device)
Packit 34410b
Packit 34410b
			This method gets called when a profile gets
Packit 34410b
			disconnected.
Packit 34410b
Packit 34410b
			The file descriptor is no longer owned by the service
Packit 34410b
			daemon and the profile implementation needs to take
Packit 34410b
			care of cleaning up all connections.
Packit 34410b
Packit 34410b
			If multiple file descriptors are indicated via
Packit 34410b
			NewConnection, it is expected that all of them
Packit 34410b
			are disconnected before returning from this
Packit 34410b
			method call.
Packit 34410b
Packit 34410b
			Possible errors: org.bluez.Error.Rejected
Packit 34410b
			                 org.bluez.Error.Canceled