Copyright | Will Thompson, Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
Safe Haskell | None |
Language | Haskell2010 |
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.
- newtype DeviceProviderFactory = DeviceProviderFactory (ManagedPtr DeviceProviderFactory)
- class GObject o => IsDeviceProviderFactory o
- toDeviceProviderFactory :: IsDeviceProviderFactory o => o -> IO DeviceProviderFactory
- noDeviceProviderFactory :: Maybe DeviceProviderFactory
- deviceProviderFactoryFind :: (HasCallStack, MonadIO m) => Text -> m (Maybe DeviceProviderFactory)
- data DeviceProviderFactoryGetMethodInfo
- deviceProviderFactoryGet :: (HasCallStack, MonadIO m, IsDeviceProviderFactory a) => a -> m (Maybe DeviceProvider)
- deviceProviderFactoryGetByName :: (HasCallStack, MonadIO m) => Text -> m (Maybe DeviceProvider)
- data DeviceProviderFactoryGetDeviceProviderTypeMethodInfo
- deviceProviderFactoryGetDeviceProviderType :: (HasCallStack, MonadIO m, IsDeviceProviderFactory a) => a -> m GType
- data DeviceProviderFactoryGetMetadataMethodInfo
- deviceProviderFactoryGetMetadata :: (HasCallStack, MonadIO m, IsDeviceProviderFactory a) => a -> Text -> m (Maybe Text)
- data DeviceProviderFactoryGetMetadataKeysMethodInfo
- deviceProviderFactoryGetMetadataKeys :: (HasCallStack, MonadIO m, IsDeviceProviderFactory a) => a -> m (Maybe [Text])
- data DeviceProviderFactoryHasClassesMethodInfo
- deviceProviderFactoryHasClasses :: (HasCallStack, MonadIO m, IsDeviceProviderFactory a) => a -> Maybe Text -> m Bool
- data DeviceProviderFactoryHasClassesvMethodInfo
- deviceProviderFactoryHasClassesv :: (HasCallStack, MonadIO m, IsDeviceProviderFactory a) => a -> Maybe [Text] -> m Bool
- deviceProviderFactoryListGetDeviceProviders :: (HasCallStack, MonadIO m) => Rank -> m [DeviceProviderFactory]
Exported types
newtype DeviceProviderFactory Source #
GObject DeviceProviderFactory Source # | |
IsObject DeviceProviderFactory Source # | |
IsPluginFeature DeviceProviderFactory Source # | |
IsObject DeviceProviderFactory Source # | |
IsDeviceProviderFactory DeviceProviderFactory Source # | |
((~) * info (ResolveDeviceProviderFactoryMethod t DeviceProviderFactory), MethodInfo * info DeviceProviderFactory p) => IsLabel t (DeviceProviderFactory -> p) Source # | |
((~) * info (ResolveDeviceProviderFactoryMethod t DeviceProviderFactory), MethodInfo * info DeviceProviderFactory p) => IsLabelProxy t (DeviceProviderFactory -> p) Source # | |
HasAttributeList * DeviceProviderFactory Source # | |
type AttributeList DeviceProviderFactory Source # | |
type SignalList DeviceProviderFactory Source # | |
class GObject o => IsDeviceProviderFactory o Source #
Methods
find
deviceProviderFactoryFind Source #
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> m (Maybe DeviceProviderFactory) | Returns: |
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
data DeviceProviderFactoryGetMethodInfo Source #
((~) * signature (m (Maybe DeviceProvider)), MonadIO m, IsDeviceProviderFactory a) => MethodInfo * DeviceProviderFactoryGetMethodInfo a signature Source # | |
deviceProviderFactoryGet Source #
:: (HasCallStack, MonadIO m, IsDeviceProviderFactory a) | |
=> a |
|
-> m (Maybe DeviceProvider) | Returns: the |
Returns the device provider of the type defined by the given device providerfactory.
Since: 1.4
getByName
deviceProviderFactoryGetByName Source #
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> m (Maybe DeviceProvider) | Returns: a |
Returns the device provider of the type defined by the given device provider factory.
Since: 1.4
getDeviceProviderType
data DeviceProviderFactoryGetDeviceProviderTypeMethodInfo Source #
((~) * signature (m GType), MonadIO m, IsDeviceProviderFactory a) => MethodInfo * DeviceProviderFactoryGetDeviceProviderTypeMethodInfo a signature Source # | |
deviceProviderFactoryGetDeviceProviderType Source #
:: (HasCallStack, MonadIO m, IsDeviceProviderFactory a) | |
=> a |
|
-> m GType | Returns: the |
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
data DeviceProviderFactoryGetMetadataMethodInfo Source #
((~) * signature (Text -> m (Maybe Text)), MonadIO m, IsDeviceProviderFactory a) => MethodInfo * DeviceProviderFactoryGetMetadataMethodInfo a signature Source # | |
deviceProviderFactoryGetMetadata Source #
:: (HasCallStack, MonadIO m, IsDeviceProviderFactory a) | |
=> a |
|
-> Text |
|
-> m (Maybe Text) | Returns: the metadata with |
Get the metadata on factory
with key
.
Since: 1.4
getMetadataKeys
data DeviceProviderFactoryGetMetadataKeysMethodInfo Source #
((~) * signature (m (Maybe [Text])), MonadIO m, IsDeviceProviderFactory a) => MethodInfo * DeviceProviderFactoryGetMetadataKeysMethodInfo a signature Source # | |
deviceProviderFactoryGetMetadataKeys Source #
:: (HasCallStack, MonadIO m, IsDeviceProviderFactory a) | |
=> a |
|
-> m (Maybe [Text]) | Returns:
a |
Get the available keys for the metadata on factory
.
Since: 1.4
hasClasses
data DeviceProviderFactoryHasClassesMethodInfo Source #
((~) * signature (Maybe Text -> m Bool), MonadIO m, IsDeviceProviderFactory a) => MethodInfo * DeviceProviderFactoryHasClassesMethodInfo a signature Source # | |
deviceProviderFactoryHasClasses Source #
:: (HasCallStack, MonadIO m, IsDeviceProviderFactory a) | |
=> a |
|
-> Maybe Text |
|
-> m Bool |
Check if factory
matches all of the given classes
Since: 1.4
hasClassesv
data DeviceProviderFactoryHasClassesvMethodInfo Source #
((~) * signature (Maybe [Text] -> m Bool), MonadIO m, IsDeviceProviderFactory a) => MethodInfo * DeviceProviderFactoryHasClassesvMethodInfo a signature Source # | |
deviceProviderFactoryHasClassesv Source #
:: (HasCallStack, MonadIO m, IsDeviceProviderFactory a) | |
=> a |
|
-> Maybe [Text] |
|
-> m Bool | Returns: |
Check if factory
matches all of the given classes
Since: 1.4
listGetDeviceProviders
deviceProviderFactoryListGetDeviceProviders Source #
:: (HasCallStack, MonadIO m) | |
=> Rank |
|
-> m [DeviceProviderFactory] | Returns:
a |
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