Package org.freedesktop.gstreamer.gst

Class ElementFactory

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gobject.InitiallyUnowned

org.freedesktop.gstreamer.gst.GstObject

org.freedesktop.gstreamer.gst.PluginFeature

org.freedesktop.gstreamer.gst.ElementFactory

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class ElementFactory
extends PluginFeature

GstElementFactory is used to create instances of elements. A GstElementFactory can be added to a GstPlugin as it is also a GstPluginFeature.

Use the gst_element_factory_find() and gst_element_factory_create() functions to create element instances or use gst_element_factory_make() as a convenient shortcut.

The following code example shows you how to create a GstFileSrc element.

Using an element factory

  #include <gst/gst.h>

   GstElement *src;
   GstElementFactory *srcfactory;

   gst_init (&argc, &argv);

   srcfactory = gst_element_factory_find ("filesrc");
   g_return_if_fail (srcfactory != NULL);
   src = gst_element_factory_create (srcfactory, "src");
   g_return_if_fail (src != NULL);
   ...
 

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.freedesktop.gstreamer.gst.PluginFeature

PluginFeature.PluginFeature$Impl, PluginFeature.PluginFeatureClass

Nested classes/interfaces inherited from class org.freedesktop.gstreamer.gst.GstObject

GstObject.DeepNotifyCallback, GstObject.Object$Impl, GstObject.ObjectClass

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

InitiallyUnowned.InitiallyUnownedClass

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

GObject.NotifyCallback

Constructor Summary

Constructors

Constructor	Description
ElementFactory()	Creates a new ElementFactory.
ElementFactory(MemorySegment address)	Create a ElementFactory proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected ElementFactory	asParent()	Returns this instance as if it were its parent type.
static ElementFactory.Builder<? extends ElementFactory.Builder>	builder()	A ElementFactory.Builder object constructs a ElementFactory with the specified properties.
boolean	canSinkAllCaps(Caps caps)	Checks if the factory can sink all possible capabilities.
boolean	canSinkAnyCaps(Caps caps)	Checks if the factory can sink any possible capability.
boolean	canSrcAllCaps(Caps caps)	Checks if the factory can src all possible capabilities.
boolean	canSrcAnyCaps(Caps caps)	Checks if the factory can src any possible capability.
@Nullable Element	create(@Nullable String name)	Create a new element of the type defined by the given elementfactory.
@Nullable Element	createFull(@Nullable String first, Object... varargs)	Create a new element of the type defined by the given elementfactory.
@Nullable Element	createWithProperties(@Nullable String @Nullable [] names, @Nullable Value @Nullable [] values)	Create a new element of the type defined by the given elementfactory.
static @Nullable ElementFactory	find(String name)	Search for an element factory of the given name.
Type	getElementType()	Get the GType for elements managed by this factory.
@Nullable String	getMetadata(String key)	Get the metadata on this ElementFactory with key.
@Nullable String @Nullable []	getMetadataKeys()	Get the available keys for the metadata on factory.
int	getNumPadTemplates()	Gets the number of pad_templates in this factory.
boolean	getSkipDocumentation()	Queries whether registered element managed by this ElementFactory needs to be excluded from documentation system or not.
List<StaticPadTemplate>	getStaticPadTemplates()	Gets the GList of GstStaticPadTemplate for this factory.
static @Nullable Type	getType()	Get the GType of the ElementFactory class
String[]	getUriProtocols()	Gets a null-terminated array of protocols this element supports or null if no protocols are supported.
URIType	getUriType()	Gets the type of URIs the element supports or GST_URI_UNKNOWN if none.
boolean	hasInterface(String interfacename)	Check if this ElementFactory implements the interface with name interfacename.
static List<ElementFactory>	listFilter(List<ElementFactory> list, Caps caps, PadDirection direction, boolean subsetonly)	Filter out all the elementfactories in list that can handle caps in the given direction.
static List<ElementFactory>	listGetElements(ElementFactoryListType type, Rank minrank)	Get a list of factories that match the given type. Only elements with a rank greater or equal to minrank will be returned.
boolean	listIsType(ElementFactoryListType type)	Check if this ElementFactory is of the given types.
static @Nullable Element	make(String factoryname, @Nullable String name)	Create a new element of the type defined by the given element factory.
static @Nullable Element	makeFull(String factoryname, @Nullable String first, Object... varargs)	Create a new element of the type defined by the given element factory.
static @Nullable Element	makeWithProperties(String factoryname, @Nullable String @Nullable [] names, @Nullable Value @Nullable [] values)	Create a new element of the type defined by the given elementfactory.

