audiobasesrc: Explicitly document that buffer-time and latency-time may be ignored

This commit is contained in:
Nirbheek Chauhan 2014-12-27 14:44:51 +05:30 committed by Sebastian Dröge
parent 68fcf7ef52
commit 54e4baa523

View file

@ -169,14 +169,17 @@ gst_audio_base_src_class_init (GstAudioBaseSrcClass * klass)
g_param_spec_int64 ("buffer-time", "Buffer Time", g_param_spec_int64 ("buffer-time", "Buffer Time",
"Size of audio buffer in microseconds. This is the maximum amount " "Size of audio buffer in microseconds. This is the maximum amount "
"of data that is buffered in the device and the maximum latency that " "of data that is buffered in the device and the maximum latency that "
"the source reports", 1, G_MAXINT64, DEFAULT_BUFFER_TIME, "the source reports. This value might be ignored by the element if "
"necessary; see \"actual-buffer-time\"",
1, G_MAXINT64, DEFAULT_BUFFER_TIME,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
g_object_class_install_property (gobject_class, PROP_LATENCY_TIME, g_object_class_install_property (gobject_class, PROP_LATENCY_TIME,
g_param_spec_int64 ("latency-time", "Latency Time", g_param_spec_int64 ("latency-time", "Latency Time",
"The minimum amount of data to read in each iteration in " "The minimum amount of data to read in each iteration in "
"microseconds. This is the minimum latency that the source reports", "microseconds. This is the minimum latency that the source reports. "
1, G_MAXINT64, DEFAULT_LATENCY_TIME, "This value might be ignored by the element if necessary; see "
"\"actual-latency-time\"", 1, G_MAXINT64, DEFAULT_LATENCY_TIME,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/** /**