diff options
| author | Wim Taymans <wim.taymans@collabora.co.uk> | 2012-09-14 16:06:50 +0200 |
|---|---|---|
| committer | Wim Taymans <wim.taymans@collabora.co.uk> | 2012-09-14 16:08:50 +0200 |
| commit | a57198a0bad8112150e8f7c08889057d9c791869 (patch) | |
| tree | 62b193e6d4a86a050fea6c49dba56bf4672fc319 /gst-libs/gst/audio | |
| parent | 6e33f2d46467c3a1313a5d6e9a52b48eb6d03168 (diff) | |
audio: improve property description
Improve the description of the latency-time and buffer-time properties in the
audio sink and source.
Diffstat (limited to 'gst-libs/gst/audio')
| -rw-r--r-- | gst-libs/gst/audio/gstaudiobasesink.c | 8 | ||||
| -rw-r--r-- | gst-libs/gst/audio/gstaudiobasesrc.c | 8 |
2 files changed, 9 insertions, 7 deletions
diff --git a/gst-libs/gst/audio/gstaudiobasesink.c b/gst-libs/gst/audio/gstaudiobasesink.c index 42ce288aa..d9c2901c3 100644 --- a/gst-libs/gst/audio/gstaudiobasesink.c +++ b/gst-libs/gst/audio/gstaudiobasesink.c @@ -208,14 +208,14 @@ gst_audio_base_sink_class_init (GstAudioBaseSinkClass * klass) g_object_class_install_property (gobject_class, PROP_BUFFER_TIME, g_param_spec_int64 ("buffer-time", "Buffer Time", - "Size of audio buffer in microseconds", 1, - G_MAXINT64, DEFAULT_BUFFER_TIME, + "Size of audio buffer in microseconds, this is the minimum " + "latency that the sink reports", 1, G_MAXINT64, DEFAULT_BUFFER_TIME, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); g_object_class_install_property (gobject_class, PROP_LATENCY_TIME, g_param_spec_int64 ("latency-time", "Latency Time", - "Audio latency in microseconds", 1, - G_MAXINT64, DEFAULT_LATENCY_TIME, + "The minimum amount of data to write in each iteration in microseconds", + 1, G_MAXINT64, DEFAULT_LATENCY_TIME, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); g_object_class_install_property (gobject_class, PROP_PROVIDE_CLOCK, diff --git a/gst-libs/gst/audio/gstaudiobasesrc.c b/gst-libs/gst/audio/gstaudiobasesrc.c index d6c956ca3..3e91bf214 100644 --- a/gst-libs/gst/audio/gstaudiobasesrc.c +++ b/gst-libs/gst/audio/gstaudiobasesrc.c @@ -165,13 +165,15 @@ gst_audio_base_src_class_init (GstAudioBaseSrcClass * klass) g_object_class_install_property (gobject_class, PROP_BUFFER_TIME, g_param_spec_int64 ("buffer-time", "Buffer Time", - "Size of audio buffer in microseconds", 1, - G_MAXINT64, DEFAULT_BUFFER_TIME, + "Size of audio buffer in microseconds, this is the maximum amount " + "of data that is buffered in the device and the maximum latency that " + "the source reports", 1, G_MAXINT64, DEFAULT_BUFFER_TIME, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); g_object_class_install_property (gobject_class, PROP_LATENCY_TIME, g_param_spec_int64 ("latency-time", "Latency Time", - "Audio latency in microseconds", 1, + "The minimum amount of data to read in each iteration in microseconds, " + "this is the minimum latency that the source reports", 1, G_MAXINT64, DEFAULT_LATENCY_TIME, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); |