Methods inherited from class org.freedesktop.gstreamer.gst.PluginFeature

checkVersion, getPlugin, getPluginName, getRank, listCopy, listDebug, listFree, load, rankCompareFunc, setRank

Methods inherited from class org.freedesktop.gstreamer.gst.GstObject

addControlBinding, checkUniqueness, deepNotify, defaultDeepNotify, defaultError, emitDeepNotify, getControlBinding, getControlRate, getGValueArray, getMemoryLayout, getName, getParent, getPathString, getValue, getValueArray, hasActiveControlBindings, hasAncestor, hasAsAncestor, hasAsParent, onDeepNotify, ref, refSink, removeControlBinding, replace, setControlBindingDisabled, setControlBindingsDisabled, setControlRate, setName, setParent, suggestNextSync, syncValues, unparent, unref

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, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

Methods inherited from class org.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

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

Constructor Details

ElementFactory

public ElementFactory(MemorySegment address)

Create a ElementFactory proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

ElementFactory

public ElementFactory()

Creates a new ElementFactory.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the ElementFactory class

Returns:

the GType

asParent

protected ElementFactory 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 PluginFeature

find

public static @Nullable ElementFactory find(String name)

Search for an element factory of the given name. Refs the returned element factory; caller is responsible for unreffing.

Parameters:

name - name of factory to find

Returns:

GstElementFactory if found, null otherwise

listFilter

public static List<ElementFactory> listFilter(List<ElementFactory> list,
 Caps caps,
 PadDirection direction,
 boolean subsetonly)

Filter out all the elementfactories in list that can handle caps in the given direction.

If subsetonly is true, then only the elements whose pads templates are a complete superset of caps will be returned. Else any element whose pad templates caps can intersect with caps will be returned.

Parameters:

list - a GList of GstElementFactory to filter

caps - a GstCaps

direction - a GstPadDirection to filter on

subsetonly - whether to filter on caps subsets or not.

Returns:

a GList of GstElementFactory elements that match the given requisites. Use gst_plugin_feature_list_free after usage.

listGetElements

public static List<ElementFactory> listGetElements(ElementFactoryListType type,
 Rank minrank)

Get a list of factories that match the given type. Only elements with a rank greater or equal to minrank will be returned. The list of factories is returned by decreasing rank.

Parameters:

type - a GstElementFactoryListType

minrank - Minimum rank

Returns:

a GList of GstElementFactory elements. Use gst_plugin_feature_list_free() after usage.

make

public static @Nullable Element make(String factoryname,
 @Nullable String name)

Create a new element of the type defined by the given element factory. If name is null, then the element will receive a guaranteed unique name, consisting of the element factory name and a number. If name is given, it will be given the name supplied.

Parameters:

factoryname - a named factory to instantiate

name - name of new element, or null to automatically create a unique name

Returns:

new GstElement or null if unable to create element

makeFull

public static @Nullable Element makeFull(String factoryname,
 @Nullable String first,
 Object... varargs)

Create a new element of the type defined by the given element factory. The supplied list of properties, will be passed at object construction.

Parameters:

factoryname - a named factory to instantiate

first - name of first property

varargs - null terminated list of properties

Returns:

new GstElement or null if unable to create element

Since:

1.20

makeWithProperties

public static @Nullable Element makeWithProperties(String factoryname,
 @Nullable String @Nullable [] names,
 @Nullable Value @Nullable [] values)

Create a new element of the type defined by the given elementfactory. The supplied list of properties, will be passed at object construction.

Parameters:

factoryname - a named factory to instantiate

