mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-06-05 06:58:56 +00:00
Code Issues 1 Projects Releases Wiki Activity

iterator: Fix outdated example code and accompanying documentation

Browse source 
GstIterator no longer returns a refcounted gpointer
This commit is contained in:
Nirbheek Chauhan 2014-12-27 15:15:30 +05:30 committed by Tim-Philipp Müller
parent bc1ec4ec5f
commit b627201e7e
1 changed files with 6 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
gst/gstiterator.c
View file

@ -32,18 +32,20 @@
* Various GStreamer objects provide access to their internal structures using * Various GStreamer objects provide access to their internal structures using
* an iterator. * an iterator.
* *
* In general, whenever calling a GstIterator function results in your code * Note that if calling a GstIterator function results in your code receiving
* receiving a refcounted object, the refcount for that object will have been * a refcounted object (with, say, g_value_get_object()), the refcount for that
* increased. Your code is responsible for unreffing that object after use. * object will not be increased. Your code is responsible for taking a reference
* if it wants to continue using it later.
* *
* The basic use pattern of an iterator is as follows: * The basic use pattern of an iterator is as follows:
* |[ * |[
* GstIterator *it = _get_iterator(object); * GstIterator *it = _get_iterator(object);
* GValue item = G_VALUE_INIT;
* done = FALSE; * done = FALSE;
* while (!done) { * while (!done) {
* switch (gst_iterator_next (it, &item)) { * switch (gst_iterator_next (it, &item)) {
* case GST_ITERATOR_OK: * case GST_ITERATOR_OK:
* ... use/change item here... * ...get/use/change item here...
* g_value_reset (&item); * g_value_reset (&item);
* break; * break;
* case GST_ITERATOR_RESYNC: * case GST_ITERATOR_RESYNC: