diff options
author | samr7 <samr7@126591fb-c623-4b62-a76d-97a8e4f34109> | 2008-11-30 11:31:53 +0000 |
---|---|---|
committer | samr7 <samr7@126591fb-c623-4b62-a76d-97a8e4f34109> | 2008-11-30 11:31:53 +0000 |
commit | fbd4578983f7f95752f87ab394ebda04312be789 (patch) | |
tree | 12fb0d90fa4461e7458bc72847ce7fc62032e11f | |
parent | e2f2a2bef6ff450ea4fe08b8ec42740c0c1f02f5 (diff) | |
download | nohands-fbd4578983f7f95752f87ab394ebda04312be789.tar.gz |
Add ScoEnabled.
Note that certain SoundIo methods bind the stream to the caller.
Misc. minor improvements.
git-svn-id: http://nohands.svn.sourceforge.net/svnroot/nohands/trunk@52 126591fb-c623-4b62-a76d-97a8e4f34109
-rw-r--r-- | data/hfpd-dbus-doc.cs | 45 |
1 files changed, 43 insertions, 2 deletions
diff --git a/data/hfpd-dbus-doc.cs b/data/hfpd-dbus-doc.cs index ce31886..58ef717 100644 --- a/data/hfpd-dbus-doc.cs +++ b/data/hfpd-dbus-doc.cs @@ -95,7 +95,8 @@ * @section property D-Bus Properties * * HFPD D-Bus objects make extensive use of the standard D-Bus properties - * interface, @c org.freedesktop.DBus.Properties. Ideally, one would + * interface, <a href="http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-properties"> + * org.freedesktop.DBus.Properties</a>. Ideally, one would * expect a D-Bus language binding for an object-oriented language to * expose properties as simple data members of the proxy objects. * For example, in Python, the following would make a lot of sense to @@ -297,7 +298,8 @@ namespace net.sf.nohands.hfpd { * - Claimed devices may open an audio connection at any * time. They will not be automatically attached to the * audio pump and routed through the local sound card -- - * this must be explicitly configured by the D-Bus client. + * this must be explicitly configured by the D-Bus client, + * typically using SoundIo.AudioGatewayStart(). * * When HFPD starts, no devices are claimed. The D-Bus * client must enumerate the list of devices it wishes to @@ -557,6 +559,27 @@ namespace net.sf.nohands.hfpd { bool AcceptUnknown; /** + * @brief Property controlling whether SCO audio + * functionality will be used. + * + * This property can be accessed using the + * @ref property "standard D-Bus property interface". + * + * If @c true, SCO audio support is enabled. This allows + * voice audio data to be exchanged over Bluetooth, and + * is the default. + * + * If @c false, SCO audio will not be used. This may + * permit hfpd to operate in environments where another + * service provides support for streaming SCO audio to + * the local sound card. + * + * @note ScoEnabled is a persistent option that is + * saved to the HFPD configuration file. + */ + bool ScoEnabled; + + /** * @brief Property controlling handling of audio connections * for unclaimed devices * @@ -895,6 +918,12 @@ namespace net.sf.nohands.hfpd { * * @throw net.sf.nohands.hfpd.Error Thrown on any * sort of error, unspecific of the reason of failure. + * + * @note A stream started using this method is bound to + * the D-Bus client that made the method call. If that + * D-Bus client is disconnected from D-Bus before the + * stream is halted, the stream will be automatically + * halted, to clean up after the D-Bus client. */ public FileStart(in string file_path, in bool write); @@ -915,6 +944,12 @@ namespace net.sf.nohands.hfpd { * * @throw net.sf.nohands.hfpd.Error Thrown on any * sort of error, unspecific of the reason of failure. + * + * @note A stream started using this method is bound to + * the D-Bus client that made the method call. If that + * D-Bus client is disconnected from D-Bus before the + * stream is halted, the stream will be automatically + * halted, to clean up after the D-Bus client. */ public LoopbackStart(); @@ -951,6 +986,12 @@ namespace net.sf.nohands.hfpd { * * @throw net.sf.nohands.hfpd.Error Thrown on any * sort of error, unspecific of the reason of failure. + * + * @note A stream started using this method is bound to + * the D-Bus client that made the method call. If that + * D-Bus client is disconnected from D-Bus before the + * stream is halted, the stream will be automatically + * halted, to clean up after the D-Bus client. */ public MembufStart(in bool capture, in bool playback, in uint32 membuf_size, |