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.MiniObject

Contents

Exported types
Methods
Properties

Description

#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.

Synopsis

Exported types

newtype MiniObject Source

Constructors

MiniObject (ForeignPtr MiniObject)

Instances

((~) * info (ResolveMiniObjectMethod t MiniObject), MethodInfo * info MiniObject p) => IsLabel t (MiniObject -> p) Source
Methods fromLabel :: Proxy# Symbol t -> MiniObject -> p
((~) * info (ResolveMiniObjectMethod t MiniObject), MethodInfo * info MiniObject p) => IsLabelProxy t (MiniObject -> p) Source
Methods fromLabelProxy :: Proxy Symbol t -> MiniObject -> p
((~) (TYPE Lifted) signature ([LockFlags] -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) MiniObjectUnlockMethodInfo MiniObject signature Source
Methods overloadedMethod :: MethodProxy MiniObjectUnlockMethodInfo MiniObject -> signature -> s
((~) (TYPE Lifted) signature (Word32 -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) MiniObjectStealQdataMethodInfo MiniObject signature Source
Methods overloadedMethod :: MethodProxy MiniObjectStealQdataMethodInfo MiniObject -> signature -> s
((~) (TYPE Lifted) signature (Word32 -> Ptr () -> DestroyNotify -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) MiniObjectSetQdataMethodInfo MiniObject signature Source
Methods overloadedMethod :: MethodProxy MiniObjectSetQdataMethodInfo MiniObject -> signature -> s
((~) (TYPE Lifted) signature ([LockFlags] -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) MiniObjectLockMethodInfo MiniObject signature Source
Methods overloadedMethod :: MethodProxy MiniObjectLockMethodInfo MiniObject -> signature -> s
((~) (TYPE Lifted) signature (m Bool), MonadIO m) => MethodInfo (TYPE Lifted) MiniObjectIsWritableMethodInfo MiniObject signature Source
Methods overloadedMethod :: MethodProxy MiniObjectIsWritableMethodInfo MiniObject -> signature -> s
((~) (TYPE Lifted) signature (Word32 -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) MiniObjectGetQdataMethodInfo MiniObject signature Source
Methods overloadedMethod :: MethodProxy MiniObjectGetQdataMethodInfo MiniObject -> signature -> s

newZeroMiniObject :: MonadIO m => m MiniObject Source

Construct a MiniObject struct initialized to zero.

noMiniObject :: Maybe MiniObject Source

Methods

miniObjectGetQdata

data MiniObjectGetQdataMethodInfo Source

Instances

((~) (TYPE Lifted) signature (Word32 -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) MiniObjectGetQdataMethodInfo MiniObject signature Source
Methods overloadedMethod :: MethodProxy MiniObjectGetQdataMethodInfo MiniObject -> signature -> s

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

miniObjectIsWritable

data MiniObjectIsWritableMethodInfo Source

Instances

((~) (TYPE Lifted) signature (m Bool), MonadIO m) => MethodInfo (TYPE Lifted) MiniObjectIsWritableMethodInfo MiniObject signature Source
Methods overloadedMethod :: MethodProxy MiniObjectIsWritableMethodInfo MiniObject -> signature -> s

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

miniObjectLock

data MiniObjectLockMethodInfo Source

Instances

((~) (TYPE Lifted) signature ([LockFlags] -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) MiniObjectLockMethodInfo MiniObject signature Source
Methods overloadedMethod :: MethodProxy MiniObjectLockMethodInfo MiniObject -> signature -> s

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

miniObjectSetQdata

data MiniObjectSetQdataMethodInfo Source

Instances

((~) (TYPE Lifted) signature (Word32 -> Ptr () -> DestroyNotify -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) MiniObjectSetQdataMethodInfo MiniObject signature Source
Methods overloadedMethod :: MethodProxy MiniObjectSetQdataMethodInfo MiniObject -> signature -> s

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

miniObjectStealQdata

data MiniObjectStealQdataMethodInfo Source

Instances

((~) (TYPE Lifted) signature (Word32 -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) MiniObjectStealQdataMethodInfo MiniObject signature Source
Methods overloadedMethod :: MethodProxy MiniObjectStealQdataMethodInfo MiniObject -> signature -> s

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

miniObjectTake

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

miniObjectUnlock

data MiniObjectUnlockMethodInfo Source

Instances

((~) (TYPE Lifted) signature ([LockFlags] -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) MiniObjectUnlockMethodInfo MiniObject signature Source
Methods overloadedMethod :: MethodProxy MiniObjectUnlockMethodInfo MiniObject -> signature -> s

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

Properties

Flags

miniObjectReadFlags :: MiniObject -> IO Word32 Source

Lockstate

miniObjectReadLockstate :: MiniObject -> IO Int32 Source

Refcount

miniObjectReadRefcount :: MiniObject -> IO Int32 Source

Type

miniObjectReadType :: MiniObject -> IO GType Source