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

GI.GstPbutils.Objects.EncodingTarget

Contents

Exported types
Methods

Description

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

Exported types

newtype EncodingTarget Source #

Constructors

EncodingTarget (ManagedPtr EncodingTarget)

Instances

GObject EncodingTarget Source #
Methods gobjectType :: EncodingTarget -> IO GType #
IsObject EncodingTarget Source #

IsEncodingTarget EncodingTarget Source #

((~) * info (ResolveEncodingTargetMethod t EncodingTarget), MethodInfo * info EncodingTarget p) => IsLabel t (EncodingTarget -> p) Source #
Methods fromLabel :: Proxy# Symbol t -> EncodingTarget -> p #
((~) * info (ResolveEncodingTargetMethod t EncodingTarget), MethodInfo * info EncodingTarget p) => IsLabelProxy t (EncodingTarget -> p) Source #
Methods fromLabelProxy :: Proxy Symbol t -> EncodingTarget -> p #
HasAttributeList * EncodingTarget Source #

type AttributeList EncodingTarget Source #
type AttributeList EncodingTarget
type SignalList EncodingTarget Source #
type SignalList EncodingTarget

class GObject o => IsEncodingTarget o Source #

Instances

(GObject a, UnknownAncestorError Constraint EncodingTarget a) => IsEncodingTarget a Source #

IsEncodingTarget EncodingTarget Source #

toEncodingTarget :: IsEncodingTarget o => o -> IO EncodingTarget Source #

noEncodingTarget :: Maybe EncodingTarget Source #

Methods

addProfile

data EncodingTargetAddProfileMethodInfo Source #

Instances

((~) * signature (b -> m Bool), MonadIO m, IsEncodingTarget a, IsEncodingProfile b) => MethodInfo * EncodingTargetAddProfileMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy EncodingTargetAddProfileMethodInfo a -> signature -> s #

encodingTargetAddProfile Source #

Arguments

:: (HasCallStack, MonadIO m, IsEncodingTarget a, IsEncodingProfile b)
=> a	`target`: the `EncodingTarget` to add a profile to
-> b	`profile`: the `EncodingProfile` to add
-> m Bool	Returns: `True` if the profile was added, else `False`.

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

data EncodingTargetGetCategoryMethodInfo Source #

Instances

((~) * signature (m Text), MonadIO m, IsEncodingTarget a) => MethodInfo * EncodingTargetGetCategoryMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy EncodingTargetGetCategoryMethodInfo a -> signature -> s #

encodingTargetGetCategory Source #

Arguments

:: (HasCallStack, MonadIO m, IsEncodingTarget a)
=> a	`target`: a `EncodingTarget`
-> m Text	Returns: The category of the `target`. For example: `ENCODING_CATEGORY_DEVICE`.

No description available in the introspection data.

getDescription

data EncodingTargetGetDescriptionMethodInfo Source #

Instances

((~) * signature (m Text), MonadIO m, IsEncodingTarget a) => MethodInfo * EncodingTargetGetDescriptionMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy EncodingTargetGetDescriptionMethodInfo a -> signature -> s #

encodingTargetGetDescription Source #

Arguments

:: (HasCallStack, MonadIO m, IsEncodingTarget a)
=> a	`target`: a `EncodingTarget`
-> m Text	Returns: The description of the `target`.

No description available in the introspection data.

getName

data EncodingTargetGetNameMethodInfo Source #

Instances

((~) * signature (m Text), MonadIO m, IsEncodingTarget a) => MethodInfo * EncodingTargetGetNameMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy EncodingTargetGetNameMethodInfo a -> signature -> s #

encodingTargetGetName Source #

Arguments

:: (HasCallStack, MonadIO m, IsEncodingTarget a)
=> a	`target`: a `EncodingTarget`
-> m Text	Returns: The name of the `target`.

No description available in the introspection data.

getProfile

data EncodingTargetGetProfileMethodInfo Source #

Instances

((~) * signature (Text -> m EncodingProfile), MonadIO m, IsEncodingTarget a) => MethodInfo * EncodingTargetGetProfileMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy EncodingTargetGetProfileMethodInfo a -> signature -> s #

encodingTargetGetProfile Source #

Arguments

:: (HasCallStack, MonadIO m, IsEncodingTarget a)
=> a	`target`: a `EncodingTarget`
-> Text	`name`: the name of the profile to retrieve
-> m EncodingProfile	Returns: The matching `EncodingProfile`, or `Nothing`.

No description available in the introspection data.

getProfiles

data EncodingTargetGetProfilesMethodInfo Source #

Instances

((~) * signature (m [EncodingProfile]), MonadIO m, IsEncodingTarget a) => MethodInfo * EncodingTargetGetProfilesMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy EncodingTargetGetProfilesMethodInfo a -> signature -> s #

encodingTargetGetProfiles Source #

Arguments

:: (HasCallStack, MonadIO m, IsEncodingTarget a)
=> a	`target`: a `EncodingTarget`
-> m [EncodingProfile]	Returns: A list of `EncodingProfile`(s) this `target` handles.

No description available in the introspection data.

load

encodingTargetLoad Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Text	`name`: the name of the `EncodingTarget` to load.
-> Maybe Text	`category`: the name of the target category, like `ENCODING_CATEGORY_DEVICE`. Can be `Nothing`
-> m EncodingTarget	Returns: The `EncodingTarget` if available, else `Nothing`. (Can throw `GError`)

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 #

Arguments

:: (HasCallStack, MonadIO m)
=> Text	`filepath`: The file location to load the `EncodingTarget` from
-> m EncodingTarget	Returns: The `EncodingTarget` contained in the file, else `Nothing` (Can throw `GError`)

Opens the provided file and returns the contained EncodingTarget.

new

encodingTargetNew Source #

Arguments

:: (HasCallStack, MonadIO m, IsEncodingProfile a)
=> Text	`name`: The name of the target.
-> Text	`category`: The name of the category to which this `target` belongs. For example: `ENCODING_CATEGORY_DEVICE`.
-> Text	`description`: A description of `EncodingTarget` in the current locale.
-> [a]	`profiles`: A `List` of `EncodingProfile`.
-> m EncodingTarget	Returns: The newly created `EncodingTarget` or `Nothing` if there was an error.

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 <emphasis>should</emphasis> be one of the existing well-defined categories, like ENCODING_CATEGORY_DEVICE, but it <emphasis>can</emphasis> be a application or user specific category if needed.

save

data EncodingTargetSaveMethodInfo Source #

Instances

((~) * signature (m ()), MonadIO m, IsEncodingTarget a) => MethodInfo * EncodingTargetSaveMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy EncodingTargetSaveMethodInfo a -> signature -> s #

encodingTargetSave Source #

Arguments

:: (HasCallStack, MonadIO m, IsEncodingTarget a)
=> a	`target`: a `EncodingTarget`
-> m ()	(Can throw `GError`)

Saves the target to a default user-local directory.

saveToFile

data EncodingTargetSaveToFileMethodInfo Source #

Instances

((~) * signature (Text -> m ()), MonadIO m, IsEncodingTarget a) => MethodInfo * EncodingTargetSaveToFileMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy EncodingTargetSaveToFileMethodInfo a -> signature -> s #

encodingTargetSaveToFile Source #

Arguments

:: (HasCallStack, MonadIO m, IsEncodingTarget a)
=> a	`target`: a `EncodingTarget`
-> Text	`filepath`: the location to store the `target` at.
-> m ()	(Can throw `GError`)

Saves the target to the provided file location.