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'
This commit is contained in:
Tim-Philipp Müller 2016-11-15 18:32:50 +00:00
parent 0c0dfbd455
commit 826eec22f7
2 changed files with 10 additions and 5 deletions

View File

@ -1245,14 +1245,18 @@ gst_app_sink_get_drop (GstAppSink * appsink)
/** /**
* gst_app_sink_set_buffer_list_support: * gst_app_sink_set_buffer_list_support:
* @appsink: a #GstAppSink * @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. * 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 void
gst_app_sink_set_buffer_list_support (GstAppSink * appsink, gst_app_sink_set_buffer_list_support (GstAppSink * appsink,
gboolean buffer_list) gboolean enable_lists)
{ {
GstAppSinkPrivate *priv; GstAppSinkPrivate *priv;
@ -1261,8 +1265,8 @@ gst_app_sink_set_buffer_list_support (GstAppSink * appsink,
priv = appsink->priv; priv = appsink->priv;
g_mutex_lock (&priv->mutex); g_mutex_lock (&priv->mutex);
if (priv->buffer_lists_supported != buffer_list) { if (priv->buffer_lists_supported != enable_lists) {
priv->buffer_lists_supported = buffer_list; priv->buffer_lists_supported = enable_lists;
} }
g_mutex_unlock (&priv->mutex); 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. * Returns: %TRUE if @appsink supports buffer lists.
* *
* Since: 1.12
*/ */
gboolean gboolean
gst_app_sink_get_buffer_list_support (GstAppSink * appsink) gst_app_sink_get_buffer_list_support (GstAppSink * appsink)

View File

@ -117,7 +117,7 @@ guint gst_app_sink_get_max_buffers (GstAppSink *appsink);
void gst_app_sink_set_drop (GstAppSink *appsink, gboolean drop); void gst_app_sink_set_drop (GstAppSink *appsink, gboolean drop);
gboolean gst_app_sink_get_drop (GstAppSink *appsink); 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); gboolean gst_app_sink_get_buffer_list_support (GstAppSink *appsink);
void gst_app_sink_set_wait_on_eos (GstAppSink *appsink, gboolean wait); void gst_app_sink_set_wait_on_eos (GstAppSink *appsink, gboolean wait);