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 (ManagedPtr MiniObject)

Instances

WrappedPtr MiniObject

Methods

wrappedPtrCalloc :: IO (Ptr MiniObject)

wrappedPtrCopy :: Ptr MiniObject -> IO (Ptr MiniObject)

wrappedPtrFree :: Maybe (FunPtr (Ptr MiniObject -> IO ()))

(~) AttrOpTag tag AttrSet => Constructible MiniObject tag

Methods

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

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

Methods

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

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

Methods

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

HasAttributeList * MiniObject

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

Methods

overloadedMethod :: MethodProxy MiniObjectUnlockMethodInfo MiniObject -> signature -> s

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

Methods

overloadedMethod :: MethodProxy MiniObjectStealQdataMethodInfo MiniObject -> signature -> s

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

Methods

overloadedMethod :: MethodProxy MiniObjectSetQdataMethodInfo MiniObject -> signature -> s

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

Methods

overloadedMethod :: MethodProxy MiniObjectLockMethodInfo MiniObject -> signature -> s

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

Methods

overloadedMethod :: MethodProxy MiniObjectIsWritableMethodInfo MiniObject -> signature -> s

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

Methods

overloadedMethod :: MethodProxy MiniObjectGetQdataMethodInfo MiniObject -> signature -> s

type AttributeList MiniObject

type AttributeList MiniObject

newZeroMiniObject :: MonadIO m => m MiniObject

Construct a MiniObject struct initialized to zero.

noMiniObject :: Maybe MiniObject

Methods

getQdata

data MiniObjectGetQdataMethodInfo

Instances

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

Methods

overloadedMethod :: MethodProxy MiniObjectGetQdataMethodInfo MiniObject -> signature -> s

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

isWritable

data MiniObjectIsWritableMethodInfo

Instances

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

Methods

overloadedMethod :: MethodProxy MiniObjectIsWritableMethodInfo MiniObject -> signature -> s

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

lock

data MiniObjectLockMethodInfo

Instances

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

Methods

overloadedMethod :: MethodProxy MiniObjectLockMethodInfo MiniObject -> signature -> s

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

setQdata

data MiniObjectSetQdataMethodInfo

Instances

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

Methods

overloadedMethod :: MethodProxy MiniObjectSetQdataMethodInfo MiniObject -> signature -> s

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

stealQdata

data MiniObjectStealQdataMethodInfo

Instances

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

Methods

overloadedMethod :: MethodProxy MiniObjectStealQdataMethodInfo MiniObject -> signature -> s

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

unlock

data MiniObjectUnlockMethodInfo

Instances

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

Methods

overloadedMethod :: MethodProxy MiniObjectUnlockMethodInfo MiniObject -> signature -> s

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

Properties

dispose

clearMiniObjectDispose :: MonadIO m => MiniObject -> m ()

getMiniObjectDispose :: MonadIO m => MiniObject -> m (Maybe MiniObjectDisposeFunction)

miniObject_dispose :: AttrLabelProxy "dispose"

setMiniObjectDispose :: MonadIO m => MiniObject -> FunPtr C_MiniObjectDisposeFunction -> m ()

flags

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

miniObject_flags :: AttrLabelProxy "flags"

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

free

clearMiniObjectFree :: MonadIO m => MiniObject -> m ()

getMiniObjectFree :: MonadIO m => MiniObject -> m (Maybe MiniObjectFreeFunction)

miniObject_free :: AttrLabelProxy "free"

setMiniObjectFree :: MonadIO m => MiniObject -> FunPtr C_MiniObjectFreeFunction -> m ()

lockstate

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

miniObject_lockstate :: AttrLabelProxy "lockstate"

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

refcount

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

miniObject_refcount :: AttrLabelProxy "refcount"

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

type

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

miniObject_type :: AttrLabelProxy "type"

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