blob: 93251e83f4435c30408eba1c862b116735d8388e [file] [log] [blame]
Gateway hierarchy
Service org.bluez
Interface org.bluez.HandsfreeGateway
Object path [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX
This interface is available for remote devices which can function in the Audio
Gateway role of the HFP profiles. It is intended to be used with external
telephony stacks / handlers of the HFP protocol.
Methods void Connect()
Connect to the AG service on the remote device.
void Disconnect()
Disconnect from the AG service on the remote device
dict GetProperties()
Returns all properties for the interface. See the
properties section for available properties.
void RegisterAgent(object path)
The object path defines the path the of the agent
that will be called when a new Handsfree connection
is established.
If an application disconnects from the bus all of its
registered agents will be removed.
void UnregisterAgent(object path)
This unregisters the agent 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.Failed
Signals PropertyChanged(string name, variant value)
This signal indicates a changed value of the given
Properties string State [readonly]
Indicates the state of the connection. Possible
values are:
HandsfreeAgent hierarchy
Service unique name
Interface org.bluez.HandsfreeAgent
Object path freely definable
Methods void NewConnection(filedescriptor fd)
This method gets called whenever a new handsfree
connection has been established. The objectpath
contains the object path of the remote device. This
method assumes that DBus daemon with file descriptor
passing capability is being used.
The agent should only return successfully once the
establishment of the service level connection (SLC)
has been completed. In the case of Handsfree this
means that BRSF exchange has been performed and
necessary initialization has been done.
Possible Errors: org.bluez.Error.InvalidArguments
void Release()
This method gets called whenever the service daemon
unregisters the agent or whenever the Adapter where
the HandsfreeAgent registers itself is removed.