summaryrefslogtreecommitdiff
path: root/libs/gst/base/gstcollectpads.c
diff options
context:
space:
mode:
authorJan Schmidt <thaytan@noraisin.net>2012-10-30 10:04:44 +1100
committerJan Schmidt <thaytan@noraisin.net>2012-10-30 10:04:44 +1100
commitb674a737b039ab01b5fec91554b959d68376126b (patch)
tree337c2aba13f326afd7196740833df85be82add96 /libs/gst/base/gstcollectpads.c
parent698324d48be675cd5b68f286bbae5b0783366ecc (diff)
collectpads: Clarify docs about the buffer handler callback.
Clarify that the callback owns a ref on a passed buffer.
Diffstat (limited to 'libs/gst/base/gstcollectpads.c')
-rw-r--r--libs/gst/base/gstcollectpads.c4
1 files changed, 3 insertions, 1 deletions
diff --git a/libs/gst/base/gstcollectpads.c b/libs/gst/base/gstcollectpads.c
index 9c9b0037fc..a4e039539b 100644
--- a/libs/gst/base/gstcollectpads.c
+++ b/libs/gst/base/gstcollectpads.c
@@ -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.
*/