gstreamer_core/gst/gstiterator.h
changeset 8 4a7fac7dd34a
parent 0 0e761a78d257
child 30 7e817e7e631c
equal deleted inserted replaced
7:71e347f905f2 8:4a7fac7dd34a
    49  * GstIteratorItem:
    49  * GstIteratorItem:
    50  * @GST_ITERATOR_ITEM_SKIP:  Skip this item
    50  * @GST_ITERATOR_ITEM_SKIP:  Skip this item
    51  * @GST_ITERATOR_ITEM_PASS:  Return item
    51  * @GST_ITERATOR_ITEM_PASS:  Return item
    52  * @GST_ITERATOR_ITEM_END:   Stop after this item.
    52  * @GST_ITERATOR_ITEM_END:   Stop after this item.
    53  *
    53  *
    54  * The result of a GstIteratorItemFunction.
    54  * The result of a #GstIteratorItemFunction.
    55  */
    55  */
    56 typedef enum {
    56 typedef enum {
    57   GST_ITERATOR_ITEM_SKIP	= 0,
    57   GST_ITERATOR_ITEM_SKIP	= 0,
    58   GST_ITERATOR_ITEM_PASS	= 1,
    58   GST_ITERATOR_ITEM_PASS	= 1,
    59   GST_ITERATOR_ITEM_END		= 2
    59   GST_ITERATOR_ITEM_END		= 2
    61 
    61 
    62 /**
    62 /**
    63  * GstIteratorDisposeFunction:
    63  * GstIteratorDisposeFunction:
    64  * @owner: the owner of the iterator
    64  * @owner: the owner of the iterator
    65  *
    65  *
    66  * The function that will be called when a GList iterator is freed. The
    66  * The function that will be called when a #GList iterator is freed. The
    67  * owner of the GList iterator can then clean up its resources.
    67  * owner of the #GList iterator can then clean up its resources.
    68  */
    68  */
    69 typedef void		  (*GstIteratorDisposeFunction)	(gpointer owner);
    69 typedef void		  (*GstIteratorDisposeFunction)	(gpointer owner);
    70 
    70 
    71 /**
    71 /**
    72  * GstIteratorNextFunction:
    72  * GstIteratorNextFunction:
   126 typedef void		  (*GstIteratorFreeFunction)	(GstIterator *it);
   126 typedef void		  (*GstIteratorFreeFunction)	(GstIterator *it);
   127 
   127 
   128 /**
   128 /**
   129  * GstIteratorFoldFunction:
   129  * GstIteratorFoldFunction:
   130  * @item: the item to fold
   130  * @item: the item to fold
   131  * @ret: a GValue collecting the result
   131  * @ret: a #GValue collecting the result
   132  * @user_data: data passed to gst_iterator_fold()
   132  * @user_data: data passed to gst_iterator_fold()
   133  *
   133  *
   134  * A function to be passed to gst_iterator_fold().
   134  * A function to be passed to gst_iterator_fold().
   135  *
   135  *
   136  * Returns: TRUE if the fold should continue, FALSE if it should stop.
   136  * Returns: TRUE if the fold should continue, FALSE if it should stop.
   184  * @lock: The lock protecting the data structure and the cookie.
   184  * @lock: The lock protecting the data structure and the cookie.
   185  * @cookie: The cookie; the value of the master_cookie when this iterator was
   185  * @cookie: The cookie; the value of the master_cookie when this iterator was
   186  *          created.
   186  *          created.
   187  * @master_cookie: A pointer to the master cookie.
   187  * @master_cookie: A pointer to the master cookie.
   188  *
   188  *
   189  * GstIterator base structure. The values of this structure are 
   189  * #GstIterator base structure. The values of this structure are 
   190  * protected for subclasses, use the methods to use the #GstIterator.
   190  * protected for subclasses, use the methods to use the #GstIterator.
   191  */
   191  */
   192 struct _GstIterator {
   192 struct _GstIterator {
   193   /*< protected >*/
   193   /*< protected >*/
   194   GstIteratorNextFunction next;
   194   GstIteratorNextFunction next;