Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (inaki@blueleaf.cc) |
Safe Haskell | None |
Language | Haskell2010 |
A plugin should export a variable of this type called plugin_desc. The plugin loader will use the data provided there to initialize the plugin.
The licence
parameter must be one of: LGPL, GPL, QPL, GPL/QPL, MPL,
BSD, MIT/X11, Proprietary, unknown.
Synopsis
- newtype PluginDesc = PluginDesc (ManagedPtr PluginDesc)
- newZeroPluginDesc :: MonadIO m => m PluginDesc
- noPluginDesc :: Maybe PluginDesc
- clearPluginDescDescription :: MonadIO m => PluginDesc -> m ()
- getPluginDescDescription :: MonadIO m => PluginDesc -> m (Maybe Text)
- setPluginDescDescription :: MonadIO m => PluginDesc -> CString -> m ()
- clearPluginDescLicense :: MonadIO m => PluginDesc -> m ()
- getPluginDescLicense :: MonadIO m => PluginDesc -> m (Maybe Text)
- setPluginDescLicense :: MonadIO m => PluginDesc -> CString -> m ()
- getPluginDescMajorVersion :: MonadIO m => PluginDesc -> m Int32
- setPluginDescMajorVersion :: MonadIO m => PluginDesc -> Int32 -> m ()
- getPluginDescMinorVersion :: MonadIO m => PluginDesc -> m Int32
- setPluginDescMinorVersion :: MonadIO m => PluginDesc -> Int32 -> m ()
- clearPluginDescName :: MonadIO m => PluginDesc -> m ()
- getPluginDescName :: MonadIO m => PluginDesc -> m (Maybe Text)
- setPluginDescName :: MonadIO m => PluginDesc -> CString -> m ()
- clearPluginDescOrigin :: MonadIO m => PluginDesc -> m ()
- getPluginDescOrigin :: MonadIO m => PluginDesc -> m (Maybe Text)
- setPluginDescOrigin :: MonadIO m => PluginDesc -> CString -> m ()
- clearPluginDescPackage :: MonadIO m => PluginDesc -> m ()
- getPluginDescPackage :: MonadIO m => PluginDesc -> m (Maybe Text)
- setPluginDescPackage :: MonadIO m => PluginDesc -> CString -> m ()
- clearPluginDescPluginInit :: MonadIO m => PluginDesc -> m ()
- getPluginDescPluginInit :: MonadIO m => PluginDesc -> m (Maybe PluginInitFunc)
- setPluginDescPluginInit :: MonadIO m => PluginDesc -> FunPtr C_PluginInitFunc -> m ()
- clearPluginDescReleaseDatetime :: MonadIO m => PluginDesc -> m ()
- getPluginDescReleaseDatetime :: MonadIO m => PluginDesc -> m (Maybe Text)
- setPluginDescReleaseDatetime :: MonadIO m => PluginDesc -> CString -> m ()
- clearPluginDescSource :: MonadIO m => PluginDesc -> m ()
- getPluginDescSource :: MonadIO m => PluginDesc -> m (Maybe Text)
- setPluginDescSource :: MonadIO m => PluginDesc -> CString -> m ()
- clearPluginDescVersion :: MonadIO m => PluginDesc -> m ()
- getPluginDescVersion :: MonadIO m => PluginDesc -> m (Maybe Text)
- setPluginDescVersion :: MonadIO m => PluginDesc -> CString -> m ()
Exported types
newtype PluginDesc Source #
Memory-managed wrapper type.
Instances
WrappedPtr PluginDesc Source # | |
Defined in GI.Gst.Structs.PluginDesc | |
tag ~ AttrSet => Constructible PluginDesc tag Source # | |
Defined in GI.Gst.Structs.PluginDesc new :: MonadIO m => (ManagedPtr PluginDesc -> PluginDesc) -> [AttrOp PluginDesc tag] -> m PluginDesc # |
newZeroPluginDesc :: MonadIO m => m PluginDesc Source #
Construct a PluginDesc
struct initialized to zero.
noPluginDesc :: Maybe PluginDesc Source #
A convenience alias for Nothing
:: Maybe
PluginDesc
.
Properties
description
description of plugin
clearPluginDescDescription :: MonadIO m => PluginDesc -> m () Source #
Set the value of the “description
” field to Nothing
.
When overloading is enabled, this is equivalent to
clear
#description
getPluginDescDescription :: MonadIO m => PluginDesc -> m (Maybe Text) Source #
Get the value of the “description
” field.
When overloading is enabled, this is equivalent to
get
pluginDesc #description
setPluginDescDescription :: MonadIO m => PluginDesc -> CString -> m () Source #
Set the value of the “description
” field.
When overloading is enabled, this is equivalent to
set
pluginDesc [ #description:=
value ]
license
effective license of plugin
clearPluginDescLicense :: MonadIO m => PluginDesc -> m () Source #
Set the value of the “license
” field to Nothing
.
When overloading is enabled, this is equivalent to
clear
#license
getPluginDescLicense :: MonadIO m => PluginDesc -> m (Maybe Text) Source #
Get the value of the “license
” field.
When overloading is enabled, this is equivalent to
get
pluginDesc #license
setPluginDescLicense :: MonadIO m => PluginDesc -> CString -> m () Source #
Set the value of the “license
” field.
When overloading is enabled, this is equivalent to
set
pluginDesc [ #license:=
value ]
majorVersion
the major version number of core that plugin was compiled for
getPluginDescMajorVersion :: MonadIO m => PluginDesc -> m Int32 Source #
Get the value of the “major_version
” field.
When overloading is enabled, this is equivalent to
get
pluginDesc #majorVersion
setPluginDescMajorVersion :: MonadIO m => PluginDesc -> Int32 -> m () Source #
Set the value of the “major_version
” field.
When overloading is enabled, this is equivalent to
set
pluginDesc [ #majorVersion:=
value ]
minorVersion
the minor version number of core that plugin was compiled for
getPluginDescMinorVersion :: MonadIO m => PluginDesc -> m Int32 Source #
Get the value of the “minor_version
” field.
When overloading is enabled, this is equivalent to
get
pluginDesc #minorVersion
setPluginDescMinorVersion :: MonadIO m => PluginDesc -> Int32 -> m () Source #
Set the value of the “minor_version
” field.
When overloading is enabled, this is equivalent to
set
pluginDesc [ #minorVersion:=
value ]
name
a unique name of the plugin
clearPluginDescName :: MonadIO m => PluginDesc -> m () Source #
Set the value of the “name
” field to Nothing
.
When overloading is enabled, this is equivalent to
clear
#name
getPluginDescName :: MonadIO m => PluginDesc -> m (Maybe Text) Source #
Get the value of the “name
” field.
When overloading is enabled, this is equivalent to
get
pluginDesc #name
setPluginDescName :: MonadIO m => PluginDesc -> CString -> m () Source #
Set the value of the “name
” field.
When overloading is enabled, this is equivalent to
set
pluginDesc [ #name:=
value ]
origin
URL to provider of plugin
clearPluginDescOrigin :: MonadIO m => PluginDesc -> m () Source #
Set the value of the “origin
” field to Nothing
.
When overloading is enabled, this is equivalent to
clear
#origin
getPluginDescOrigin :: MonadIO m => PluginDesc -> m (Maybe Text) Source #
Get the value of the “origin
” field.
When overloading is enabled, this is equivalent to
get
pluginDesc #origin
setPluginDescOrigin :: MonadIO m => PluginDesc -> CString -> m () Source #
Set the value of the “origin
” field.
When overloading is enabled, this is equivalent to
set
pluginDesc [ #origin:=
value ]
package
shipped package plugin belongs to
clearPluginDescPackage :: MonadIO m => PluginDesc -> m () Source #
Set the value of the “package
” field to Nothing
.
When overloading is enabled, this is equivalent to
clear
#package
getPluginDescPackage :: MonadIO m => PluginDesc -> m (Maybe Text) Source #
Get the value of the “package
” field.
When overloading is enabled, this is equivalent to
get
pluginDesc #package
setPluginDescPackage :: MonadIO m => PluginDesc -> CString -> m () Source #
Set the value of the “package
” field.
When overloading is enabled, this is equivalent to
set
pluginDesc [ #package:=
value ]
pluginInit
pointer to the init function of this plugin.
clearPluginDescPluginInit :: MonadIO m => PluginDesc -> m () Source #
Set the value of the “plugin_init
” field to Nothing
.
When overloading is enabled, this is equivalent to
clear
#pluginInit
getPluginDescPluginInit :: MonadIO m => PluginDesc -> m (Maybe PluginInitFunc) Source #
Get the value of the “plugin_init
” field.
When overloading is enabled, this is equivalent to
get
pluginDesc #pluginInit
setPluginDescPluginInit :: MonadIO m => PluginDesc -> FunPtr C_PluginInitFunc -> m () Source #
Set the value of the “plugin_init
” field.
When overloading is enabled, this is equivalent to
set
pluginDesc [ #pluginInit:=
value ]
releaseDatetime
date time string in ISO 8601
format (or rather, a subset thereof), or Nothing
. Allowed are the
following formats: "YYYY-MM-DD" and "YYY-MM-DDTHH:MMZ" (with
'T' a separator and 'Z' indicating UTC/Zulu time). This field
should be set via the GST_PACKAGE_RELEASE_DATETIME
preprocessor macro.
clearPluginDescReleaseDatetime :: MonadIO m => PluginDesc -> m () Source #
Set the value of the “release_datetime
” field to Nothing
.
When overloading is enabled, this is equivalent to
clear
#releaseDatetime
getPluginDescReleaseDatetime :: MonadIO m => PluginDesc -> m (Maybe Text) Source #
Get the value of the “release_datetime
” field.
When overloading is enabled, this is equivalent to
get
pluginDesc #releaseDatetime
setPluginDescReleaseDatetime :: MonadIO m => PluginDesc -> CString -> m () Source #
Set the value of the “release_datetime
” field.
When overloading is enabled, this is equivalent to
set
pluginDesc [ #releaseDatetime:=
value ]
source
source module plugin belongs to
clearPluginDescSource :: MonadIO m => PluginDesc -> m () Source #
Set the value of the “source
” field to Nothing
.
When overloading is enabled, this is equivalent to
clear
#source
getPluginDescSource :: MonadIO m => PluginDesc -> m (Maybe Text) Source #
Get the value of the “source
” field.
When overloading is enabled, this is equivalent to
get
pluginDesc #source
setPluginDescSource :: MonadIO m => PluginDesc -> CString -> m () Source #
Set the value of the “source
” field.
When overloading is enabled, this is equivalent to
set
pluginDesc [ #source:=
value ]
version
version of the plugin
clearPluginDescVersion :: MonadIO m => PluginDesc -> m () Source #
Set the value of the “version
” field to Nothing
.
When overloading is enabled, this is equivalent to
clear
#version
getPluginDescVersion :: MonadIO m => PluginDesc -> m (Maybe Text) Source #
Get the value of the “version
” field.
When overloading is enabled, this is equivalent to
get
pluginDesc #version
setPluginDescVersion :: MonadIO m => PluginDesc -> CString -> m () Source #
Set the value of the “version
” field.
When overloading is enabled, this is equivalent to
set
pluginDesc [ #version:=
value ]