Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Collection of EncodingProfile
for a specific target or use-case.
When being stored/loaded, targets come from a specific category, like
ENCODING_CATEGORY_DEVICE
.
Synopsis
- newtype EncodingTarget = EncodingTarget (ManagedPtr EncodingTarget)
- class (GObject o, IsDescendantOf EncodingTarget o) => IsEncodingTarget o
- toEncodingTarget :: (MonadIO m, IsEncodingTarget o) => o -> m EncodingTarget
- encodingTargetAddProfile :: (HasCallStack, MonadIO m, IsEncodingTarget a, IsEncodingProfile b) => a -> b -> m Bool
- encodingTargetGetCategory :: (HasCallStack, MonadIO m, IsEncodingTarget a) => a -> m Text
- encodingTargetGetDescription :: (HasCallStack, MonadIO m, IsEncodingTarget a) => a -> m Text
- encodingTargetGetName :: (HasCallStack, MonadIO m, IsEncodingTarget a) => a -> m Text
- encodingTargetGetPath :: (HasCallStack, MonadIO m, IsEncodingTarget a) => a -> m Text
- encodingTargetGetProfile :: (HasCallStack, MonadIO m, IsEncodingTarget a) => a -> Text -> m EncodingProfile
- encodingTargetGetProfiles :: (HasCallStack, MonadIO m, IsEncodingTarget a) => a -> m [EncodingProfile]
- encodingTargetLoad :: (HasCallStack, MonadIO m) => Text -> Maybe Text -> m EncodingTarget
- encodingTargetLoadFromFile :: (HasCallStack, MonadIO m) => [Char] -> m EncodingTarget
- encodingTargetNew :: (HasCallStack, MonadIO m, IsEncodingProfile a) => Text -> Text -> Text -> [a] -> m EncodingTarget
- encodingTargetSave :: (HasCallStack, MonadIO m, IsEncodingTarget a) => a -> m ()
- encodingTargetSaveToFile :: (HasCallStack, MonadIO m, IsEncodingTarget a) => a -> [Char] -> m ()
Exported types
newtype EncodingTarget Source #
Memory-managed wrapper type.
Instances
Eq EncodingTarget Source # | |
Defined in GI.GstPbutils.Objects.EncodingTarget (==) :: EncodingTarget -> EncodingTarget -> Bool # (/=) :: EncodingTarget -> EncodingTarget -> Bool # | |
GObject EncodingTarget Source # | |
Defined in GI.GstPbutils.Objects.EncodingTarget | |
ManagedPtrNewtype EncodingTarget Source # | |
Defined in GI.GstPbutils.Objects.EncodingTarget | |
TypedObject EncodingTarget Source # | |
Defined in GI.GstPbutils.Objects.EncodingTarget | |
HasParentTypes EncodingTarget Source # | |
Defined in GI.GstPbutils.Objects.EncodingTarget | |
IsGValue (Maybe EncodingTarget) Source # | Convert |
Defined in GI.GstPbutils.Objects.EncodingTarget gvalueGType_ :: IO GType # gvalueSet_ :: Ptr GValue -> Maybe EncodingTarget -> IO () # gvalueGet_ :: Ptr GValue -> IO (Maybe EncodingTarget) # | |
type ParentTypes EncodingTarget Source # | |
Defined in GI.GstPbutils.Objects.EncodingTarget |
class (GObject o, IsDescendantOf EncodingTarget o) => IsEncodingTarget o Source #
Type class for types which can be safely cast to EncodingTarget
, for instance with toEncodingTarget
.
Instances
(GObject o, IsDescendantOf EncodingTarget o) => IsEncodingTarget o Source # | |
Defined in GI.GstPbutils.Objects.EncodingTarget |
toEncodingTarget :: (MonadIO m, IsEncodingTarget o) => o -> m EncodingTarget Source #
Cast to EncodingTarget
, for types for which this is known to be safe. For general casts, use castTo
.
Methods
Click to display all available methods, including inherited ones
Methods
addProfile, bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, save, saveToFile, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getCategory, getData, getDescription, getName, getPath, getProfile, getProfiles, getProperty, getQdata.
Setters
addProfile
encodingTargetAddProfile Source #
:: (HasCallStack, MonadIO m, IsEncodingTarget a, IsEncodingProfile b) | |
=> a |
|
-> b |
|
-> m Bool |
Adds the given profile
to the target
. Each added profile must have
a unique name within the profile.
The target
will steal a reference to the profile
. If you wish to use
the profile after calling this method, you should increase its reference
count.
getCategory
encodingTargetGetCategory Source #
:: (HasCallStack, MonadIO m, IsEncodingTarget a) | |
=> a |
|
-> m Text | Returns: The category of the |
No description available in the introspection data.
getDescription
encodingTargetGetDescription Source #
:: (HasCallStack, MonadIO m, IsEncodingTarget a) | |
=> a |
|
-> m Text | Returns: The description of the |
No description available in the introspection data.
getName
encodingTargetGetName Source #
:: (HasCallStack, MonadIO m, IsEncodingTarget a) | |
=> a |
|
-> m Text | Returns: The name of the |
No description available in the introspection data.
getPath
encodingTargetGetPath Source #
:: (HasCallStack, MonadIO m, IsEncodingTarget a) | |
=> a |
|
-> m Text | Returns: The path to the |
No description available in the introspection data.
Since: 1.18
getProfile
encodingTargetGetProfile Source #
:: (HasCallStack, MonadIO m, IsEncodingTarget a) | |
=> a |
|
-> Text |
|
-> m EncodingProfile | Returns: The matching |
No description available in the introspection data.
getProfiles
encodingTargetGetProfiles Source #
:: (HasCallStack, MonadIO m, IsEncodingTarget a) | |
=> a |
|
-> m [EncodingProfile] | Returns: A list of
|
No description available in the introspection data.
load
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> Maybe Text |
|
-> m EncodingTarget | Returns: The |
Searches for the EncodingTarget
with the given name, loads it
and returns it.
If the category name is specified only targets from that category will be searched for.
loadFromFile
encodingTargetLoadFromFile Source #
:: (HasCallStack, MonadIO m) | |
=> [Char] |
|
-> m EncodingTarget | Returns: The |
Opens the provided file and returns the contained EncodingTarget
.
new
:: (HasCallStack, MonadIO m, IsEncodingProfile a) | |
=> Text |
|
-> Text |
|
-> Text |
|
-> [a] |
|
-> m EncodingTarget | Returns: The newly created |
Creates a new EncodingTarget
.
The name and category can only consist of lowercase ASCII letters for the first character, followed by either lowercase ASCII letters, digits or hyphens ('-').
The category
*should* be one of the existing
well-defined categories, like ENCODING_CATEGORY_DEVICE
, but it
*can* be a application or user specific category if
needed.
save
:: (HasCallStack, MonadIO m, IsEncodingTarget a) | |
=> a |
|
-> m () | (Can throw |
Saves the target
to a default user-local directory.
saveToFile
encodingTargetSaveToFile Source #
:: (HasCallStack, MonadIO m, IsEncodingTarget a) | |
=> a |
|
-> [Char] |
|
-> m () | (Can throw |
Saves the target
to the provided file location.