GI.Gst.Structs.Iterator

A GstIterator is used to retrieve multiple objects from another object in a threadsafe way.

Various GStreamer objects provide access to their internal structures using an iterator.

Note that if calling a GstIterator function results in your code receiving a refcounted object (with, say, g_value_get_object()), the refcount for that 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: |[ GstIterator *it = _get_iterator(object); GValue item = G_VALUE_INIT; done = FALSE; while (!done) { switch (gst_iterator_next (it, &item)) { case GST_ITERATOR_OK: ...getusechange item here... g_value_reset (&item); break; case GST_ITERATOR_RESYNC: ...rollback changes to items... gst_iterator_resync (it); break; case GST_ITERATOR_ERROR: ...wrong parameters were given... done = TRUE; break; case GST_ITERATOR_DONE: done = TRUE; break; } } g_value_unset (&item); gst_iterator_free (it); ]|

Exported types

newtype Iterator

Constructors

Iterator (ForeignPtr Iterator)

Instances

BoxedObject Iterator

(~) AttrOpTag tag AttrSet => Constructible Iterator tag

((~) * signature (m ()), MonadIO m) => MethodInfo * IteratorResyncMethodInfo Iterator signature

((~) * signature (Iterator -> m ()), MonadIO m) => MethodInfo * IteratorPushMethodInfo Iterator signature

((~) * signature (m (IteratorResult, GValue)), MonadIO m) => MethodInfo * IteratorNextMethodInfo Iterator signature

((~) * signature (m ()), MonadIO m) => MethodInfo * IteratorFreeMethodInfo Iterator signature

((~) * signature (IteratorForeachFunction -> m IteratorResult), MonadIO m) => MethodInfo * IteratorForeachMethodInfo Iterator signature

((~) * signature (IteratorFoldFunction -> GValue -> m IteratorResult), MonadIO m) => MethodInfo * IteratorFoldMethodInfo Iterator signature

((~) * signature (CompareFunc -> m (Bool, GValue)), MonadIO m) => MethodInfo * IteratorFindCustomMethodInfo Iterator signature

((~) * signature (CompareFunc -> GValue -> m Iterator), MonadIO m) => MethodInfo * IteratorFilterMethodInfo Iterator signature

((~) * signature (m Iterator), MonadIO m) => MethodInfo * IteratorCopyMethodInfo Iterator signature

((~) * info (ResolveIteratorMethod t Iterator), MethodInfo * info Iterator p) => IsLabelProxy t (Iterator -> p)

type AttributeList Iterator

newZeroIterator :: MonadIO m => m Iterator

Construct a Iterator struct initialized to zero.

noIterator :: Maybe Iterator

Methods

iteratorCopy

data IteratorCopyMethodInfo

Instances

((~) * signature (m Iterator), MonadIO m) => MethodInfo * IteratorCopyMethodInfo Iterator signature

iteratorCopy :: MonadIO m => Iterator -> m Iterator

iteratorFilter

data IteratorFilterMethodInfo

Instances

((~) * signature (CompareFunc -> GValue -> m Iterator), MonadIO m) => MethodInfo * IteratorFilterMethodInfo Iterator signature

iteratorFilter :: MonadIO m => Iterator -> CompareFunc -> GValue -> m Iterator

iteratorFindCustom

data IteratorFindCustomMethodInfo

Instances

((~) * signature (CompareFunc -> m (Bool, GValue)), MonadIO m) => MethodInfo * IteratorFindCustomMethodInfo Iterator signature

iteratorFindCustom :: MonadIO m => Iterator -> CompareFunc -> m (Bool, GValue)

iteratorFold

data IteratorFoldMethodInfo

Instances

((~) * signature (IteratorFoldFunction -> GValue -> m IteratorResult), MonadIO m) => MethodInfo * IteratorFoldMethodInfo Iterator signature

iteratorFold :: MonadIO m => Iterator -> IteratorFoldFunction -> GValue -> m IteratorResult

iteratorForeach

data IteratorForeachMethodInfo

Instances

((~) * signature (IteratorForeachFunction -> m IteratorResult), MonadIO m) => MethodInfo * IteratorForeachMethodInfo Iterator signature

iteratorForeach :: MonadIO m => Iterator -> IteratorForeachFunction -> m IteratorResult

iteratorFree

data IteratorFreeMethodInfo

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * IteratorFreeMethodInfo Iterator signature

iteratorFree :: MonadIO m => Iterator -> m ()

iteratorNewSingle

iteratorNewSingle :: MonadIO m => GType -> GValue -> m Iterator

iteratorNext

data IteratorNextMethodInfo

Instances

((~) * signature (m (IteratorResult, GValue)), MonadIO m) => MethodInfo * IteratorNextMethodInfo Iterator signature

iteratorNext :: MonadIO m => Iterator -> m (IteratorResult, GValue)

iteratorPush

data IteratorPushMethodInfo

Instances

((~) * signature (Iterator -> m ()), MonadIO m) => MethodInfo * IteratorPushMethodInfo Iterator signature

iteratorPush :: MonadIO m => Iterator -> Iterator -> m ()

iteratorResync

data IteratorResyncMethodInfo

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * IteratorResyncMethodInfo Iterator signature

iteratorResync :: MonadIO m => Iterator -> m ()

Properties

Cookie

iteratorCookie :: AttrLabelProxy "cookie"

iteratorReadCookie :: MonadIO m => Iterator -> m Word32

iteratorWriteCookie :: MonadIO m => Iterator -> Word32 -> m ()

Lock

iteratorClearLock :: MonadIO m => Iterator -> m ()

iteratorLock :: AttrLabelProxy "lock"

iteratorReadLock :: MonadIO m => Iterator -> m (Maybe Mutex)

iteratorWriteLock :: MonadIO m => Iterator -> Ptr Mutex -> m ()

MasterCookie

iteratorMasterCookie :: AttrLabelProxy "masterCookie"

iteratorReadMasterCookie :: MonadIO m => Iterator -> m Word32

iteratorWriteMasterCookie :: MonadIO m => Iterator -> Word32 -> m ()

Pushed

iteratorClearPushed :: MonadIO m => Iterator -> m ()

iteratorPushed :: AttrLabelProxy "pushed"

iteratorReadPushed :: MonadIO m => Iterator -> m (Maybe Iterator)

iteratorWritePushed :: MonadIO m => Iterator -> Ptr Iterator -> m ()

Size

iteratorReadSize :: MonadIO m => Iterator -> m Word32

iteratorSize :: AttrLabelProxy "size"

iteratorWriteSize :: MonadIO m => Iterator -> Word32 -> m ()

Type

iteratorReadType :: MonadIO m => Iterator -> m GType

iteratorType :: AttrLabelProxy "type"

iteratorWriteType :: MonadIO m => Iterator -> GType -> m ()