GI.Gst.Structs.MiniObject

#GstMiniObject is a simple structure that can be used to implement refcounted types.

Subclasses will include #GstMiniObject as the first member in their structure and then call gst_mini_object_init() to initialize the #GstMiniObject fields.

gst_mini_object_ref() and gst_mini_object_unref() increment and decrement the refcount respectively. When the refcount of a mini-object reaches 0, the dispose function is called first and when this returns %TRUE, the free function of the miniobject is called.

A copy can be made with gst_mini_object_copy().

gst_mini_object_is_writable() will return %TRUE when the refcount of the object is exactly 1, meaning the current caller has the only reference to the object. gst_mini_object_make_writable() will return a writable version of the object, which might be a new copy when the refcount was not 1.

Opaque data can be associated with a #GstMiniObject with gst_mini_object_set_qdata() and gst_mini_object_get_qdata(). The data is meant to be specific to the particular object and is not automatically copied with gst_mini_object_copy() or similar methods.

A weak reference can be added and remove with gst_mini_object_weak_ref() and gst_mini_object_weak_unref() respectively.

Exported types

newtype MiniObject

Constructors

MiniObject (ForeignPtr MiniObject)

Instances

WrappedPtr MiniObject

(~) AttrOpTag tag AttrSet => Constructible MiniObject tag

((~) * signature ([LockFlags] -> m ()), MonadIO m) => MethodInfo * MiniObjectUnlockMethodInfo MiniObject signature

((~) * signature (Word32 -> m (Ptr ())), MonadIO m) => MethodInfo * MiniObjectStealQdataMethodInfo MiniObject signature

((~) * signature (Word32 -> Ptr () -> DestroyNotify -> m ()), MonadIO m) => MethodInfo * MiniObjectSetQdataMethodInfo MiniObject signature

((~) * signature ([LockFlags] -> m Bool), MonadIO m) => MethodInfo * MiniObjectLockMethodInfo MiniObject signature

((~) * signature (m Bool), MonadIO m) => MethodInfo * MiniObjectIsWritableMethodInfo MiniObject signature

((~) * signature (Word32 -> m (Ptr ())), MonadIO m) => MethodInfo * MiniObjectGetQdataMethodInfo MiniObject signature

((~) * info (ResolveMiniObjectMethod t MiniObject), MethodInfo * info MiniObject p) => IsLabelProxy t (MiniObject -> p)

type AttributeList MiniObject

newZeroMiniObject :: MonadIO m => m MiniObject

Construct a MiniObject struct initialized to zero.

noMiniObject :: Maybe MiniObject

Methods

miniObjectGetQdata

data MiniObjectGetQdataMethodInfo

Instances

((~) * signature (Word32 -> m (Ptr ())), MonadIO m) => MethodInfo * MiniObjectGetQdataMethodInfo MiniObject signature

miniObjectGetQdata :: MonadIO m => MiniObject -> Word32 -> m (Ptr ())

miniObjectIsWritable

data MiniObjectIsWritableMethodInfo

Instances

((~) * signature (m Bool), MonadIO m) => MethodInfo * MiniObjectIsWritableMethodInfo MiniObject signature

miniObjectIsWritable :: MonadIO m => MiniObject -> m Bool

miniObjectLock

data MiniObjectLockMethodInfo

Instances

((~) * signature ([LockFlags] -> m Bool), MonadIO m) => MethodInfo * MiniObjectLockMethodInfo MiniObject signature

miniObjectLock :: MonadIO m => MiniObject -> [LockFlags] -> m Bool

miniObjectSetQdata

data MiniObjectSetQdataMethodInfo

Instances

((~) * signature (Word32 -> Ptr () -> DestroyNotify -> m ()), MonadIO m) => MethodInfo * MiniObjectSetQdataMethodInfo MiniObject signature

miniObjectSetQdata :: MonadIO m => MiniObject -> Word32 -> Ptr () -> DestroyNotify -> m ()

miniObjectStealQdata

data MiniObjectStealQdataMethodInfo

Instances

((~) * signature (Word32 -> m (Ptr ())), MonadIO m) => MethodInfo * MiniObjectStealQdataMethodInfo MiniObject signature

miniObjectStealQdata :: MonadIO m => MiniObject -> Word32 -> m (Ptr ())

miniObjectTake

miniObjectTake :: MonadIO m => MiniObject -> MiniObject -> m (Bool, MiniObject)

miniObjectUnlock

data MiniObjectUnlockMethodInfo

Instances

((~) * signature ([LockFlags] -> m ()), MonadIO m) => MethodInfo * MiniObjectUnlockMethodInfo MiniObject signature

miniObjectUnlock :: MonadIO m => MiniObject -> [LockFlags] -> m ()

Properties

Flags

miniObjectFlags :: AttrLabelProxy "flags"

miniObjectReadFlags :: MonadIO m => MiniObject -> m Word32

miniObjectWriteFlags :: MonadIO m => MiniObject -> Word32 -> m ()

Lockstate

miniObjectLockstate :: AttrLabelProxy "lockstate"

miniObjectReadLockstate :: MonadIO m => MiniObject -> m Int32

miniObjectWriteLockstate :: MonadIO m => MiniObject -> Int32 -> m ()

Refcount

miniObjectReadRefcount :: MonadIO m => MiniObject -> m Int32

miniObjectRefcount :: AttrLabelProxy "refcount"

miniObjectWriteRefcount :: MonadIO m => MiniObject -> Int32 -> m ()

Type

miniObjectReadType :: MonadIO m => MiniObject -> m GType

miniObjectType :: AttrLabelProxy "type"

miniObjectWriteType :: MonadIO m => MiniObject -> GType -> m ()