collectpads: Clarify docs about the buffer handler callback.
authorJan Schmidt <thaytan@noraisin.net>
Mon, 29 Oct 2012 23:04:44 +0000 (10:04 +1100)
committerJan Schmidt <thaytan@noraisin.net>
Mon, 29 Oct 2012 23:04:44 +0000 (10:04 +1100)
Clarify that the callback owns a ref on a passed buffer.

libs/gst/base/gstcollectpads.c

index 9c9b003..a4e0395 100644 (file)
@@ -318,7 +318,9 @@ gst_collect_pads_set_buffer_function_locked (GstCollectPads * pads,
  * @user_data: (closure): user data passed to the function
  *
  * Set the callback function and user data that will be called with
- * the oldest buffer when all pads have been collected.
+ * the oldest buffer when all pads have been collected, or NULL on EOS.
+ * If a buffer is passed, the callback owns a reference and must unref
+ * it.
  *
  * MT safe.
  */