GstEncodingProfile

GstPbutils.EncodingAudioProfile

GObject.Object
    ╰──GstPbutils.EncodingProfile
        ╰──GstPbutils.EncodingAudioProfile

GstPbutils.EncodingAudioProfile.prototype.new

function GstPbutils.EncodingAudioProfile.prototype.new(format: Gst.Caps, preset: String, restriction: Gst.Caps, presence: Number): {
    // javascript wrapper for 'gst_encoding_audio_profile_new'
}

Creates a new GstPbutils.EncodingAudioProfile

All provided allocatable arguments will be internally copied, so can be safely freed/unreferenced after calling this method.

GstPbutils.EncodingContainerProfile

GObject.Object
    ╰──GstPbutils.EncodingProfile
        ╰──GstPbutils.EncodingContainerProfile

GstPbutils.EncodingContainerProfile.prototype.new

function GstPbutils.EncodingContainerProfile.prototype.new(name: String, description: String, format: Gst.Caps, preset: String): {
    // javascript wrapper for 'gst_encoding_container_profile_new'
}

Creates a new GstPbutils.EncodingContainerProfile.

GstPbutils.EncodingContainerProfile.prototype.add_profile

function GstPbutils.EncodingContainerProfile.prototype.add_profile(profile: GstPbutils.EncodingProfile): {
    // javascript wrapper for 'gst_encoding_container_profile_add_profile'
}

Add a GstPbutils.EncodingProfile to the list of profiles handled by container.

No copy of profile will be made, if you wish to use it elsewhere after this method you should increment its reference count.

GstPbutils.EncodingContainerProfile.prototype.contains_profile

function GstPbutils.EncodingContainerProfile.prototype.contains_profile(profile: GstPbutils.EncodingProfile): {
    // javascript wrapper for 'gst_encoding_container_profile_contains_profile'
}

Checks if container contains a GstPbutils.EncodingProfile identical to profile.

GstPbutils.EncodingContainerProfile.prototype.get_profiles

function GstPbutils.EncodingContainerProfile.prototype.get_profiles(): {
    // javascript wrapper for 'gst_encoding_container_profile_get_profiles'
}

GstPbutils.EncodingProfile

GObject.Object
    ╰──GstPbutils.EncodingProfile
        ╰──GstPbutils.EncodingAudioProfile
        ╰──GstPbutils.EncodingContainerProfile
        ╰──GstPbutils.EncodingVideoProfile

GstPbutils.EncodingProfile.prototype.copy

function GstPbutils.EncodingProfile.prototype.copy(): {
    // javascript wrapper for 'gst_encoding_profile_copy'
}

Makes a deep copy of self

Since : 1.12

GstPbutils.EncodingProfile.prototype.get_allow_dynamic_output

function GstPbutils.EncodingProfile.prototype.get_allow_dynamic_output(): {
    // javascript wrapper for 'gst_encoding_profile_get_allow_dynamic_output'
}

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

GstPbutils.EncodingProfile.prototype.get_description

function GstPbutils.EncodingProfile.prototype.get_description(): {
    // javascript wrapper for 'gst_encoding_profile_get_description'
}

GstPbutils.EncodingProfile.prototype.get_element_properties

function GstPbutils.EncodingProfile.prototype.get_element_properties(): {
    // javascript wrapper for 'gst_encoding_profile_get_element_properties'
}

Since : 1.20

GstPbutils.EncodingProfile.prototype.get_file_extension

function GstPbutils.EncodingProfile.prototype.get_file_extension(): {
    // javascript wrapper for 'gst_encoding_profile_get_file_extension'
}

GstPbutils.EncodingProfile.prototype.get_format

function GstPbutils.EncodingProfile.prototype.get_format(): {
    // javascript wrapper for 'gst_encoding_profile_get_format'
}

GstPbutils.EncodingProfile.prototype.get_input_caps

function GstPbutils.EncodingProfile.prototype.get_input_caps(): {
    // javascript wrapper for 'gst_encoding_profile_get_input_caps'
}

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

GstPbutils.EncodingProfile.prototype.get_name

function GstPbutils.EncodingProfile.prototype.get_name(): {
    // javascript wrapper for 'gst_encoding_profile_get_name'
}

GstPbutils.EncodingProfile.prototype.get_presence

function GstPbutils.EncodingProfile.prototype.get_presence(): {
    // javascript wrapper for 'gst_encoding_profile_get_presence'
}

GstPbutils.EncodingProfile.prototype.get_preset

function GstPbutils.EncodingProfile.prototype.get_preset(): {
    // javascript wrapper for 'gst_encoding_profile_get_preset'
}

