downloadbuffer, multiqueue, queue2: Fix watermark docs

It is not explicitly specified anywhere in the docs that 0% buffering is
at low-watermark and 100% buffering is at high-watermark. It was
specified only in the sources.

diff --git a/plugins/elements/gstdownloadbuffer.c b/plugins/elements/gstdownloadbuffer.c
index 5e898f95b9052b60ddf54081e889d1caaade2d28..ee287b4469039ca8af34e7bfb8d15f17c21f4c4f 100644 (file)
--- a/plugins/elements/gstdownloadbuffer.c
+++ b/plugins/elements/gstdownloadbuffer.c
@@ -232,12 +232,14 @@ gst_download_buffer_class_init (GstDownloadBufferClass * klass)
 
   g_object_class_install_property (gobject_class, PROP_LOW_PERCENT,
       g_param_spec_int ("low-percent", "Low percent",
-          "Low threshold for buffering to start. Only used if use-buffering is True",
+          "Low threshold for buffering to start. "
+          "Emits GST_MESSAGE_BUFFERING with a value of 0%",
           0, 100, DEFAULT_LOW_PERCENT,
           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
   g_object_class_install_property (gobject_class, PROP_HIGH_PERCENT,
       g_param_spec_int ("high-percent", "High percent",
-          "High threshold for buffering to finish. Only used if use-buffering is True",
+          "High threshold for buffering to finish. "
+          "Emits GST_MESSAGE_BUFFERING with a value of 100%",
           0, 100, DEFAULT_HIGH_PERCENT,
           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 

diff --git a/plugins/elements/gstmultiqueue.c b/plugins/elements/gstmultiqueue.c
index 972e7eeb13cc166b474b1c03345a7cf67b68d305..2e765adca5b0befdacc917b18187f7d9d6d84989 100644 (file)
--- a/plugins/elements/gstmultiqueue.c
+++ b/plugins/elements/gstmultiqueue.c
@@ -572,7 +572,8 @@ gst_multi_queue_class_init (GstMultiQueueClass * klass)
    */
   g_object_class_install_property (gobject_class, PROP_USE_BUFFERING,
       g_param_spec_boolean ("use-buffering", "Use buffering",
-          "Emit GST_MESSAGE_BUFFERING based on low-/high-percent thresholds",
+          "Emit GST_MESSAGE_BUFFERING based on low-/high-percent thresholds "
+          "(0% = low-watermark, 100% = high-watermark)",
           DEFAULT_USE_BUFFERING, G_PARAM_READWRITE | GST_PARAM_MUTABLE_PLAYING |
           G_PARAM_STATIC_STRINGS));
   /**

diff --git a/plugins/elements/gstqueue2.c b/plugins/elements/gstqueue2.c
index 041444034c963a681ddd5a413aba3ff8e56e8f4b..d167d21e242d1f5016c0ec17c90434cea7fe5774 100644 (file)
--- a/plugins/elements/gstqueue2.c
+++ b/plugins/elements/gstqueue2.c
@@ -362,7 +362,8 @@ gst_queue2_class_init (GstQueue2Class * klass)
 
   obj_props[PROP_USE_BUFFERING] = g_param_spec_boolean ("use-buffering",
       "Use buffering",
-      "Emit GST_MESSAGE_BUFFERING based on low-/high-percent thresholds",
+      "Emit GST_MESSAGE_BUFFERING based on low-/high-percent thresholds "
+      "(0% = low-watermark, 100% = high-watermark)",
       DEFAULT_USE_BUFFERING,
       G_PARAM_READWRITE | GST_PARAM_MUTABLE_PLAYING | G_PARAM_STATIC_STRINGS);
   obj_props[PROP_USE_TAGS_BITRATE] = g_param_spec_boolean ("use-tags-bitrate",