aggregator: Document that the latency is in ns
authorOlivier Crête <olivier.crete@collabora.com>
Mon, 1 Jun 2015 22:50:14 +0000 (18:50 -0400)
committerTim-Philipp Müller <tim@centricular.com>
Sat, 2 Dec 2017 15:10:26 +0000 (15:10 +0000)
libs/gst/base/gstaggregator.c

index bd08db6..095be73 100644 (file)
@@ -1591,7 +1591,7 @@ gst_aggregator_finalize (GObject * object)
 /*
  * gst_aggregator_set_latency_property:
  * @agg: a #GstAggregator
- * @latency: the new latency value.
+ * @latency: the new latency value (in nanoseconds).
  *
  * Sets the new latency value to @latency. This value is used to limit the
  * amount of time a pad waits for data to appear before considering the pad
@@ -1737,7 +1737,7 @@ gst_aggregator_class_init (GstAggregatorClass * klass)
       g_param_spec_int64 ("latency", "Buffer latency",
           "Additional latency in live mode to allow upstream "
           "to take longer to produce buffers for the current "
-          "position", 0,
+          "position (in nanoseconds)", 0,
           (G_MAXLONG == G_MAXINT64) ? G_MAXINT64 : (G_MAXLONG * GST_SECOND - 1),
           DEFAULT_LATENCY, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));