GI.Gst.Objects.PluginFeature

This is a base class for anything that can be added to a Plugin.

Exported types

newtype PluginFeature

Memory-managed wrapper type.

Constructors

PluginFeature (ManagedPtr PluginFeature)

Instances

Eq PluginFeature

Defined in GI.Gst.Objects.PluginFeature

Methods

(==) :: PluginFeature -> PluginFeature -> Bool

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

GObject PluginFeature

Defined in GI.Gst.Objects.PluginFeature

Methods

gobjectType :: IO GType

IsGValue PluginFeature

Convert PluginFeature to and from GValue with toGValue and fromGValue.

Defined in GI.Gst.Objects.PluginFeature

Methods

toGValue :: PluginFeature -> IO GValue

fromGValue :: GValue -> IO PluginFeature

HasParentTypes PluginFeature

Defined in GI.Gst.Objects.PluginFeature

type ParentTypes PluginFeature

Defined in GI.Gst.Objects.PluginFeature

type ParentTypes PluginFeature = '[Object, Object]

class (GObject o, IsDescendantOf PluginFeature o) => IsPluginFeature o

Type class for types which can be safely cast to PluginFeature, for instance with toPluginFeature.

Instances

(GObject o, IsDescendantOf PluginFeature o) => IsPluginFeature o

Defined in GI.Gst.Objects.PluginFeature

toPluginFeature :: (MonadIO m, IsPluginFeature o) => o -> m PluginFeature

Cast to PluginFeature, for types for which this is known to be safe. For general casts, use castTo.

noPluginFeature :: Maybe PluginFeature

A convenience alias for Nothing :: Maybe PluginFeature.

Methods

Overloaded methods

checkVersion

pluginFeatureCheckVersion

Arguments

:: (HasCallStack, MonadIO m, IsPluginFeature a)

=> a

feature: a feature

-> Word32

minMajor: minimum required major version

-> Word32

minMinor: minimum required minor version

-> Word32

minMicro: minimum required micro version

-> m Bool

Returns: True if the plugin feature has at least the required version, otherwise False.

Checks whether the given plugin feature is at least the required version

getPlugin

pluginFeatureGetPlugin

Arguments

:: (HasCallStack, MonadIO m, IsPluginFeature a)

=> a

feature: a feature

-> m (Maybe Plugin)

Returns: the plugin that provides this feature, or Nothing. Unref with objectUnref when no longer needed.

Get the plugin that provides this feature.

getPluginName

pluginFeatureGetPluginName

Arguments

:: (HasCallStack, MonadIO m, IsPluginFeature a)

=> a

feature: a feature

-> m (Maybe Text)

Returns: the name of the plugin that provides this feature, or Nothing if the feature is not associated with a plugin.

Get the name of the plugin that provides this feature.

Since: 1.2

getRank

pluginFeatureGetRank

Arguments

:: (HasCallStack, MonadIO m, IsPluginFeature a)

=> a

feature: a feature

-> m Word32

Returns: The rank of the feature

Gets the rank of a plugin feature.

listCopy

pluginFeatureListCopy

Arguments

:: (HasCallStack, MonadIO m, IsPluginFeature a)

=> [a]

list: list of PluginFeature

-> m [PluginFeature]

Returns: a copy of list, with each feature's reference count incremented.

Copies the list of features. Caller should call gstPluginFeatureListFree when done with the list.

listDebug

pluginFeatureListDebug

Arguments

:: (HasCallStack, MonadIO m, IsPluginFeature a)

=> [a]

list: a List of plugin features

-> m ()

Debug the plugin feature names in list.

listFree

pluginFeatureListFree

Arguments

:: (HasCallStack, MonadIO m, IsPluginFeature a)

=> [a]

list: list of PluginFeature

-> m ()

Unrefs each member of list, then frees the list.

load

pluginFeatureLoad

Arguments

:: (HasCallStack, MonadIO m, IsPluginFeature a)

=> a

feature: the plugin feature to check

-> m (Maybe PluginFeature)

Returns: a reference to the loaded feature, or Nothing on error

Loads the plugin containing feature if it's not already loaded. feature is unaffected; use the return value instead.

Normally this function is used like this:

C code

GstPluginFeature *loaded_feature;

loaded_feature = gst_plugin_feature_load (feature);
// presumably, we're no longer interested in the potentially-unloaded feature
gst_object_unref (feature);
feature = loaded_feature;

rankCompareFunc

pluginFeatureRankCompareFunc

Arguments

:: (HasCallStack, MonadIO m)

=> Ptr ()

p1: a PluginFeature

-> Ptr ()

p2: a PluginFeature

-> m Int32

Returns: negative value if the rank of p1 > the rank of p2 or the ranks are equal but the name of p1 comes before the name of p2; zero if the rank and names are equal; positive value if the rank of p1 < the rank of p2 or the ranks are equal but the name of p2 comes before the name of p1

Compares the two given PluginFeature instances. This function can be used as a CompareFunc when sorting by rank and then by name.

setRank

pluginFeatureSetRank

Arguments

:: (HasCallStack, MonadIO m, IsPluginFeature a)

=> a

feature: feature to rank

-> Word32

rank: rank value - higher number means more priority rank

-> m ()

Specifies a rank for a plugin feature, so that autoplugging uses the most appropriate feature.