gi-gst-1.0.23: GStreamer bindings
CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.Gst.Objects.DeviceProviderFactory

Description

DeviceProviderFactory is used to create instances of device providers. A GstDeviceProviderfactory can be added to a Plugin as it is also a PluginFeature.

Use the deviceProviderFactoryFind and deviceProviderFactoryGet functions to create device provider instances or use deviceProviderFactoryGetByName as a convenient shortcut.

Since: 1.4

Synopsis

Exported types

newtype DeviceProviderFactory Source #

Memory-managed wrapper type.

Constructors

DeviceProviderFactory (ManagedPtr DeviceProviderFactory) 

Instances

Instances details
Eq DeviceProviderFactory Source # 
Instance details

Defined in GI.Gst.Objects.DeviceProviderFactory

GObject DeviceProviderFactory Source # 
Instance details

Defined in GI.Gst.Objects.DeviceProviderFactory

ManagedPtrNewtype DeviceProviderFactory Source # 
Instance details

Defined in GI.Gst.Objects.DeviceProviderFactory

TypedObject DeviceProviderFactory Source # 
Instance details

Defined in GI.Gst.Objects.DeviceProviderFactory

Methods

glibType :: IO GType

IsGValue DeviceProviderFactory Source #

Convert DeviceProviderFactory to and from GValue with toGValue and fromGValue.

Instance details

Defined in GI.Gst.Objects.DeviceProviderFactory

Methods

toGValue :: DeviceProviderFactory -> IO GValue

fromGValue :: GValue -> IO DeviceProviderFactory

HasParentTypes DeviceProviderFactory Source # 
Instance details

Defined in GI.Gst.Objects.DeviceProviderFactory

type ParentTypes DeviceProviderFactory Source # 
Instance details

Defined in GI.Gst.Objects.DeviceProviderFactory

type ParentTypes DeviceProviderFactory = '[PluginFeature, Object, Object]

class (GObject o, IsDescendantOf DeviceProviderFactory o) => IsDeviceProviderFactory o Source #

Type class for types which can be safely cast to DeviceProviderFactory, for instance with toDeviceProviderFactory.

Instances

Instances details
(GObject o, IsDescendantOf DeviceProviderFactory o) => IsDeviceProviderFactory o Source # 
Instance details

Defined in GI.Gst.Objects.DeviceProviderFactory

toDeviceProviderFactory :: (MonadIO m, IsDeviceProviderFactory o) => o -> m DeviceProviderFactory Source #

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

Methods

Overloaded methods

find

deviceProviderFactoryFind Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Text

name: name of factory to find

-> m (Maybe DeviceProviderFactory)

Returns: DeviceProviderFactory if found, Nothing otherwise

Search for an device provider factory of the given name. Refs the returned device provider factory; caller is responsible for unreffing.

Since: 1.4

get

deviceProviderFactoryGet Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeviceProviderFactory a) 
=> a

factory: factory to instantiate

-> m (Maybe DeviceProvider)

Returns: the DeviceProvider or Nothing if the device provider couldn't be created

Returns the device provider of the type defined by the given device providerfactory.

Since: 1.4

getByName

deviceProviderFactoryGetByName Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Text

factoryname: a named factory to instantiate

-> m (Maybe DeviceProvider)

Returns: a DeviceProvider or Nothing if unable to create device provider

Returns the device provider of the type defined by the given device provider factory.

Since: 1.4

getDeviceProviderType

deviceProviderFactoryGetDeviceProviderType Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeviceProviderFactory a) 
=> a

factory: factory to get managed GType from

-> m GType

Returns: the GType for device providers managed by this factory.

Get the GType for device providers managed by this factory. The type can only be retrieved if the device provider factory is loaded, which can be assured with pluginFeatureLoad.

Since: 1.4

getMetadata

deviceProviderFactoryGetMetadata Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeviceProviderFactory a) 
=> a

factory: a DeviceProviderFactory

-> Text

key: a key

-> m (Maybe Text)

Returns: the metadata with key on factory or Nothing when there was no metadata with the given key.

Get the metadata on factory with key.

Since: 1.4

getMetadataKeys

deviceProviderFactoryGetMetadataKeys Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeviceProviderFactory a) 
=> a

factory: a DeviceProviderFactory

-> m (Maybe [Text])

Returns: a Nothing-terminated array of key strings, or Nothing when there is no metadata. Free with strfreev when no longer needed.

Get the available keys for the metadata on factory.

Since: 1.4

hasClasses

deviceProviderFactoryHasClasses Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeviceProviderFactory a) 
=> a

factory: a DeviceProviderFactory

-> Maybe Text

classes: a "/" separate list of classes to match, only match if all classes are matched

-> m Bool

Returns: True if factory matches or if classes is Nothing.

Check if factory matches all of the given classes

Since: 1.4

hasClassesv

deviceProviderFactoryHasClassesv Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeviceProviderFactory a) 
=> a

factory: a DeviceProviderFactory

-> Maybe [Text]

classes: a Nothing terminated array of classes to match, only match if all classes are matched

-> m Bool

Returns: True if factory matches.

Check if factory matches all of the given classes

Since: 1.4

listGetDeviceProviders

deviceProviderFactoryListGetDeviceProviders Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Rank

minrank: Minimum rank

-> m [DeviceProviderFactory]

Returns: a List of DeviceProviderFactory device providers. Use pluginFeatureListFree after usage.

Get a list of factories with a rank greater or equal to minrank. The list of factories is returned by decreasing rank.

Since: 1.4