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: |[language="C" -- 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 (ManagedPtr Iterator)

Instances

BoxedObject Iterator

Methods

boxedType :: Iterator -> IO GType

(~) AttrOpTag tag AttrSet => Constructible Iterator tag

Methods

new :: MonadIO m => (ManagedPtr Iterator -> Iterator) -> [AttrOp Iterator tag] -> m Iterator

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

Methods

fromLabel :: Proxy# Symbol t -> Iterator -> p

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

Methods

fromLabelProxy :: Proxy Symbol t -> Iterator -> p

HasAttributeList * Iterator

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

Methods

overloadedMethod :: MethodProxy IteratorResyncMethodInfo Iterator -> signature -> s

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

Methods

overloadedMethod :: MethodProxy IteratorPushMethodInfo Iterator -> signature -> s

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

Methods

overloadedMethod :: MethodProxy IteratorNextMethodInfo Iterator -> signature -> s

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

Methods

overloadedMethod :: MethodProxy IteratorFreeMethodInfo Iterator -> signature -> s

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

Methods

overloadedMethod :: MethodProxy IteratorForeachMethodInfo Iterator -> signature -> s

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

Methods

overloadedMethod :: MethodProxy IteratorFoldMethodInfo Iterator -> signature -> s

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

Methods

overloadedMethod :: MethodProxy IteratorFindCustomMethodInfo Iterator -> signature -> s

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

Methods

overloadedMethod :: MethodProxy IteratorFilterMethodInfo Iterator -> signature -> s

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

Methods

overloadedMethod :: MethodProxy IteratorCopyMethodInfo Iterator -> signature -> s

type AttributeList Iterator

type AttributeList Iterator

newZeroIterator :: MonadIO m => m Iterator

Construct a Iterator struct initialized to zero.

noIterator :: Maybe Iterator

Methods

copy

data IteratorCopyMethodInfo

Instances

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

Methods

overloadedMethod :: MethodProxy IteratorCopyMethodInfo Iterator -> signature -> s

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

filter

data IteratorFilterMethodInfo

Instances

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

Methods

overloadedMethod :: MethodProxy IteratorFilterMethodInfo Iterator -> signature -> s

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

findCustom

data IteratorFindCustomMethodInfo

Instances

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

Methods

overloadedMethod :: MethodProxy IteratorFindCustomMethodInfo Iterator -> signature -> s

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

fold

data IteratorFoldMethodInfo

Instances

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

Methods

overloadedMethod :: MethodProxy IteratorFoldMethodInfo Iterator -> signature -> s

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

foreach

data IteratorForeachMethodInfo

Instances

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

Methods

overloadedMethod :: MethodProxy IteratorForeachMethodInfo Iterator -> signature -> s

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

free

data IteratorFreeMethodInfo

Instances

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

Methods

overloadedMethod :: MethodProxy IteratorFreeMethodInfo Iterator -> signature -> s

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

newSingle

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

next

data IteratorNextMethodInfo

Instances

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

Methods

overloadedMethod :: MethodProxy IteratorNextMethodInfo Iterator -> signature -> s

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

push

data IteratorPushMethodInfo

Instances

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

Methods

overloadedMethod :: MethodProxy IteratorPushMethodInfo Iterator -> signature -> s

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

resync

data IteratorResyncMethodInfo

Instances

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

Methods

overloadedMethod :: MethodProxy IteratorResyncMethodInfo Iterator -> signature -> s

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

Properties

cookie

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

iterator_cookie :: AttrLabelProxy "cookie"

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

copy

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

getIteratorCopy :: MonadIO m => Iterator -> m (Maybe IteratorCopyFunction)

iterator_copy :: AttrLabelProxy "copy"

setIteratorCopy :: MonadIO m => Iterator -> FunPtr C_IteratorCopyFunction -> m ()

free

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

getIteratorFree :: MonadIO m => Iterator -> m (Maybe IteratorFreeFunction)

iterator_free :: AttrLabelProxy "free"

setIteratorFree :: MonadIO m => Iterator -> FunPtr C_IteratorFreeFunction -> m ()

item

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

getIteratorItem :: MonadIO m => Iterator -> m (Maybe IteratorItemFunction)

iterator_item :: AttrLabelProxy "item"

setIteratorItem :: MonadIO m => Iterator -> FunPtr C_IteratorItemFunction -> m ()

lock

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

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

iterator_lock :: AttrLabelProxy "lock"

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

masterCookie

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

iterator_masterCookie :: AttrLabelProxy "masterCookie"

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

next

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

getIteratorNext :: MonadIO m => Iterator -> m (Maybe IteratorNextFunction)

iterator_next :: AttrLabelProxy "next"

setIteratorNext :: MonadIO m => Iterator -> FunPtr C_IteratorNextFunction -> m ()

pushed

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

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

iterator_pushed :: AttrLabelProxy "pushed"

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

resync

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

getIteratorResync :: MonadIO m => Iterator -> m (Maybe IteratorResyncFunction)

iterator_resync :: AttrLabelProxy "resync"

setIteratorResync :: MonadIO m => Iterator -> FunPtr C_IteratorResyncFunction -> m ()

size

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

iterator_size :: AttrLabelProxy "size"

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

type

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

iterator_type :: AttrLabelProxy "type"

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