GI.Gst.Structs.StaticCaps

Data structure to initialize Caps from a string description usually used in conjunction with GST_STATIC_CAPS() and staticCapsGet to instantiate a Caps.

Exported types

newtype StaticCaps

Memory-managed wrapper type.

Constructors

StaticCaps (ManagedPtr StaticCaps)

Instances

Eq StaticCaps

Defined in GI.Gst.Structs.StaticCaps

Methods

(==) :: StaticCaps -> StaticCaps -> Bool

(/=) :: StaticCaps -> StaticCaps -> Bool

BoxedPtr StaticCaps

Defined in GI.Gst.Structs.StaticCaps

Methods

boxedPtrCopy :: StaticCaps -> IO StaticCaps

boxedPtrFree :: StaticCaps -> IO ()

CallocPtr StaticCaps

Defined in GI.Gst.Structs.StaticCaps

Methods

boxedPtrCalloc :: IO (Ptr StaticCaps)

ManagedPtrNewtype StaticCaps

Defined in GI.Gst.Structs.StaticCaps

Methods

toManagedPtr :: StaticCaps -> ManagedPtr StaticCaps

tag ~ 'AttrSet => Constructible StaticCaps tag

Defined in GI.Gst.Structs.StaticCaps

Methods

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

newZeroStaticCaps :: MonadIO m => m StaticCaps

Construct a StaticCaps struct initialized to zero.

Methods

Click to display all available methods, including inherited ones

Methods

cleanup, get.

Getters

None.

Setters

None.

cleanup

staticCapsCleanup

Arguments

:: (HasCallStack, MonadIO m)

=> StaticCaps

staticCaps: the StaticCaps to clean

-> m ()

Cleans up the cached caps contained in staticCaps.

get

staticCapsGet

Arguments

:: (HasCallStack, MonadIO m)

=> StaticCaps

staticCaps: the StaticCaps to convert

-> m (Maybe Caps)

Returns: a pointer to the Caps. Since the core holds an additional ref to the returned caps, use gst_caps_make_writable() on the returned caps to modify it.

Converts a StaticCaps to a Caps.

Properties

caps

the cached Caps

clearStaticCapsCaps :: MonadIO m => StaticCaps -> m ()

Set the value of the “caps” field to Nothing. When overloading is enabled, this is equivalent to

clear #caps

getStaticCapsCaps :: MonadIO m => StaticCaps -> m (Maybe Caps)

Get the value of the “caps” field. When overloading is enabled, this is equivalent to

get staticCaps #caps

setStaticCapsCaps :: MonadIO m => StaticCaps -> Ptr Caps -> m ()

Set the value of the “caps” field. When overloading is enabled, this is equivalent to

set staticCaps [ #caps := value ]

string

a string describing a caps

clearStaticCapsString :: MonadIO m => StaticCaps -> m ()

Set the value of the “string” field to Nothing. When overloading is enabled, this is equivalent to

clear #string

getStaticCapsString :: MonadIO m => StaticCaps -> m (Maybe Text)

Get the value of the “string” field. When overloading is enabled, this is equivalent to

get staticCaps #string

setStaticCapsString :: MonadIO m => StaticCaps -> CString -> m ()

Set the value of the “string” field. When overloading is enabled, this is equivalent to

set staticCaps [ #string := value ]