Home | History | Annotate | Download | only in doc
      1 Gateway hierarchy
      2 ========================
      3 
      4 Service		org.bluez
      5 Interface	org.bluez.HandsfreeGateway
      6 Object path	[variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX
      7 
      8 This interface is available for remote devices which can function in the Audio
      9 Gateway role of the HFP profiles.  It is intended to be used with external
     10 telephony stacks / handlers of the HFP protocol.
     11 
     12 Methods		void Connect()
     13 
     14 			Connect to the AG service on the remote device.
     15 
     16 		void Disconnect()
     17 
     18 			Disconnect from the AG service on the remote device
     19 
     20 		dict GetProperties()
     21 
     22 			Returns all properties for the interface. See the
     23 			properties section for available properties.
     24 
     25 		void RegisterAgent(object path)
     26 
     27 			The object path defines the path the of the agent
     28 			that will be called when a new Handsfree connection
     29 			is established.
     30 
     31 			If an application disconnects from the bus all of its
     32 			registered agents will be removed.
     33 
     34 		void UnregisterAgent(object path)
     35 
     36 			This unregisters the agent that has been previously
     37 			registered. The object path parameter must match the
     38 			same value that has been used on registration.
     39 
     40 			Possible Errors: org.bluez.Error.Failed
     41 					 org.bluez.Error.InvalidArguments
     42 
     43 
     44 Signals		PropertyChanged(string name, variant value)
     45 
     46 			This signal indicates a changed value of the given
     47 			property.
     48 
     49 Properties	string State [readonly]
     50 
     51 			Indicates the state of the connection.  Possible
     52 			values are:
     53 				"disconnected"
     54 				"connecting"
     55 				"connected"
     56 				"playing"
     57 
     58 HandsfreeAgent hierarchy
     59 ===============
     60 
     61 Service         unique name
     62 Interface       org.bluez.HandsfreeAgent
     63 Object path     freely definable
     64 
     65 Methods		void NewConnection(filedescriptor fd)
     66 
     67 			This method gets called whenever a new handsfree
     68 			connection has been established.  The objectpath
     69 			contains the object path of the remote device.  This
     70 			method assumes that DBus daemon with file descriptor
     71 			passing capability is being used.
     72 
     73 			The agent should only return successfully once the
     74 			establishment of the service level connection (SLC)
     75 			has been completed.  In the case of Handsfree this
     76 			means that BRSF exchange has been performed and
     77 			necessary initialization has been done.
     78 
     79 			Possible Errors: org.bluez.Error.InvalidArguments
     80 					 org.bluez.Error.Failed
     81 
     82 		void Release()
     83 
     84 			This method gets called whenever the service daemon
     85 			unregisters the agent or whenever the Adapter where
     86 			the HandsfreeAgent registers itself is removed.
     87