summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim-Philipp Müller <tim@centricular.com>2016-11-15 18:32:50 +0000
committerTim-Philipp Müller <tim@centricular.com>2016-11-15 18:38:48 +0000
commit826eec22f72903c83ea87364b31fb3edfe9899cb (patch)
tree4182991441963dbf2cafc43fbbbf668f44ce6525
parent0c0dfbd45521498b8242150f35f568695ea034d1 (diff)
appsink: fix g-i warnings and add since markers
Rename function parameter and make sure the name in the declaration matches the name in the implementation, to avoid g-i warnings. Also add Since markers for gtk-doc. gstappsink.c:1248: Warning: GstApp: gst_app_sink_set_buffer_list_support: unknown parameter 'buffer_list' in documentation comment, should be 'drop'
-rw-r--r--gst-libs/gst/app/gstappsink.c13
-rw-r--r--gst-libs/gst/app/gstappsink.h2
2 files changed, 10 insertions, 5 deletions
diff --git a/gst-libs/gst/app/gstappsink.c b/gst-libs/gst/app/gstappsink.c
index 46ab5829e..9ce4c29a6 100644
--- a/gst-libs/gst/app/gstappsink.c
+++ b/gst-libs/gst/app/gstappsink.c
@@ -1245,14 +1245,18 @@ gst_app_sink_get_drop (GstAppSink * appsink)
/**
* gst_app_sink_set_buffer_list_support:
* @appsink: a #GstAppSink
- * @buffer_list: enable or disable buffer list support
+ * @enable_lists: enable or disable buffer list support
*
* Instruct @appsink to enable or disable buffer list support.
*
+ * For backwards-compatibility reasons applications need to opt in
+ * to indicate that they will be able to handle buffer lists.
+ *
+ * Since: 1.12
*/
void
gst_app_sink_set_buffer_list_support (GstAppSink * appsink,
- gboolean buffer_list)
+ gboolean enable_lists)
{
GstAppSinkPrivate *priv;
@@ -1261,8 +1265,8 @@ gst_app_sink_set_buffer_list_support (GstAppSink * appsink,
priv = appsink->priv;
g_mutex_lock (&priv->mutex);
- if (priv->buffer_lists_supported != buffer_list) {
- priv->buffer_lists_supported = buffer_list;
+ if (priv->buffer_lists_supported != enable_lists) {
+ priv->buffer_lists_supported = enable_lists;
}
g_mutex_unlock (&priv->mutex);
}
@@ -1275,6 +1279,7 @@ gst_app_sink_set_buffer_list_support (GstAppSink * appsink,
*
* Returns: %TRUE if @appsink supports buffer lists.
*
+ * Since: 1.12
*/
gboolean
gst_app_sink_get_buffer_list_support (GstAppSink * appsink)
diff --git a/gst-libs/gst/app/gstappsink.h b/gst-libs/gst/app/gstappsink.h
index bd2639908..4bc6d392a 100644
--- a/gst-libs/gst/app/gstappsink.h
+++ b/gst-libs/gst/app/gstappsink.h
@@ -117,7 +117,7 @@ guint gst_app_sink_get_max_buffers (GstAppSink *appsink);
void gst_app_sink_set_drop (GstAppSink *appsink, gboolean drop);
gboolean gst_app_sink_get_drop (GstAppSink *appsink);
-void gst_app_sink_set_buffer_list_support (GstAppSink *appsink, gboolean drop);
+void gst_app_sink_set_buffer_list_support (GstAppSink *appsink, gboolean enable_lists);
gboolean gst_app_sink_get_buffer_list_support (GstAppSink *appsink);
void gst_app_sink_set_wait_on_eos (GstAppSink *appsink, gboolean wait);