names - array of properties names

values - array of associated properties values

Returns:

new GstElement or null if the element couldn't be created

Since:

1.20

canSinkAllCaps

public boolean canSinkAllCaps(Caps caps)

Checks if the factory can sink all possible capabilities.

Parameters:

caps - the caps to check

Returns:

true if the caps are fully compatible.

canSinkAnyCaps

public boolean canSinkAnyCaps(Caps caps)

Checks if the factory can sink any possible capability.

Parameters:

caps - the caps to check

Returns:

true if the caps have a common subset.

canSrcAllCaps

public boolean canSrcAllCaps(Caps caps)

Checks if the factory can src all possible capabilities.

Parameters:

caps - the caps to check

Returns:

true if the caps are fully compatible.

canSrcAnyCaps

public boolean canSrcAnyCaps(Caps caps)

Checks if the factory can src any possible capability.

Parameters:

caps - the caps to check

Returns:

true if the caps have a common subset.

create

public @Nullable Element create(@Nullable String name)

Create a new element of the type defined by the given elementfactory. It will be given the name supplied, since all elements require a name as their first argument.

Parameters:

name - name of new element, or null to automatically create a unique name

Returns:

new GstElement or null if the element couldn't be created

createFull

public @Nullable Element createFull(@Nullable String first,
 Object... varargs)

Create a new element of the type defined by the given elementfactory. The supplied list of properties, will be passed at object construction.

Parameters:

first - name of the first property

varargs - null terminated list of properties

Returns:

new GstElement or null if the element couldn't be created

Since:

1.20

createWithProperties

public @Nullable Element createWithProperties(@Nullable String @Nullable [] names,
 @Nullable Value @Nullable [] values)

Create a new element of the type defined by the given elementfactory. The supplied list of properties, will be passed at object construction.

Parameters:

names - array of properties names

values - array of associated properties values

Returns:

new GstElement or null if the element couldn't be created

Since:

1.20

getElementType

public Type getElementType()

Get the GType for elements managed by this factory. The type can only be retrieved if the element factory is loaded, which can be assured with gst_plugin_feature_load().

Returns:

the GType for elements managed by this factory or 0 if the factory is not loaded.

getMetadata

public @Nullable String getMetadata(String key)

Get the metadata on this ElementFactory with key.

Parameters:

key - a key

Returns:

the metadata with key on this ElementFactory or null when there was no metadata with the given key.

getMetadataKeys

public @Nullable String @Nullable [] getMetadataKeys()

Get the available keys for the metadata on factory.

Returns:

a null-terminated array of key strings, or null when there is no metadata. Free with g_strfreev() when no longer needed.

getNumPadTemplates

public int getNumPadTemplates()

Gets the number of pad_templates in this factory.

Returns:

the number of pad_templates

getSkipDocumentation

public boolean getSkipDocumentation()

Queries whether registered element managed by this ElementFactory needs to be excluded from documentation system or not.

Returns:

true if documentation should be skipped

Since:

1.20

getStaticPadTemplates

public List<StaticPadTemplate> getStaticPadTemplates()

Gets the GList of GstStaticPadTemplate for this factory.

Returns:

the static pad templates

getUriProtocols

public String[] getUriProtocols()

Gets a null-terminated array of protocols this element supports or null if no protocols are supported. You may not change the contents of the returned array, as it is still owned by the element factory. Use g_strdupv() to make a copy of the protocol string array if you need to.

Returns:

the supported protocols or null

getUriType

public URIType getUriType()

Gets the type of URIs the element supports or GST_URI_UNKNOWN if none.

Returns:

type of URIs this element supports

hasInterface

public boolean hasInterface(String interfacename)

Check if this ElementFactory implements the interface with name interfacename.

Parameters:

interfacename - an interface name

Returns:

true when this ElementFactory implement the interface.

listIsType

public boolean listIsType(ElementFactoryListType type)

Check if this ElementFactory is of the given types.

Parameters:

type - a GstElementFactoryListType

Returns:

true if this ElementFactory is of type.

builder

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

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

Returns:

the builder object