GstPbutils.EncodingProfile.prototype.get_preset_name

function GstPbutils.EncodingProfile.prototype.get_preset_name(): {
    // javascript wrapper for 'gst_encoding_profile_get_preset_name'
}

GstPbutils.EncodingProfile.prototype.get_restriction

function GstPbutils.EncodingProfile.prototype.get_restriction(): {
    // javascript wrapper for 'gst_encoding_profile_get_restriction'
}

GstPbutils.EncodingProfile.prototype.get_single_segment

function GstPbutils.EncodingProfile.prototype.get_single_segment(): {
    // javascript wrapper for 'gst_encoding_profile_get_single_segment'
}

Since : 1.18

GstPbutils.EncodingProfile.prototype.get_type_nick

function GstPbutils.EncodingProfile.prototype.get_type_nick(): {
    // javascript wrapper for 'gst_encoding_profile_get_type_nick'
}

GstPbutils.EncodingProfile.prototype.is_enabled

function GstPbutils.EncodingProfile.prototype.is_enabled(): {
    // javascript wrapper for 'gst_encoding_profile_is_enabled'
}

GstPbutils.EncodingProfile.prototype.is_equal

function GstPbutils.EncodingProfile.prototype.is_equal(b: GstPbutils.EncodingProfile): {
    // javascript wrapper for 'gst_encoding_profile_is_equal'
}

Checks whether the two GstPbutils.EncodingProfile are equal

GstPbutils.EncodingProfile.prototype.set_allow_dynamic_output

function GstPbutils.EncodingProfile.prototype.set_allow_dynamic_output(allow_dynamic_output: Number): {
    // javascript wrapper for 'gst_encoding_profile_set_allow_dynamic_output'
}

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

GstPbutils.EncodingProfile.prototype.set_description

function GstPbutils.EncodingProfile.prototype.set_description(description: String): {
    // javascript wrapper for 'gst_encoding_profile_set_description'
}

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

GstPbutils.EncodingProfile.prototype.set_element_properties

function GstPbutils.EncodingProfile.prototype.set_element_properties(element_properties: Gst.Structure): {
    // javascript wrapper for 'gst_encoding_profile_set_element_properties'
}

This allows setting the muxing/encoding element properties.

Set properties generically

 [element-properties, boolean-prop=true, string-prop="hi"]

Mapping properties with well known element factories

element-properties-map, map = {
     [openh264enc, gop-size=32, ],
     [x264enc, key-int-max=32, tune=zerolatency],
 }

Since : 1.20

GstPbutils.EncodingProfile.prototype.set_enabled

function GstPbutils.EncodingProfile.prototype.set_enabled(enabled: Number): {
    // javascript wrapper for 'gst_encoding_profile_set_enabled'
}

Set whether the profile should be used or not.

Since : 1.6

GstPbutils.EncodingProfile.prototype.set_format

function GstPbutils.EncodingProfile.prototype.set_format(format: Gst.Caps): {
    // javascript wrapper for 'gst_encoding_profile_set_format'
}

Sets the media format used in the profile.

GstPbutils.EncodingProfile.prototype.set_name

function GstPbutils.EncodingProfile.prototype.set_name(name: String): {
    // javascript wrapper for 'gst_encoding_profile_set_name'
}

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

GstPbutils.EncodingProfile.prototype.set_presence

function GstPbutils.EncodingProfile.prototype.set_presence(presence: Number): {
    // javascript wrapper for 'gst_encoding_profile_set_presence'
}

Set the number of time the profile is used in its parent container profile. If 0, it is not a mandatory stream

GstPbutils.EncodingProfile.prototype.set_preset

function GstPbutils.EncodingProfile.prototype.set_preset(preset: String): {
    // javascript wrapper for 'gst_encoding_profile_set_preset'
}

Sets the name of the preset to be used in the profile. This is the name that has been set when saving the preset. You can list the available presets for a specific element factory using $ gst-inspect-1.0 element-factory-name, for example for x264enc:

$ gst-inspect-1.0 x264enc
...
Presets:
 "Profile Baseline": Baseline Profile
 "Profile High": High Profile
 "Profile Main": Main Profile
 "Profile YouTube": YouTube recommended settings (https://support.google.com/youtube/answer/1722171)
 "Quality High": High quality
 "Quality Low": Low quality
 "Quality Normal": Normal quality
 "Zero Latency"

}

GstPbutils.EncodingProfile.prototype.set_preset_name

function GstPbutils.EncodingProfile.prototype.set_preset_name(preset_name: String): {
    // javascript wrapper for 'gst_encoding_profile_set_preset_name'
}

