aggregator: document new "min-upstream-latency" property is in nanosecs
authorTim-Philipp Müller <tim@centricular.com>
Wed, 3 Oct 2018 23:30:52 +0000 (00:30 +0100)
committerTim-Philipp Müller <tim@centricular.com>
Wed, 3 Oct 2018 23:30:52 +0000 (00:30 +0100)
https://bugzilla.gnome.org/show_bug.cgi?id=797213

libs/gst/base/gstaggregator.c

index 3ea3da2..10d5caf 100644 (file)
@@ -2373,6 +2373,12 @@ gst_aggregator_class_init (GstAggregatorClass * klass)
   /**
    * GstAggregator:min-upstream-latency:
    *
+   * Force minimum upstream latency (in nanoseconds). When sources with a
+   * higher latency are expected to be plugged in dynamically after the
+   * aggregator has started playing, this allows overriding the minimum
+   * latency reported by the initial source(s). This is only taken into
+   * account when larger than the actually reported minimum latency.
+   *
    * Since: 1.16
    */
   g_object_class_install_property (gobject_class, PROP_MIN_UPSTREAM_LATENCY,
@@ -2380,8 +2386,8 @@ gst_aggregator_class_init (GstAggregatorClass * klass)
           "When sources with a higher latency are expected to be plugged "
           "in dynamically after the aggregator has started playing, "
           "this allows overriding the minimum latency reported by the "
-          "initial source(s). This is only taken into account when superior "
-          "to the reported minimum latency.",
+          "initial source(s). This is only taken into account when larger "
+          "than the actually reported minimum latency. (nanoseconds)",
           0, G_MAXUINT64,
           DEFAULT_LATENCY, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));