summaryrefslogtreecommitdiff
path: root/gst-libs/gst
diff options
context:
space:
mode:
authorMatthieu De Beule <matthieu.de@beule.be>2020-10-25 16:39:48 +0000
committerGStreamer Marge Bot <gitlab-merge-bot@gstreamer-foundation.org>2021-04-07 22:54:37 +0000
commitf449a553a76846c27a5cd229a197070e7059071f (patch)
tree03898af1f8003c4fc323bb74317ed06ded158158 /gst-libs/gst
parent98bd83484cb1f0c920da57acf2c7b661dd1ec2af (diff)
downloadgstreamer-plugins-bad-f449a553a76846c27a5cd229a197070e7059071f.tar.gz
Tell programmers that set_volume uses linear scale (fixes https://gitlab.freedesktop.org/gstreamer/gst-plugins-bad/-/issues/1439)
Part-of: <https://gitlab.freedesktop.org/gstreamer/gst-plugins-bad/-/merge_requests/1722>
Diffstat (limited to 'gst-libs/gst')
-rw-r--r--gst-libs/gst/player/gstplayer.c4
1 files changed, 4 insertions, 0 deletions
diff --git a/gst-libs/gst/player/gstplayer.c b/gst-libs/gst/player/gstplayer.c
index a1eea9f58..23a99ae9a 100644
--- a/gst-libs/gst/player/gstplayer.c
+++ b/gst-libs/gst/player/gstplayer.c
@@ -859,6 +859,10 @@ gst_player_get_volume (GstPlayer * self)
* @val: the new volume level, as a percentage between 0 and 1
*
* Sets the volume level of the stream as a percentage between 0 and 1.
+ *
+ * This volume is a linear factor. For showing the volume in a GUI it
+ * might make sense to first convert from a different format. Volume sliders
+ * should usually use a cubic volume. See gst_stream_volume_convert_volume().
*/
void
gst_player_set_volume (GstPlayer * self, gdouble val)