diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/design.txt | 13 | ||||
| -rw-r--r-- | doc/headset-api.txt | 97 |
2 files changed, 29 insertions, 81 deletions
diff --git a/doc/design.txt b/doc/design.txt index 4539c56..6fcaa72 100644 --- a/doc/design.txt +++ b/doc/design.txt @@ -17,20 +17,13 @@ | | | is made | | | | |<----------------------| - | | h.GetTransport | On the new device, we - | | | request a transport t. + | | h.Connect | On the new device, we + | | | can get fd to read/write | | | | | | | |<----------------------| - | | t.Acquire | We get fd to read/write + | | h.Disconnect | | | | - | | | - | |<----------------------| - | | t.Release | - | | | - | | | - | |<----------------------| - | | h.ReleaseTransport | |--------------------->| | | RequestDisconnection | | | | | Release all transport diff --git a/doc/headset-api.txt b/doc/headset-api.txt index c27228c..01e2eeb 100644 --- a/doc/headset-api.txt +++ b/doc/headset-api.txt @@ -51,37 +51,6 @@ Signals DeviceAdded(object path, dict properties) signal and only emitted for reference. -Headset Agent hierarchy -======================= - -Service <freely defined> -Interface org.freedesktop.HeadsetAgent -Object path <freely defined> - - The Agent is used to take control of the rfcomm connection of - a Headset. When no Agent is registered, the Headset daemon - will manage the rfcomm channel itself. - -Methods bool NewConnection(object device, fd rfcomm, dict properties) - - Notify the agent that a new device is connected. The Agent - returns True if it will use the rfcomm fd. - When all registered Agents return False, headsetd will - manage the rfcomm instead. - - Possible Errors: [service].Error.NotAuthorized - [service].Error.Failed - - void RequestDisconnection(object device) - - Notify the agent that the connection with the device - ended. - - void Release() - - Notifies the Agent that it is no longer registered - - Headset hierarchy ================= @@ -89,70 +58,56 @@ Service org.freedesktop.Headset Interface org.freedesktop.Headset Object path [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX -Methods object GetTransport(dict properties) - - Get a Transport Object for the given properties - - Possible Errors: [service].Error.NotAuthorized - [service].Error.Failed - - void ReleaseTransport(object transport) - - Releases transport descriptor. - -Properties object Device [readonly] - - The bluetooth Device object. +Methods dict Connect (dict properties) + Acquire transport file descriptor and the MTU for read + and write respectively. -HeadsetTransport hierarchy -========================== + Requires a dictionary with: -Service org.freedesktop.Headset -Interface org.freedesktop.HeadsetTransport -Object path [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX/fdX + codec: the requested codec -Methods fd, uint16, uint16 Acquire() + Returns a dictionary with at least: - Acquire transport file descriptor and the MTU for read - and write respectively. + fd: file descriptor + mtu_r: MTU for reading + mtu_w: MTU for writing + codec: the codec in use Possible Errors: [service].Error.NotAuthorized [service].Error.Failed - void Release() + void Disconnect() Releases file descriptor. -Properties object Device [readonly] - - The Device object. - - string UUID [readonly] + Possible Errors: [service].Error.NotAuthorized + [service].Error.Failed - UUID of the profile which this transport is for. - byte Codec [readonly] +Properties object Device [readonly] - Assigned number of codec that the transport support. - The values should match the profile specification which - is indicated by the UUID. + The bluetooth Device object. string State [readonly] Indicates the state of the transport. Possible values are: "idle": not streaming - "pending": streaming but not acquired - "active": streaming and acquired + "pending": connecting + "active": connected and streaming - uint16 Delay [readwrite] - Optional. Transport delay in 1/10 of millisecond, this - property is only writeable when the transport was - acquired by the sender. - byte MicrophoneGain [readwrite] +HeadsetVolume hierarchy +======================= + +Service org.freedesktop.Headset +Interface org.freedesktop.HeadsetVolume +Object path [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX + + +Properties byte MicrophoneGain [readwrite] Optional. Indicates volume level of the transport's incoming audio stream. This |