Package org.freedesktop.gstreamer.pbutils

Class EncodingProfile

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.freedesktop.gstreamer.pbutils.EncodingProfile

All Implemented Interfaces:

Proxy

Direct Known Subclasses:

EncodingAudioProfile, EncodingContainerProfile, EncodingVideoProfile

@Generated("io.github.jwharm.JavaGI")
public class EncodingProfile
extends GObject

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EncodingProfile.Builder<B extends EncodingProfile.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	EncodingProfile.EncodingProfileClass

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
EncodingProfile(MemorySegment address)	Create a EncodingProfile proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected EncodingProfile	asParent()	Returns this instance as if it were its parent type.
static EncodingProfile.Builder<? extends EncodingProfile.Builder>	builder()	A EncodingProfile.Builder object constructs a EncodingProfile with the specified properties.
EncodingProfile	copy()	Makes a deep copy of this EncodingProfile
static EncodingProfile	find(String targetname, @Nullable String profilename, @Nullable String category)	Find the GstEncodingProfile with the specified name and category.
static EncodingProfile	fromDiscoverer(DiscovererInfo info)	Creates a GstEncodingProfile matching the formats from the given GstDiscovererInfo.
boolean	getAllowDynamicOutput()	Get whether the format that has been negotiated in at some point can be renegotiated later during the encoding.
String	getDescription()
Structure	getElementProperties()
String	getFileExtension()
Caps	getFormat()
Caps	getInputCaps()	Computes the full output caps that this this EncodingProfile will be able to consume.
String	getName()
int	getPresence()
String	getPreset()
String	getPresetName()
Caps	getRestriction()
boolean	getSingleSegment()
static Type	getType()	Get the GType of the EncodingProfile class
String	getTypeNick()
boolean	isEnabled()
boolean	isEqual(EncodingProfile b)	Checks whether the two GstEncodingProfile are equal
void	setAllowDynamicOutput(boolean allowDynamicOutput)	Sets whether the format that has been negotiated in at some point can be renegotiated later during the encoding.
void	setDescription(@Nullable String description)	Set description as the given description for the this EncodingProfile.
void	setElementProperties(Structure elementProperties)	This allows setting the muxing/encoding element properties.
void	setEnabled(boolean enabled)	Set whether the profile should be used or not.
void	setFormat(Caps format)	Sets the media format used in the profile.
void	setName(@Nullable String name)	Set name as the given name for the this EncodingProfile.
void	setPresence(int presence)	Set the number of time the profile is used in its parent container profile.
void	setPreset(@Nullable String preset)	Sets the name of the GstElement that implements the GstPreset interface to use for the profile.
void	setPresetName(@Nullable String presetName)	Sets the name of the GstPreset's factory to be used in the profile.
void	setRestriction(@Nullable Caps restriction)	Set the restriction GstCaps to apply before the encoder that will be used in the profile.
void	setSingleSegment(boolean singleSegment)	If using a single segment, buffers will be retimestamped and segments will be eat so as to appear as one segment.

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getMemoryLayout, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EncodingProfile

public EncodingProfile(MemorySegment address)

Create a EncodingProfile proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Method Details

getType

public static Type getType()

Get the GType of the EncodingProfile class

Returns:

the GType

asParent

protected EncodingProfile asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class GObject

find

public static EncodingProfile find(String targetname,
 @Nullable
 @Nullable String profilename,
 @Nullable
 @Nullable String category)

Find the GstEncodingProfile with the specified name and category.

Parameters:

targetname - The name of the target

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

category - The target category. Can be null

Returns:

The matching GstEncodingProfile or null.

fromDiscoverer

public static EncodingProfile fromDiscoverer(DiscovererInfo info)

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

Parameters:

info - The GstDiscovererInfo to read from

Returns:

The new GstEncodingProfile or null.

copy

public EncodingProfile copy()

Makes a deep copy of this EncodingProfile

Returns:

The copy of this EncodingProfile

getAllowDynamicOutput

public boolean getAllowDynamicOutput()

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

getDescription

public String getDescription()

getElementProperties

public Structure getElementProperties()

getFileExtension

public String getFileExtension()

getFormat

public Caps getFormat()

getInputCaps

public Caps getInputCaps()

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

Returns:

The full caps the given this EncodingProfile can consume. Call gst_caps_unref() when you are done with the caps.

getName

public String getName()

getPresence

public int getPresence()

getPreset

public String getPreset()

getPresetName

public String getPresetName()

getRestriction

public Caps getRestriction()

getSingleSegment

public boolean getSingleSegment()

getTypeNick

public String getTypeNick()

isEnabled

public boolean isEnabled()

isEqual

public boolean isEqual(EncodingProfile b)

Checks whether the two GstEncodingProfile are equal

Parameters:

b - a GstEncodingProfile

Returns:

true if this EncodingProfile and b are equal, else false.

setAllowDynamicOutput

public void setAllowDynamicOutput(boolean allowDynamicOutput)

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

Parameters:

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

setDescription

public void setDescription(@Nullable
 @Nullable String description)

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

Parameters:

description - the description to set on the profile

setElementProperties

public void setElementProperties(Structure elementProperties)

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],
  }
 

Parameters:

elementProperties - A GstStructure defining the properties to be set to the element the profile represents.

setEnabled

public void setEnabled(boolean enabled)

Set whether the profile should be used or not.

Parameters:

enabled - false to disable this EncodingProfile, true to enable it

setFormat

public void setFormat(Caps format)

Sets the media format used in the profile.

Parameters:

format - the media format to use in the profile.

setName

public void setName(@Nullable
 @Nullable String name)

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

Parameters:

name - the name to set on the profile

setPresence

public void setPresence(int presence)

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

Parameters:

presence - the number of time the profile can be used

setPreset

public void setPreset(@Nullable
 @Nullable String preset)

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

Parameters:

preset - the element preset to use

setPresetName

public void setPresetName(@Nullable
 @Nullable String presetName)

Sets the name of the GstPreset's factory to be used in the profile.

Parameters:

presetName - The name of the preset to use in this this EncodingProfile.

setRestriction

public void setRestriction(@Nullable
 @Nullable Caps restriction)

Set the restriction GstCaps to apply before the encoder that will be used in the profile. See gst_encoding_profile_get_restriction() for more about restrictions. Does not apply to GstEncodingContainerProfile.

Parameters:

restriction - the restriction to apply

setSingleSegment

public void setSingleSegment(boolean singleSegment)

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

Parameters:

singleSegment - TRUE if the stream represented by this EncodingProfile should use a single segment before the encoder, FALSE otherwise.

builder

public static EncodingProfile.Builder<? extends EncodingProfile.Builder> builder()

A EncodingProfile.Builder object constructs a EncodingProfile with the specified properties. Use the various set...() methods to set properties, and finish construction with EncodingProfile.Builder.build().