diff options
| author | Marcel Holtmann <marcel@holtmann.org> | 2007-05-10 08:45:28 +0000 |
|---|---|---|
| committer | Marcel Holtmann <marcel@holtmann.org> | 2007-05-10 08:45:28 +0000 |
| commit | 07958fc3612225ceeffcbbcbae320a2bedcd774d (patch) | |
| tree | ff6df0369f638518d032a9fa073323a7a568936a | |
| parent | 60709fc61959f4ead3e305a0de2cd2419c41e8b4 (diff) | |
Update API descriptions
| -rw-r--r-- | audio/audio-api.txt | 1 | ||||
| -rw-r--r-- | input/input-api.txt | 2 | ||||
| -rw-r--r-- | network/network-api.txt | 18 | ||||
| -rw-r--r-- | serial/serial-api.txt | 5 |
4 files changed, 13 insertions, 13 deletions
diff --git a/audio/audio-api.txt b/audio/audio-api.txt index 497c6cb6..33dd17c5 100644 --- a/audio/audio-api.txt +++ b/audio/audio-api.txt @@ -114,4 +114,3 @@ Signals void AnswerRequested() void MicrophoneGainChanged(uint16 gain) The microphone gain changed. - diff --git a/input/input-api.txt b/input/input-api.txt index a4425914..60066eb9 100644 --- a/input/input-api.txt +++ b/input/input-api.txt @@ -86,5 +86,3 @@ Methods string GetAddress() Signals void Connected() void Disconnected() - - diff --git a/network/network-api.txt b/network/network-api.txt index d939d8a1..f88679d6 100644 --- a/network/network-api.txt +++ b/network/network-api.txt @@ -12,7 +12,7 @@ Object path /org/bluez/network Methods string CreateServer(string uuid) - Creates a network server object(GN or NAP). + Creates a network server object (GN or NAP). Possible errors:org.bluez.network.Error.AlreadyExists org.bluez.network.Error.NotSupported @@ -74,6 +74,7 @@ Signals void ConnectionRemoved(string path) + Network Server hierarchy (experimental) ======================================= @@ -82,7 +83,8 @@ Object path /org/bluez/network/server* Methods string GetUUID() - Returns the uuid 128 string representation of the server. + Returns the UUID-128 string representation of + the server. void Enable() @@ -126,12 +128,11 @@ Methods string GetUUID() Returns the server properties. -Signals - - void Enabled() +Signals void Enabled() void Disabled() + Network Connection hierarchy (experimental) =========================================== @@ -167,7 +168,8 @@ Methods string GetAddress() string Connect() - Connects to host and return the network interface created. + Connects to host and return the network interface + created. Possible errors:org.bluez.network.Error.ConnectionAttemptFailed org.bluez.network.Error.Failed @@ -186,8 +188,6 @@ Methods string GetAddress() Returns the connection properties. -Signals - - void Connected() +Signals void Connected() void Disconnected() diff --git a/serial/serial-api.txt b/serial/serial-api.txt index cbd8e667..9b1c67a3 100644 --- a/serial/serial-api.txt +++ b/serial/serial-api.txt @@ -53,6 +53,7 @@ Signals void PortCreated(string path) [experimental] void ServiceDisconnected(string device) + Port hierarchy (experimental) ============================= @@ -60,11 +61,13 @@ Interface org.bluez.serial.Port Object path /org/bluez/serial/port* Methods string GetAddress() + Returns the Bluetooth address of the ending point. string Connect() - Connects to remote device associated to the port object. + Connects to remote device associated to the port + object. Possible errors:org.bluez.serial.Error.ConnectionAttemptFailed org.bluez.serial.Error.Failed |