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 |
- Exported types
- Methods
- copy
- find
- fromDiscoverer
- getAllowDynamicOutput
- getDescription
- getElementProperties
- getFileExtension
- getFormat
- getInputCaps
- getName
- getPresence
- getPreset
- getPresetName
- getRestriction
- getSingleSegment
- getTypeNick
- isEnabled
- isEqual
- setAllowDynamicOutput
- setDescription
- setElementProperties
- setEnabled
- setFormat
- setName
- setPresence
- setPreset
- setPresetName
- setRestriction
- setSingleSegment
- Properties
The opaque base class object for all encoding profiles. This contains generic information like name, description, format and preset.
Synopsis
- newtype EncodingProfile = EncodingProfile (ManagedPtr EncodingProfile)
- class (GObject o, IsDescendantOf EncodingProfile o) => IsEncodingProfile o
- toEncodingProfile :: (MonadIO m, IsEncodingProfile o) => o -> m EncodingProfile
- encodingProfileCopy :: (HasCallStack, MonadIO m, IsEncodingProfile a) => a -> m EncodingProfile
- encodingProfileFind :: (HasCallStack, MonadIO m) => Text -> Maybe Text -> Maybe Text -> m (Maybe EncodingProfile)
- encodingProfileFromDiscoverer :: (HasCallStack, MonadIO m, IsDiscovererInfo a) => a -> m (Maybe EncodingProfile)
- encodingProfileGetAllowDynamicOutput :: (HasCallStack, MonadIO m, IsEncodingProfile a) => a -> m Bool
- encodingProfileGetDescription :: (HasCallStack, MonadIO m, IsEncodingProfile a) => a -> m (Maybe Text)
- encodingProfileGetElementProperties :: (HasCallStack, MonadIO m, IsEncodingProfile a) => a -> m (Maybe Structure)
- encodingProfileGetFileExtension :: (HasCallStack, MonadIO m, IsEncodingProfile a) => a -> m (Maybe Text)
- encodingProfileGetFormat :: (HasCallStack, MonadIO m, IsEncodingProfile a) => a -> m Caps
- encodingProfileGetInputCaps :: (HasCallStack, MonadIO m, IsEncodingProfile a) => a -> m Caps
- encodingProfileGetName :: (HasCallStack, MonadIO m, IsEncodingProfile a) => a -> m (Maybe Text)
- encodingProfileGetPresence :: (HasCallStack, MonadIO m, IsEncodingProfile a) => a -> m Word32
- encodingProfileGetPreset :: (HasCallStack, MonadIO m, IsEncodingProfile a) => a -> m (Maybe Text)
- encodingProfileGetPresetName :: (HasCallStack, MonadIO m, IsEncodingProfile a) => a -> m (Maybe Text)
- encodingProfileGetRestriction :: (HasCallStack, MonadIO m, IsEncodingProfile a) => a -> m (Maybe Caps)
- encodingProfileGetSingleSegment :: (HasCallStack, MonadIO m, IsEncodingProfile a) => a -> m Bool
- encodingProfileGetTypeNick :: (HasCallStack, MonadIO m, IsEncodingProfile a) => a -> m Text
- encodingProfileIsEnabled :: (HasCallStack, MonadIO m, IsEncodingProfile a) => a -> m Bool
- encodingProfileIsEqual :: (HasCallStack, MonadIO m, IsEncodingProfile a, IsEncodingProfile b) => a -> b -> m Bool
- encodingProfileSetAllowDynamicOutput :: (HasCallStack, MonadIO m, IsEncodingProfile a) => a -> Bool -> m ()
- encodingProfileSetDescription :: (HasCallStack, MonadIO m, IsEncodingProfile a) => a -> Maybe Text -> m ()
- encodingProfileSetElementProperties :: (HasCallStack, MonadIO m, IsEncodingProfile a) => a -> Structure -> m ()
- encodingProfileSetEnabled :: (HasCallStack, MonadIO m, IsEncodingProfile a) => a -> Bool -> m ()
- encodingProfileSetFormat :: (HasCallStack, MonadIO m, IsEncodingProfile a) => a -> Caps -> m ()
- encodingProfileSetName :: (HasCallStack, MonadIO m, IsEncodingProfile a) => a -> Maybe Text -> m ()
- encodingProfileSetPresence :: (HasCallStack, MonadIO m, IsEncodingProfile a) => a -> Word32 -> m ()
- encodingProfileSetPreset :: (HasCallStack, MonadIO m, IsEncodingProfile a) => a -> Maybe Text -> m ()
- encodingProfileSetPresetName :: (HasCallStack, MonadIO m, IsEncodingProfile a) => a -> Maybe Text -> m ()
- encodingProfileSetRestriction :: (HasCallStack, MonadIO m, IsEncodingProfile a) => a -> Maybe Caps -> m ()
- encodingProfileSetSingleSegment :: (HasCallStack, MonadIO m, IsEncodingProfile a) => a -> Bool -> m ()
- clearEncodingProfileElementProperties :: (MonadIO m, IsEncodingProfile o) => o -> m ()
- constructEncodingProfileElementProperties :: (IsEncodingProfile o, MonadIO m) => Structure -> m (GValueConstruct o)
- getEncodingProfileElementProperties :: (MonadIO m, IsEncodingProfile o) => o -> m (Maybe Structure)
- setEncodingProfileElementProperties :: (MonadIO m, IsEncodingProfile o) => o -> Structure -> m ()
- clearEncodingProfileRestrictionCaps :: (MonadIO m, IsEncodingProfile o) => o -> m ()
- constructEncodingProfileRestrictionCaps :: (IsEncodingProfile o, MonadIO m) => Caps -> m (GValueConstruct o)
- getEncodingProfileRestrictionCaps :: (MonadIO m, IsEncodingProfile o) => o -> m (Maybe Caps)
- setEncodingProfileRestrictionCaps :: (MonadIO m, IsEncodingProfile o) => o -> Caps -> m ()
Exported types
newtype EncodingProfile Source #
Memory-managed wrapper type.
EncodingProfile (ManagedPtr EncodingProfile) |
Instances
class (GObject o, IsDescendantOf EncodingProfile o) => IsEncodingProfile o Source #
Type class for types which can be safely cast to EncodingProfile
, for instance with toEncodingProfile
.
Instances
(GObject o, IsDescendantOf EncodingProfile o) => IsEncodingProfile o Source # | |
Defined in GI.GstPbutils.Objects.EncodingProfile |
toEncodingProfile :: (MonadIO m, IsEncodingProfile o) => o -> m EncodingProfile Source #
Cast to EncodingProfile
, 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
bindProperty, bindPropertyFull, copy, forceFloating, freezeNotify, getv, isEnabled, isEqual, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getAllowDynamicOutput, getData, getDescription, getElementProperties, getFileExtension, getFormat, getInputCaps, getName, getPresence, getPreset, getPresetName, getProperty, getQdata, getRestriction, getSingleSegment, getTypeNick.
Setters
setAllowDynamicOutput, setData, setDataFull, setDescription, setElementProperties, setEnabled, setFormat, setName, setPresence, setPreset, setPresetName, setProperty, setRestriction, setSingleSegment.
copy
:: (HasCallStack, MonadIO m, IsEncodingProfile a) | |
=> a |
|
-> m EncodingProfile | Returns: The copy of |
Makes a deep copy of self
Since: 1.12
find
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> Maybe Text |
|
-> Maybe Text |
|
-> m (Maybe EncodingProfile) | Returns: The matching |
Find the EncodingProfile
with the specified name and category.
fromDiscoverer
encodingProfileFromDiscoverer Source #
:: (HasCallStack, MonadIO m, IsDiscovererInfo a) | |
=> a |
|
-> m (Maybe EncodingProfile) | Returns: The new |
Creates a EncodingProfile
matching the formats from the given
DiscovererInfo
. Streams other than audio or video (eg,
subtitles), are currently ignored.
getAllowDynamicOutput
encodingProfileGetAllowDynamicOutput Source #
:: (HasCallStack, MonadIO m, IsEncodingProfile a) | |
=> a |
|
-> m Bool |
Get whether the format that has been negotiated in at some point can be renegotiated later during the encoding.
getDescription
encodingProfileGetDescription Source #
:: (HasCallStack, MonadIO m, IsEncodingProfile a) | |
=> a |
|
-> m (Maybe Text) | Returns: the description of the profile, can be |
No description available in the introspection data.
getElementProperties
encodingProfileGetElementProperties Source #
:: (HasCallStack, MonadIO m, IsEncodingProfile a) | |
=> a |
|
-> m (Maybe Structure) | Returns: The properties that are going to be set on the underlying element |
No description available in the introspection data.
Since: 1.20
getFileExtension
encodingProfileGetFileExtension Source #
:: (HasCallStack, MonadIO m, IsEncodingProfile a) | |
=> a |
|
-> m (Maybe Text) | Returns: a suitable file extension for |
No description available in the introspection data.
getFormat
encodingProfileGetFormat Source #
:: (HasCallStack, MonadIO m, IsEncodingProfile a) | |
=> a |
|
-> m Caps | Returns: (nullable): the |
No description available in the introspection data.
getInputCaps
encodingProfileGetInputCaps Source #
:: (HasCallStack, MonadIO m, IsEncodingProfile a) | |
=> a |
|
-> m Caps | Returns: The full caps the given |
Computes the full output caps that this profile
will be able to consume.
getName
encodingProfileGetName Source #
:: (HasCallStack, MonadIO m, IsEncodingProfile a) | |
=> a |
|
-> m (Maybe Text) | Returns: the name of the profile, can be |
No description available in the introspection data.
getPresence
encodingProfileGetPresence Source #
:: (HasCallStack, MonadIO m, IsEncodingProfile a) | |
=> a |
|
-> m Word32 | Returns: The number of times the profile is used in its parent container profile. If 0, it is not a mandatory stream. |
No description available in the introspection data.
getPreset
encodingProfileGetPreset Source #
:: (HasCallStack, MonadIO m, IsEncodingProfile a) | |
=> a |
|
-> m (Maybe Text) | Returns: the name of the |
No description available in the introspection data.
getPresetName
encodingProfileGetPresetName Source #
:: (HasCallStack, MonadIO m, IsEncodingProfile a) | |
=> a |
|
-> m (Maybe Text) | Returns: the name of the |
No description available in the introspection data.
getRestriction
encodingProfileGetRestriction Source #
:: (HasCallStack, MonadIO m, IsEncodingProfile a) | |
=> a |
|
-> m (Maybe Caps) | Returns: The restriction |
No description available in the introspection data.
getSingleSegment
encodingProfileGetSingleSegment Source #
:: (HasCallStack, MonadIO m, IsEncodingProfile a) | |
=> a |
|
-> m Bool | Returns: |
No description available in the introspection data.
Since: 1.18
getTypeNick
encodingProfileGetTypeNick Source #
:: (HasCallStack, MonadIO m, IsEncodingProfile a) | |
=> a |
|
-> m Text | Returns: the human-readable name of the type of |
No description available in the introspection data.
isEnabled
encodingProfileIsEnabled :: (HasCallStack, MonadIO m, IsEncodingProfile a) => a -> m Bool Source #
No description available in the introspection data.
isEqual
encodingProfileIsEqual Source #
:: (HasCallStack, MonadIO m, IsEncodingProfile a, IsEncodingProfile b) | |
=> a |
|
-> b |
|
-> m Bool |
Checks whether the two EncodingProfile
are equal
setAllowDynamicOutput
encodingProfileSetAllowDynamicOutput Source #
:: (HasCallStack, MonadIO m, IsEncodingProfile a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether the format that has been negotiated in at some point can be renegotiated later during the encoding.
setDescription
encodingProfileSetDescription Source #
:: (HasCallStack, MonadIO m, IsEncodingProfile a) | |
=> a |
|
-> Maybe Text |
|
-> m () |
Set description
as the given description for the profile
. A copy of
description
will be made internally.
setElementProperties
encodingProfileSetElementProperties Source #
:: (HasCallStack, MonadIO m, IsEncodingProfile a) | |
=> a |
|
-> Structure |
|
-> m () |
This allows setting the muxing/encoding element properties.
- *Set properties generically**
properties code
[element-properties, boolean-prop=true, string-prop="hi"]
- *Mapping properties with well known element factories**
properties code
element-properties-map, map = { [openh264enc, gop-size=32, ], [x264enc, key-int-max=32, tune=zerolatency], }
Since: 1.20
setEnabled
encodingProfileSetEnabled Source #
:: (HasCallStack, MonadIO m, IsEncodingProfile a) | |
=> a |
|
-> Bool | |
-> m () |
Set whether the profile should be used or not.
Since: 1.6
setFormat
encodingProfileSetFormat Source #
:: (HasCallStack, MonadIO m, IsEncodingProfile a) | |
=> a |
|
-> Caps |
|
-> m () |
Sets the media format used in the profile.
setName
encodingProfileSetName Source #
:: (HasCallStack, MonadIO m, IsEncodingProfile a) | |
=> a |
|
-> Maybe Text |
|
-> m () |
Set name
as the given name for the profile
. A copy of name
will be made
internally.
setPresence
encodingProfileSetPresence Source #
:: (HasCallStack, MonadIO m, IsEncodingProfile a) | |
=> a |
|
-> Word32 |
|
-> m () |
Set the number of time the profile is used in its parent container profile. If 0, it is not a mandatory stream
setPreset
encodingProfileSetPreset Source #
:: (HasCallStack, MonadIO m, IsEncodingProfile a) | |
=> a |
|
-> Maybe Text |
|
-> m () |
setPresetName
encodingProfileSetPresetName Source #
:: (HasCallStack, MonadIO m, IsEncodingProfile a) | |
=> a |
|
-> Maybe Text |
|
-> m () |
Sets the name of the Preset
's factory to be used in the profile.
setRestriction
encodingProfileSetRestriction Source #
:: (HasCallStack, MonadIO m, IsEncodingProfile a) | |
=> a |
|
-> Maybe Caps |
|
-> m () |
Set the restriction Caps
to apply before the encoder
that will be used in the profile. See encodingProfileGetRestriction
for more about restrictions. Does not apply to EncodingContainerProfile
.
setSingleSegment
encodingProfileSetSingleSegment Source #
:: (HasCallStack, MonadIO m, IsEncodingProfile a) | |
=> a |
|
-> Bool |
|
-> m () |
If using a single segment, buffers will be retimestamped and segments will be eat so as to appear as one segment.
*NOTE*: Single segment is not property supported when using @/encodebin:avoid-reencoding/@
Since: 1.18
Properties
elementProperties
A Structure
defining the properties to be set to the element
the profile represents.
For example for av1enc
:
element-properties,row-mt=true, end-usage=vbr
Since: 1.20
clearEncodingProfileElementProperties :: (MonadIO m, IsEncodingProfile o) => o -> m () Source #
Set the value of the “element-properties
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#elementProperties
constructEncodingProfileElementProperties :: (IsEncodingProfile o, MonadIO m) => Structure -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “element-properties
” property. This is rarely needed directly, but it is used by new
.
getEncodingProfileElementProperties :: (MonadIO m, IsEncodingProfile o) => o -> m (Maybe Structure) Source #
Get the value of the “element-properties
” property.
When overloading is enabled, this is equivalent to
get
encodingProfile #elementProperties
setEncodingProfileElementProperties :: (MonadIO m, IsEncodingProfile o) => o -> Structure -> m () Source #
Set the value of the “element-properties
” property.
When overloading is enabled, this is equivalent to
set
encodingProfile [ #elementProperties:=
value ]
restrictionCaps
No description available in the introspection data.
clearEncodingProfileRestrictionCaps :: (MonadIO m, IsEncodingProfile o) => o -> m () Source #
Set the value of the “restriction-caps
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#restrictionCaps
constructEncodingProfileRestrictionCaps :: (IsEncodingProfile o, MonadIO m) => Caps -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “restriction-caps
” property. This is rarely needed directly, but it is used by new
.
getEncodingProfileRestrictionCaps :: (MonadIO m, IsEncodingProfile o) => o -> m (Maybe Caps) Source #
Get the value of the “restriction-caps
” property.
When overloading is enabled, this is equivalent to
get
encodingProfile #restrictionCaps
setEncodingProfileRestrictionCaps :: (MonadIO m, IsEncodingProfile o) => o -> Caps -> m () Source #
Set the value of the “restriction-caps
” property.
When overloading is enabled, this is equivalent to
set
encodingProfile [ #restrictionCaps:=
value ]