diff options
| author | Mikel Astiz <mikel.astiz@bmw-carit.de> | 2013-01-08 10:41:05 +0100 |
|---|---|---|
| committer | Johan Hedberg <johan.hedberg@intel.com> | 2013-01-08 13:56:18 +0200 |
| commit | ba01ee9c89e27e39b2cfe44fb627a85afef231a1 (patch) | |
| tree | e08d20f5ec22d32e4200e8a56cb39a7d76b3fcc2 /doc/media-api.txt | |
| parent | a9a177ff820a8d1f3645c89d7e2f4c682b4f3efe (diff) | |
| download | bluez-ba01ee9c89e27e39b2cfe44fb627a85afef231a1.tar.gz | |
media: Clarify Acquire/TryAcquire error cases
Document the reported errors for Acquire() and TryAcquire(). For the
later, make sure a specific error in guaranteed for the typical scenario
of audio not streaming.
Diffstat (limited to 'doc/media-api.txt')
| -rw-r--r-- | doc/media-api.txt | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/doc/media-api.txt b/doc/media-api.txt index cdde6ea84..bb5ced0db 100644 --- a/doc/media-api.txt +++ b/doc/media-api.txt @@ -321,12 +321,20 @@ Methods fd, uint16, uint16 Acquire() Acquire transport file descriptor and the MTU for read and write respectively. + Possible Errors: org.bluez.Error.NotAuthorized + org.bluez.Error.Failed + fd, uint16, uint16 TryAcquire() Acquire transport file descriptor only if the transport is in "pending" state at the time the message is received by BlueZ. Otherwise no request will be sent - to the remote device and the function will just fail. + to the remote device and the function will just fail + with org.bluez.Error.NotAvailable. + + Possible Errors: org.bluez.Error.NotAuthorized + org.bluez.Error.Failed + org.bluez.Error.NotAvailable void Release() |