gi-gst-1.0.26: GStreamer bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.Gst.Structs.StaticCaps

Description

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

Synopsis

Exported types

newtype StaticCaps Source #

Memory-managed wrapper type.

Constructors

StaticCaps (ManagedPtr StaticCaps) 

Instances

Instances details
Eq StaticCaps Source # 
Instance details

Defined in GI.Gst.Structs.StaticCaps

BoxedPtr StaticCaps Source # 
Instance details

Defined in GI.Gst.Structs.StaticCaps

CallocPtr StaticCaps Source # 
Instance details

Defined in GI.Gst.Structs.StaticCaps

ManagedPtrNewtype StaticCaps Source # 
Instance details

Defined in GI.Gst.Structs.StaticCaps

Methods

toManagedPtr :: StaticCaps -> ManagedPtr StaticCaps

tag ~ 'AttrSet => Constructible StaticCaps tag Source # 
Instance details

Defined in GI.Gst.Structs.StaticCaps

Methods

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

newZeroStaticCaps :: MonadIO m => m StaticCaps Source #

Construct a StaticCaps struct initialized to zero.

Methods

Click to display all available methods, including inherited ones

Expand

Methods

cleanup, get.

Getters

None.

Setters

None.

cleanup

staticCapsCleanup Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> StaticCaps

staticCaps: the StaticCaps to clean

-> m () 

Cleans up the cached caps contained in staticCaps.

get

staticCapsGet Source #

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 () Source #

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) Source #

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 () Source #

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 () Source #

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) Source #

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

get staticCaps #string

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

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

set staticCaps [ #string := value ]