Sets the name of the Gst.Preset's factory to be used in the profile. This is the name of the element factory that implements the Gst.Preset interface not the name of the preset itself (see GstPbutils.EncodingProfile.prototype.set_preset).

GstPbutils.EncodingProfile.prototype.set_restriction

function GstPbutils.EncodingProfile.prototype.set_restriction(restriction: Gst.Caps): {
    // javascript wrapper for 'gst_encoding_profile_set_restriction'
}

Set the restriction Gst.Caps to apply before the encoder that will be used in the profile. See GstPbutils.EncodingProfile.prototype.get_restriction for more about restrictions. Does not apply to GstPbutils.EncodingContainerProfile.

GstPbutils.EncodingProfile.prototype.set_single_segment

function GstPbutils.EncodingProfile.prototype.set_single_segment(single_segment: Number): {
    // javascript wrapper for 'gst_encoding_profile_set_single_segment'
}

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 avoid-reencoding (not introspectable)

Since : 1.18

GstPbutils.EncodingProfile.prototype.to_string

function GstPbutils.EncodingProfile.prototype.to_string(): {
    // javascript wrapper for 'gst_encoding_profile_to_string'
}

Converts a GstEncodingProfile to a string in the "Encoding Profile serialization format".

Since : 1.26

GstPbutils.EncodingProfile.prototype.find

function GstPbutils.EncodingProfile.prototype.find(targetname: String, profilename: String, category: String): {
    // javascript wrapper for 'gst_encoding_profile_find'
}

Find the GstPbutils.EncodingProfile with the specified name and category.

GstPbutils.EncodingProfile.prototype.from_discoverer

function GstPbutils.EncodingProfile.prototype.from_discoverer(info: GstPbutils.DiscovererInfo): {
    // javascript wrapper for 'gst_encoding_profile_from_discoverer'
}

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

GstPbutils.EncodingProfile.prototype.from_string

function GstPbutils.EncodingProfile.prototype.from_string(string: String): {
    // javascript wrapper for 'gst_encoding_profile_from_string'
}

Converts a string in the "encoding profile serialization format" into a GstEncodingProfile. Refer to the encoding-profile documentation for details on the format.

Since : 1.26

element-properties

“element-properties” Gst.Structure

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

Flags : Read / Write

Since : 1.20

restriction-caps

“restriction-caps” Gst.Caps

Flags : Read / Write

GstPbutils.EncodingVideoProfile

GObject.Object
    ╰──GstPbutils.EncodingProfile
        ╰──GstPbutils.EncodingVideoProfile

GstPbutils.EncodingVideoProfile.prototype.new

function GstPbutils.EncodingVideoProfile.prototype.new(format: Gst.Caps, preset: String, restriction: Gst.Caps, presence: Number): {
    // javascript wrapper for 'gst_encoding_video_profile_new'
}

Creates a new GstPbutils.EncodingVideoProfile

All provided allocatable arguments will be internally copied, so can be safely freed/unreferenced after calling this method.

If you wish to control the pass number (in case of multi-pass scenarios), please refer to the GstPbutils.EncodingVideoProfile.prototype.set_pass documentation.

If you wish to use/force a constant framerate please refer to the GstPbutils.EncodingVideoProfile.prototype.set_variableframerate documentation.

GstPbutils.EncodingVideoProfile.prototype.get_pass

function GstPbutils.EncodingVideoProfile.prototype.get_pass(): {
    // javascript wrapper for 'gst_encoding_video_profile_get_pass'
}

Get the pass number if this is part of a multi-pass profile.

GstPbutils.EncodingVideoProfile.prototype.get_variableframerate

function GstPbutils.EncodingVideoProfile.prototype.get_variableframerate(): {
    // javascript wrapper for 'gst_encoding_video_profile_get_variableframerate'
}

NOTE: Fixed framerate won't be enforced when avoid-reencoding (not introspectable) is set.

GstPbutils.EncodingVideoProfile.prototype.set_pass

function GstPbutils.EncodingVideoProfile.prototype.set_pass(pass: Number): {
    // javascript wrapper for 'gst_encoding_video_profile_set_pass'
}

Sets the pass number of this video profile. The first pass profile should have this value set to 1. If this video profile isn't part of a multi-pass profile, you may set it to 0 (the default value).

GstPbutils.EncodingVideoProfile.prototype.set_variableframerate

function GstPbutils.EncodingVideoProfile.prototype.set_variableframerate(variableframerate: Number): {
    // javascript wrapper for 'gst_encoding_video_profile_set_variableframerate'
}

If set to true, then the incoming stream will be allowed to have non-constant framerate. If set to false (default value), then the incoming stream will be normalized by dropping/duplicating frames in order to produce a constance framerate.