Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
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.
Since: 1.4
Synopsis
- newtype DeviceProviderFactory = DeviceProviderFactory (ManagedPtr DeviceProviderFactory)
- class (GObject o, IsDescendantOf DeviceProviderFactory o) => IsDeviceProviderFactory o
- toDeviceProviderFactory :: (MonadIO m, IsDeviceProviderFactory o) => o -> m DeviceProviderFactory
- noDeviceProviderFactory :: Maybe DeviceProviderFactory
- deviceProviderFactoryFind :: (HasCallStack, MonadIO m) => Text -> m (Maybe DeviceProviderFactory)
- deviceProviderFactoryGet :: (HasCallStack, MonadIO m, IsDeviceProviderFactory a) => a -> m (Maybe DeviceProvider)
- deviceProviderFactoryGetByName :: (HasCallStack, MonadIO m) => Text -> m (Maybe DeviceProvider)
- deviceProviderFactoryGetDeviceProviderType :: (HasCallStack, MonadIO m, IsDeviceProviderFactory a) => a -> m GType
- deviceProviderFactoryGetMetadata :: (HasCallStack, MonadIO m, IsDeviceProviderFactory a) => a -> Text -> m (Maybe Text)
- deviceProviderFactoryGetMetadataKeys :: (HasCallStack, MonadIO m, IsDeviceProviderFactory a) => a -> m (Maybe [Text])
- deviceProviderFactoryHasClasses :: (HasCallStack, MonadIO m, IsDeviceProviderFactory a) => a -> Maybe Text -> m Bool
- deviceProviderFactoryHasClassesv :: (HasCallStack, MonadIO m, IsDeviceProviderFactory a) => a -> Maybe [Text] -> m Bool
- deviceProviderFactoryListGetDeviceProviders :: (HasCallStack, MonadIO m) => Rank -> m [DeviceProviderFactory]
Exported types
newtype DeviceProviderFactory Source #
Memory-managed wrapper type.
Instances
Eq DeviceProviderFactory Source # | |
Defined in GI.Gst.Objects.DeviceProviderFactory (==) :: DeviceProviderFactory -> DeviceProviderFactory -> Bool # (/=) :: DeviceProviderFactory -> DeviceProviderFactory -> Bool # | |
GObject DeviceProviderFactory Source # | |
Defined in GI.Gst.Objects.DeviceProviderFactory gobjectType :: IO GType # | |
IsGValue DeviceProviderFactory Source # | Convert |
Defined in GI.Gst.Objects.DeviceProviderFactory toGValue :: DeviceProviderFactory -> IO GValue # fromGValue :: GValue -> IO DeviceProviderFactory # | |
HasParentTypes DeviceProviderFactory Source # | |
Defined in GI.Gst.Objects.DeviceProviderFactory | |
type ParentTypes DeviceProviderFactory Source # | |
Defined in GI.Gst.Objects.DeviceProviderFactory |
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
(GObject o, IsDescendantOf DeviceProviderFactory o) => IsDeviceProviderFactory o Source # | |
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
.
noDeviceProviderFactory :: Maybe DeviceProviderFactory Source #
A convenience alias for Nothing
:: Maybe
DeviceProviderFactory
.
Methods
Overloaded 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
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
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
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
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
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
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