GI.Gst.Structs.FormatDefinition

A format definition

Exported types

newtype FormatDefinition

Memory-managed wrapper type.

Constructors

FormatDefinition (ManagedPtr FormatDefinition)

Instances

Eq FormatDefinition

Defined in GI.Gst.Structs.FormatDefinition

Methods

(==) :: FormatDefinition -> FormatDefinition -> Bool

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

WrappedPtr FormatDefinition

Defined in GI.Gst.Structs.FormatDefinition

Methods

wrappedPtrCalloc :: IO (Ptr FormatDefinition)

wrappedPtrCopy :: FormatDefinition -> IO FormatDefinition

wrappedPtrFree :: Maybe (GDestroyNotify FormatDefinition)

tag ~ 'AttrSet => Constructible FormatDefinition tag

Defined in GI.Gst.Structs.FormatDefinition

Methods

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

newZeroFormatDefinition :: MonadIO m => m FormatDefinition

Construct a FormatDefinition struct initialized to zero.

noFormatDefinition :: Maybe FormatDefinition

A convenience alias for Nothing :: Maybe FormatDefinition.

Methods

Overloaded methods

Properties

description

A longer description of the format

clearFormatDefinitionDescription :: MonadIO m => FormatDefinition -> m ()

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

clear #description

getFormatDefinitionDescription :: MonadIO m => FormatDefinition -> m (Maybe Text)

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

get formatDefinition #description

setFormatDefinitionDescription :: MonadIO m => FormatDefinition -> CString -> m ()

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

set formatDefinition [ #description := value ]

nick

A short nick of the format

clearFormatDefinitionNick :: MonadIO m => FormatDefinition -> m ()

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

clear #nick

getFormatDefinitionNick :: MonadIO m => FormatDefinition -> m (Maybe Text)

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

get formatDefinition #nick

setFormatDefinitionNick :: MonadIO m => FormatDefinition -> CString -> m ()

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

set formatDefinition [ #nick := value ]

quark

A quark for the nick

getFormatDefinitionQuark :: MonadIO m => FormatDefinition -> m Word32

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

get formatDefinition #quark

setFormatDefinitionQuark :: MonadIO m => FormatDefinition -> Word32 -> m ()

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

set formatDefinition [ #quark := value ]

value

The unique id of this format

getFormatDefinitionValue :: MonadIO m => FormatDefinition -> m Format

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

get formatDefinition #value

setFormatDefinitionValue :: MonadIO m => FormatDefinition -> Format -> m ()

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

set formatDefinition [ #value := value ]