aboutsummaryrefslogtreecommitdiff
path: root/src/mixer_plugin.h
diff options
context:
space:
mode:
authorMax Kellermann <max@duempel.org>2009-10-23 10:32:25 +0200
committerMax Kellermann <max@duempel.org>2009-10-23 10:32:25 +0200
commitc4f895daf4bcfcda2ea892896f999911f37cec26 (patch)
tree4d6117f7acdce32a1ea9a9c535c331c0699e88f5 /src/mixer_plugin.h
parentede828c910f546dfe8ca4b07b678e9a2806c6889 (diff)
mixer_plugin: get_volume() may return -1 if unavailable
If the method get_volume() returns -1 and no error object is set, then the volume is currently unavailable, but the mixer should not be closed immediately.
Diffstat (limited to 'src/mixer_plugin.h')
-rw-r--r--src/mixer_plugin.h4
1 files changed, 2 insertions, 2 deletions
diff --git a/src/mixer_plugin.h b/src/mixer_plugin.h
index 648c3280..b6e67e8f 100644
--- a/src/mixer_plugin.h
+++ b/src/mixer_plugin.h
@@ -72,8 +72,8 @@ struct mixer_plugin {
*
* @param error_r location to store the error occuring, or
* NULL to ignore errors
- * @return the current volume (0..100 including) or -1 on
- * error
+ * @return the current volume (0..100 including) or -1 if
+ * unavailable or on error (error_r set, mixer will be closed)
*/
int (*get_volume)(struct mixer *mixer, GError **error_r);