aggregator: Document that the latency is in ns

This commit is contained in:
Olivier Crête 2015-06-01 18:50:14 -04:00 committed by Tim-Philipp Müller
parent b16697d286
commit 0a35f550b2

View file

@ -1591,7 +1591,7 @@ gst_aggregator_finalize (GObject * object)
/* /*
* gst_aggregator_set_latency_property: * gst_aggregator_set_latency_property:
* @agg: a #GstAggregator * @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 * 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 * 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", g_param_spec_int64 ("latency", "Buffer latency",
"Additional latency in live mode to allow upstream " "Additional latency in live mode to allow upstream "
"to take longer to produce buffers for the current " "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), (G_MAXLONG == G_MAXINT64) ? G_MAXINT64 : (G_MAXLONG * GST_SECOND - 1),
DEFAULT_LATENCY, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); DEFAULT_LATENCY, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));