GI.GstPbutils.Objects.EncodingProfile

The opaque base class object for all encoding profiles. This contains generic information like name, description, format and preset.

Exported types

newtype EncodingProfile

Memory-managed wrapper type.

Constructors

EncodingProfile (ManagedPtr EncodingProfile)

Instances

GObject EncodingProfile

Defined in GI.GstPbutils.Objects.EncodingProfile

Methods

gobjectType :: IO GType

HasParentTypes EncodingProfile

Defined in GI.GstPbutils.Objects.EncodingProfile

type ParentTypes EncodingProfile

Defined in GI.GstPbutils.Objects.EncodingProfile

type ParentTypes EncodingProfile = Object ': ([] :: [Type])

class (GObject o, IsDescendantOf EncodingProfile o) => IsEncodingProfile o

Type class for types which can be safely cast to EncodingProfile, for instance with toEncodingProfile.

Instances

(GObject o, IsDescendantOf EncodingProfile o) => IsEncodingProfile o

Defined in GI.GstPbutils.Objects.EncodingProfile

toEncodingProfile :: (MonadIO m, IsEncodingProfile o) => o -> m EncodingProfile

Cast to EncodingProfile, for types for which this is known to be safe. For general casts, use castTo.

noEncodingProfile :: Maybe EncodingProfile

A convenience alias for Nothing :: Maybe EncodingProfile.

Methods

copy

encodingProfileCopy

Arguments

:: (HasCallStack, MonadIO m, IsEncodingProfile a)

=> a

self: The EncodingProfile to copy

-> m EncodingProfile

Returns: The copy of self

Since 1.12

Makes a deep copy of self

find

encodingProfileFind

Arguments

:: (HasCallStack, MonadIO m)

=> Text

targetname: The name of the target

-> Maybe Text

profilename: The name of the profile, if Nothing provided, it will default to the encoding profile called default.

-> Maybe Text

category: The target category. Can be Nothing

-> m EncodingProfile

Returns: The matching EncodingProfile or Nothing.

Find the EncodingProfile with the specified name and category.

fromDiscoverer

encodingProfileFromDiscoverer

Arguments

:: (HasCallStack, MonadIO m, IsDiscovererInfo a)

=> a

info: The DiscovererInfo to read from

-> m EncodingProfile

Returns: The new EncodingProfile or Nothing.

Creates a EncodingProfile matching the formats from the given DiscovererInfo. Streams other than audio or video (eg, subtitles), are currently ignored.

getAllowDynamicOutput

encodingProfileGetAllowDynamicOutput

Arguments

:: (HasCallStack, MonadIO m, IsEncodingProfile a)

=> a

profile: a EncodingProfile

-> m Bool

Get whether the format that has been negotiated in at some point can be renegotiated later during the encoding.

getDescription

encodingProfileGetDescription

Arguments

:: (HasCallStack, MonadIO m, IsEncodingProfile a)

=> a

profile: a EncodingProfile

-> m Text

Returns: the description of the profile, can be Nothing.

No description available in the introspection data.

getFileExtension

encodingProfileGetFileExtension

Arguments

:: (HasCallStack, MonadIO m, IsEncodingProfile a)

=> a

profile: a EncodingProfile

-> m Text

Returns: a suitable file extension for profile, or NULL.

No description available in the introspection data.

getFormat

encodingProfileGetFormat

Arguments

:: (HasCallStack, MonadIO m, IsEncodingProfile a)

=> a

profile: a EncodingProfile

-> m Caps

Returns: the Caps corresponding to the media format used in the profile. Unref after usage.

No description available in the introspection data.

getInputCaps

encodingProfileGetInputCaps

Arguments

:: (HasCallStack, MonadIO m, IsEncodingProfile a)

=> a

profile: a EncodingProfile

-> m Caps

Returns: The full caps the given profile can consume. Call gst_caps_unref() when you are done with the caps.

Computes the full output caps that this profile will be able to consume.

getName

encodingProfileGetName

Arguments

:: (HasCallStack, MonadIO m, IsEncodingProfile a)

=> a

profile: a EncodingProfile

-> m Text

Returns: the name of the profile, can be Nothing.

No description available in the introspection data.

getPresence

encodingProfileGetPresence

Arguments

:: (HasCallStack, MonadIO m, IsEncodingProfile a)

=> a

profile: a EncodingProfile

-> 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

Arguments

:: (HasCallStack, MonadIO m, IsEncodingProfile a)

=> a

profile: a EncodingProfile

-> m Text

Returns: the name of the Preset to be used in the profile. This is the name that has been set when saving the preset.

No description available in the introspection data.

getPresetName

encodingProfileGetPresetName

Arguments

:: (HasCallStack, MonadIO m, IsEncodingProfile a)

