From 9e9344fe94f8e727169e9a69159599289486e7f2 Mon Sep 17 00:00:00 2001 From: David Schleef Date: Thu, 16 Oct 2003 02:00:07 +0000 Subject: [PATCH] Add doc for GstBin::iterate signal Original commit message from CVS: Add doc for GstBin::iterate signal --- docs/gst/tmpl/gstbin.sgml | 12 ++++++++++++ docs/gst/tmpl/gstpad.sgml | 4 ++++ 2 files changed, 16 insertions(+) diff --git a/docs/gst/tmpl/gstbin.sgml b/docs/gst/tmpl/gstbin.sgml index 985b02b..68c62da 100644 --- a/docs/gst/tmpl/gstbin.sgml +++ b/docs/gst/tmpl/gstbin.sgml @@ -240,3 +240,15 @@ gst_bin_set_pre_iterate_function() and gst_bin_set_post_iterate_function(). @gstbin: the object which received the signal. @arg1: the element that was removed from the bin + + +This signal is emitted when a bin iterates, either automatically or +due to a #gst_bin_iterate() call. The return value is used to +determine if the object method handler processed any data. +In most normal cases, a user-provided signal handler should return +FALSE. + + +@gstbin: the object which received the signal. +@Returns: TRUE if the state of the bin was advanced. + diff --git a/docs/gst/tmpl/gstpad.sgml b/docs/gst/tmpl/gstpad.sgml index a557ac6..49342f1 100644 --- a/docs/gst/tmpl/gstpad.sgml +++ b/docs/gst/tmpl/gstpad.sgml @@ -191,6 +191,8 @@ A function that will be called when chaining buffers. @pad: the #GstPad that performed the chain. +@data: + @buf: the #GstBuffer that is chained. @@ -680,6 +682,8 @@ Flags for the pad. @pad: +@data: + @buf: -- 2.7.4