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 |
This interface offers methods to query and manipulate parameter preset sets. A preset is a bunch of property settings, together with meta data and a name. The name of a preset serves as key for subsequent method calls to manipulate single presets. All instances of one type will share the list of presets. The list is created on demand, if presets are not used, the list is not created.
The interface comes with a default implementation that serves most plugins.
Wrapper plugins will override most methods to implement support for the
native preset format of those wrapped plugins.
One method that is useful to be overridden is presetGetPropertyNames
.
With that one can control which properties are saved and in which order.
When implementing support for read-only presets, one should set the vmethods
for presetSavePreset
and presetDeletePreset
to Nothing
.
Applications can use presetIsEditable
to check for that.
The default implementation supports presets located in a system directory, application specific directory and in the users home directory. When getting a list of presets individual presets are read and overlaid in 1) system, 2) application and 3) user order. Whenever an earlier entry is newer, the later entries will be updated. Since 1.8 you can also provide extra paths where to find presets through the GST_PRESET_PATH environment variable. Presets found in those paths will be considered as "app presets".
Synopsis
- newtype Preset = Preset (ManagedPtr Preset)
- noPreset :: Maybe Preset
- class (ManagedPtrNewtype o, IsDescendantOf Preset o) => IsPreset o
- presetDeletePreset :: (HasCallStack, MonadIO m, IsPreset a) => a -> Text -> m Bool
- presetGetAppDir :: (HasCallStack, MonadIO m) => m (Maybe [Char])
- presetGetMeta :: (HasCallStack, MonadIO m, IsPreset a) => a -> Text -> Text -> m (Bool, Text)
- presetGetPresetNames :: (HasCallStack, MonadIO m, IsPreset a) => a -> m [Text]
- presetGetPropertyNames :: (HasCallStack, MonadIO m, IsPreset a) => a -> m [Text]
- presetIsEditable :: (HasCallStack, MonadIO m, IsPreset a) => a -> m Bool
- presetLoadPreset :: (HasCallStack, MonadIO m, IsPreset a) => a -> Text -> m Bool
- presetRenamePreset :: (HasCallStack, MonadIO m, IsPreset a) => a -> Text -> Text -> m Bool
- presetSavePreset :: (HasCallStack, MonadIO m, IsPreset a) => a -> Text -> m Bool
- presetSetAppDir :: (HasCallStack, MonadIO m) => [Char] -> m Bool
- presetSetMeta :: (HasCallStack, MonadIO m, IsPreset a) => a -> Text -> Text -> Maybe Text -> m Bool
Exported types
Memory-managed wrapper type.
Instances
WrappedPtr Preset Source # | |
Defined in GI.Gst.Interfaces.Preset wrappedPtrCalloc :: IO (Ptr Preset) # wrappedPtrCopy :: Preset -> IO Preset # |
class (ManagedPtrNewtype o, IsDescendantOf Preset o) => IsPreset o Source #
Type class for types which implement Preset
.
Instances
(ManagedPtrNewtype o, IsDescendantOf Preset o) => IsPreset o Source # | |
Defined in GI.Gst.Interfaces.Preset |
Methods
deletePreset
:: (HasCallStack, MonadIO m, IsPreset a) | |
=> a | |
-> Text |
|
-> m Bool | Returns: |
Delete the given preset.
getAppDir
:: (HasCallStack, MonadIO m) | |
=> m (Maybe [Char]) | Returns: the directory or |
Gets the directory for application specific presets if set by the application.
getMeta
:: (HasCallStack, MonadIO m, IsPreset a) | |
=> a | |
-> Text |
|
-> Text |
|
-> m (Bool, Text) | Returns: |
Gets the value
for an existing meta data tag
. Meta data tag
names can be
something like e.g. "comment". Returned values need to be released when done.
getPresetNames
:: (HasCallStack, MonadIO m, IsPreset a) | |
=> a | |
-> m [Text] | Returns:
list with names, use |
Get a copy of preset names as a Nothing
terminated string array.
getPropertyNames
presetGetPropertyNames Source #
:: (HasCallStack, MonadIO m, IsPreset a) | |
=> a | |
-> m [Text] | Returns: an
array of property names which should be freed with |
Get a the names of the GObject properties that can be used for presets.
isEditable
:: (HasCallStack, MonadIO m, IsPreset a) | |
=> a | |
-> m Bool | Returns: |
Check if one can add new presets, change existing ones and remove presets.
Since: 1.6
loadPreset
:: (HasCallStack, MonadIO m, IsPreset a) | |
=> a | |
-> Text |
|
-> m Bool | Returns: |
Load the given preset.
renamePreset
:: (HasCallStack, MonadIO m, IsPreset a) | |
=> a | |
-> Text |
|
-> Text |
|
-> m Bool | Returns: |
Renames a preset. If there is already a preset by the newName
it will be
overwritten.
savePreset
:: (HasCallStack, MonadIO m, IsPreset a) | |
=> a | |
-> Text |
|
-> m Bool |
Save the current object settings as a preset under the given name. If there
is already a preset by this name
it will be overwritten.
setAppDir
:: (HasCallStack, MonadIO m) | |
=> [Char] |
|
-> m Bool | Returns: |
Sets an extra directory as an absolute path that should be considered when looking for presets. Any presets in the application dir will shadow the system presets.
setMeta
:: (HasCallStack, MonadIO m, IsPreset a) | |
=> a | |
-> Text |
|
-> Text |
|
-> Maybe Text |
|
-> m Bool | Returns: |
Sets a new value
for an existing meta data item or adds a new item. Meta
data tag
names can be something like e.g. "comment". Supplying Nothing
for the
value
will unset an existing value.