Copyright	Will Thompson, Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (garetxe@gmail.com)
Safe Haskell	None
Language	Haskell2010

GI.Gst.Structs.Iterator

Contents

Exported types
Methods
Properties

Description

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); ]|

Synopsis

Exported types

newtype Iterator Source

Constructors

Iterator (ForeignPtr Iterator)

Instances

BoxedObject Iterator Source
Methods boxedType :: Iterator -> IO GType
((~) * info (ResolveIteratorMethod t Iterator), MethodInfo * info Iterator p) => IsLabel t (Iterator -> p) Source
Methods fromLabel :: Proxy# Symbol t -> Iterator -> p
((~) * info (ResolveIteratorMethod t Iterator), MethodInfo * info Iterator p) => IsLabelProxy t (Iterator -> p) Source
Methods fromLabelProxy :: Proxy Symbol t -> Iterator -> p
((~) (TYPE Lifted) signature (m ()), MonadIO m) => MethodInfo (TYPE Lifted) IteratorResyncMethodInfo Iterator signature Source
Methods overloadedMethod :: MethodProxy IteratorResyncMethodInfo Iterator -> signature -> s
((~) (TYPE Lifted) signature (Iterator -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) IteratorPushMethodInfo Iterator signature Source
Methods overloadedMethod :: MethodProxy IteratorPushMethodInfo Iterator -> signature -> s
((~) (TYPE Lifted) signature (m (IteratorResult, GValue)), MonadIO m) => MethodInfo (TYPE Lifted) IteratorNextMethodInfo Iterator signature Source
Methods overloadedMethod :: MethodProxy IteratorNextMethodInfo Iterator -> signature -> s
((~) (TYPE Lifted) signature (m ()), MonadIO m) => MethodInfo (TYPE Lifted) IteratorFreeMethodInfo Iterator signature Source
Methods overloadedMethod :: MethodProxy IteratorFreeMethodInfo Iterator -> signature -> s
((~) (TYPE Lifted) signature (IteratorForeachFunction -> m IteratorResult), MonadIO m) => MethodInfo (TYPE Lifted) IteratorForeachMethodInfo Iterator signature Source
Methods overloadedMethod :: MethodProxy IteratorForeachMethodInfo Iterator -> signature -> s
((~) (TYPE Lifted) signature (IteratorFoldFunction -> GValue -> m IteratorResult), MonadIO m) => MethodInfo (TYPE Lifted) IteratorFoldMethodInfo Iterator signature Source
Methods overloadedMethod :: MethodProxy IteratorFoldMethodInfo Iterator -> signature -> s
((~) (TYPE Lifted) signature (CompareFunc -> m (Bool, GValue)), MonadIO m) => MethodInfo (TYPE Lifted) IteratorFindCustomMethodInfo Iterator signature Source
Methods overloadedMethod :: MethodProxy IteratorFindCustomMethodInfo Iterator -> signature -> s
((~) (TYPE Lifted) signature (CompareFunc -> GValue -> m Iterator), MonadIO m) => MethodInfo (TYPE Lifted) IteratorFilterMethodInfo Iterator signature Source
Methods overloadedMethod :: MethodProxy IteratorFilterMethodInfo Iterator -> signature -> s
((~) (TYPE Lifted) signature (m Iterator), MonadIO m) => MethodInfo (TYPE Lifted) IteratorCopyMethodInfo Iterator signature Source
Methods overloadedMethod :: MethodProxy IteratorCopyMethodInfo Iterator -> signature -> s

newZeroIterator :: MonadIO m => m Iterator Source

Construct a Iterator struct initialized to zero.

noIterator :: Maybe Iterator Source

Methods

iteratorCopy

data IteratorCopyMethodInfo Source

Instances

((~) (TYPE Lifted) signature (m Iterator), MonadIO m) => MethodInfo (TYPE Lifted) IteratorCopyMethodInfo Iterator signature Source
Methods overloadedMethod :: MethodProxy IteratorCopyMethodInfo Iterator -> signature -> s

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

iteratorFilter

data IteratorFilterMethodInfo Source

Instances

((~) (TYPE Lifted) signature (CompareFunc -> GValue -> m Iterator), MonadIO m) => MethodInfo (TYPE Lifted) IteratorFilterMethodInfo Iterator signature Source
Methods overloadedMethod :: MethodProxy IteratorFilterMethodInfo Iterator -> signature -> s

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

iteratorFindCustom

data IteratorFindCustomMethodInfo Source

Instances

((~) (TYPE Lifted) signature (CompareFunc -> m (Bool, GValue)), MonadIO m) => MethodInfo (TYPE Lifted) IteratorFindCustomMethodInfo Iterator signature Source
Methods overloadedMethod :: MethodProxy IteratorFindCustomMethodInfo Iterator -> signature -> s

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

iteratorFold

data IteratorFoldMethodInfo Source

Instances

((~) (TYPE Lifted) signature (IteratorFoldFunction -> GValue -> m IteratorResult), MonadIO m) => MethodInfo (TYPE Lifted) IteratorFoldMethodInfo Iterator signature Source
Methods overloadedMethod :: MethodProxy IteratorFoldMethodInfo Iterator -> signature -> s

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

iteratorForeach

data IteratorForeachMethodInfo Source

Instances

((~) (TYPE Lifted) signature (IteratorForeachFunction -> m IteratorResult), MonadIO m) => MethodInfo (TYPE Lifted) IteratorForeachMethodInfo Iterator signature Source
Methods overloadedMethod :: MethodProxy IteratorForeachMethodInfo Iterator -> signature -> s

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

iteratorFree

data IteratorFreeMethodInfo Source

Instances

((~) (TYPE Lifted) signature (m ()), MonadIO m) => MethodInfo (TYPE Lifted) IteratorFreeMethodInfo Iterator signature Source
Methods overloadedMethod :: MethodProxy IteratorFreeMethodInfo Iterator -> signature -> s

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

iteratorNewSingle

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

iteratorNext

data IteratorNextMethodInfo Source

Instances

((~) (TYPE Lifted) signature (m (IteratorResult, GValue)), MonadIO m) => MethodInfo (TYPE Lifted) IteratorNextMethodInfo Iterator signature Source
Methods overloadedMethod :: MethodProxy IteratorNextMethodInfo Iterator -> signature -> s

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

iteratorPush

data IteratorPushMethodInfo Source

Instances

((~) (TYPE Lifted) signature (Iterator -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) IteratorPushMethodInfo Iterator signature Source
Methods overloadedMethod :: MethodProxy IteratorPushMethodInfo Iterator -> signature -> s

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

iteratorResync

data IteratorResyncMethodInfo Source

Instances

((~) (TYPE Lifted) signature (m ()), MonadIO m) => MethodInfo (TYPE Lifted) IteratorResyncMethodInfo Iterator signature Source
Methods overloadedMethod :: MethodProxy IteratorResyncMethodInfo Iterator -> signature -> s

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

Properties

Cookie

iteratorReadCookie :: Iterator -> IO Word32 Source

Lock

iteratorReadLock :: Iterator -> IO Mutex Source

MasterCookie

iteratorReadMasterCookie :: Iterator -> IO Word32 Source

Pushed

iteratorReadPushed :: Iterator -> IO Iterator Source

Size

iteratorReadSize :: Iterator -> IO Word32 Source

Type

iteratorReadType :: Iterator -> IO GType Source