=> a

profile: a EncodingProfile

-> m Text

Returns: the name of the Preset factory to be used in the profile.

No description available in the introspection data.

getRestriction

encodingProfileGetRestriction

Arguments

:: (HasCallStack, MonadIO m, IsEncodingProfile a)

=> a

profile: a EncodingProfile

-> m Caps

Returns: The restriction Caps to apply before the encoder that will be used in the profile. The fields present in restriction caps are properties of the raw stream (that is before encoding), such as height and width for video and depth and sampling rate for audio. Does not apply to EncodingContainerProfile (since there is no corresponding raw stream). Can be Nothing. Unref after usage.

No description available in the introspection data.

getTypeNick

encodingProfileGetTypeNick

Arguments

:: (HasCallStack, MonadIO m, IsEncodingProfile a)

=> a

profile: a EncodingProfile

-> m Text

Returns: the human-readable name of the type of profile.

No description available in the introspection data.

isEnabled

encodingProfileIsEnabled :: (HasCallStack, MonadIO m, IsEncodingProfile a) => a -> m Bool

No description available in the introspection data.

isEqual

encodingProfileIsEqual

Arguments

:: (HasCallStack, MonadIO m, IsEncodingProfile a, IsEncodingProfile b)

=> a

a: a EncodingProfile

-> b

b: a EncodingProfile

-> m Bool

Returns: True if a and b are equal, else False.

Checks whether the two EncodingProfile are equal

setAllowDynamicOutput

encodingProfileSetAllowDynamicOutput

Arguments

:: (HasCallStack, MonadIO m, IsEncodingProfile a)

=> a

profile: a EncodingProfile

-> Bool

allowDynamicOutput: Whether the format that has been negotiated first can be renegotiated during the encoding

-> m ()

Sets whether the format that has been negotiated in at some point can be renegotiated later during the encoding.

setDescription

encodingProfileSetDescription

Arguments

:: (HasCallStack, MonadIO m, IsEncodingProfile a)

=> a

profile: a EncodingProfile

-> Maybe Text

description: the description to set on the profile

-> m ()

Set description as the given description for the profile. A copy of description will be made internally.

setEnabled

encodingProfileSetEnabled

Arguments

:: (HasCallStack, MonadIO m, IsEncodingProfile a)

=> a

profile: a EncodingProfile

-> Bool

enabled: False to disable profile, True to enable it

-> m ()

Set whether the profile should be used or not.

Since 1.6

setFormat

encodingProfileSetFormat

Arguments

:: (HasCallStack, MonadIO m, IsEncodingProfile a)

=> a

profile: a EncodingProfile

-> Caps

format: the media format to use in the profile.

-> m ()

Sets the media format used in the profile.

setName

encodingProfileSetName

Arguments

:: (HasCallStack, MonadIO m, IsEncodingProfile a)

=> a

profile: a EncodingProfile

-> Maybe Text

name: the name to set on the profile

-> m ()

Set name as the given name for the profile. A copy of name will be made internally.

setPresence

encodingProfileSetPresence

Arguments

:: (HasCallStack, MonadIO m, IsEncodingProfile a)

=> a

profile: a EncodingProfile

-> Word32

presence: the number of time the profile can be used

-> 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

Arguments

:: (HasCallStack, MonadIO m, IsEncodingProfile a)

=> a

profile: a EncodingProfile

-> Maybe Text

preset: the element preset to use

-> m ()

Sets the name of the Element that implements the Preset interface to use for the profile. This is the name that has been set when saving the preset.

setPresetName

encodingProfileSetPresetName

Arguments

:: (HasCallStack, MonadIO m, IsEncodingProfile a)

=> a

profile: a EncodingProfile

-> Maybe Text

presetName: The name of the preset to use in this profile.

-> m ()

Sets the name of the 'GI.Gst.Interfaces.Preset.Preset'\'s factory to be used in the profile.

setRestriction

encodingProfileSetRestriction

Arguments

:: (HasCallStack, MonadIO m, IsEncodingProfile a)

=> a

profile: a EncodingProfile

-> Maybe Caps

restriction: the restriction to apply

-> 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.

Properties

restrictionCaps

No description available in the introspection data.

clearEncodingProfileRestrictionCaps :: (MonadIO m, IsEncodingProfile o) => o -> m ()

Set the value of the “restriction-caps” property to Nothing. When overloading is enabled, this is equivalent to

clear #restrictionCaps

constructEncodingProfileRestrictionCaps :: IsEncodingProfile o => Caps -> IO (GValueConstruct o)

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)

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 ()

Set the value of the “restriction-caps” property. When overloading is enabled, this is equivalent to

set encodingProfile [ #restrictionCaps := value ]