org.freedesktop.gstreamer

Class ElementFactory

java.lang.Object

org.freedesktop.gstreamer.glib.NativeObject

org.freedesktop.gstreamer.glib.RefCountedObject

org.freedesktop.gstreamer.glib.GObject

org.freedesktop.gstreamer.GstObject

org.freedesktop.gstreamer.PluginFeature

org.freedesktop.gstreamer.ElementFactory

All Implemented Interfaces:

AutoCloseable

public class ElementFactory
extends PluginFeature

ElementFactory is used to create instances of elements.

See upstream documentation at https://gstreamer.freedesktop.org/data/doc/gstreamer/stable/gstreamer/html/GstElementFactory.html

Use the find(java.lang.String) and create(java.lang.String) methods to create element instances or use make(java.lang.String, java.lang.String) as a convenient shortcut.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ElementFactory.ListType The type of ElementFactory to filter.

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

PluginFeature.Rank

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

GstObject.Handle

Nested classes/interfaces inherited from class org.freedesktop.gstreamer.glib.GObject

GObject.GCallback, GObject.GInterface

Nested classes/interfaces inherited from class org.freedesktop.gstreamer.glib.NativeObject

NativeObject.Initializer, NativeObject.TypeProvider, NativeObject.TypeRegistration<T extends NativeObject>

Field Summary

Fields

Modifier and Type	Field and Description
static String	GTYPE_NAME

Method Summary

Modifier and Type	Method and Description
Element	create(String name) Creates a new element from the factory.
static ElementFactory	find(String name) Retrieve an instance of a factory that can produce Elements
String	getAuthor() Returns the name of the person who wrote the factory.
String	getDescription() Returns a description of the factory.
String	getKlass() Returns a string describing the type of factory.
String	getLongName() Returns the long, English name for the factory.
List<StaticPadTemplate>	getStaticPadTemplates() Gets the list of StaticPadTemplate for this factory.
static List<ElementFactory>	listGetElements(ElementFactory.ListType type, PluginFeature.Rank minrank) Get a list of factories that match the given type.
static List<ElementFactory>	listGetElementsFilter(ElementFactory.ListType type, PluginFeature.Rank minrank, Caps caps, PadDirection direction, boolean subsetonly) Get a list of factories that match the given parameter.
static Element	make(String factoryName, String name) Creates a new Element from the specified factory.

Methods inherited from class org.freedesktop.gstreamer.PluginFeature

checkVersion, getName, getPlugin, getPluginName, getRank, setName, setRank, setRank, toString

Methods inherited from class org.freedesktop.gstreamer.GstObject

addControlBinding, getAsString, getControlBinding, getParent, hasActiveControlBindings, removeControlBinding, setAsString, setControlBindingDisabled, setControlBindingsDisabled, suggestNextSync, syncValues

Methods inherited from class org.freedesktop.gstreamer.glib.GObject

addCallback, connect, connect, disconnect, dispose, emit, emit, get, getPropertyDefaultValue, getPropertyMaximumValue, getPropertyMinimumValue, getRefCount, getTypeName, invalidate, listPropertyNames, removeCallback, set

Methods inherited from class org.freedesktop.gstreamer.glib.NativeObject

close, disown, equals, getPointer, getRawPointer, hashCode

Methods inherited from class java.lang.Object

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

Field Detail

GTYPE_NAME

public static final String GTYPE_NAME

See Also:

Constant Field Values

Method Detail

create

public Element create(String name)

Creates a new element from the factory.

Parameters:

name - the name to assign to the created Element

Returns:

A new Element

getAuthor

public String getAuthor()

Returns the name of the person who wrote the factory.

Returns:

The name of the author

getDescription

public String getDescription()

Returns a description of the factory.

Returns:

A brief description of the factory.

getKlass

public String getKlass()

Returns a string describing the type of factory. This is an unordered list separated with slashes ('/').

Returns:

The description of the type of factory.

getLongName

public String getLongName()

Returns the long, English name for the factory.

Returns:

The long, English name for the factory.

getStaticPadTemplates

public List<StaticPadTemplate> getStaticPadTemplates()

Gets the list of StaticPadTemplate for this factory.

Returns:

The list of StaticPadTemplate

find

public static ElementFactory find(String name)

Retrieve an instance of a factory that can produce Elements

Parameters:

name - The type of Element to produce.

Returns:

An ElementFactory that will produce Elements of the desired type.

listGetElements

public static List<ElementFactory> listGetElements(ElementFactory.ListType type,
                                                   PluginFeature.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 ElementFactory.ListType

minrank - Minimum rank

Returns:

a List of ElementFactory elements.

listGetElementsFilter

public static List<ElementFactory> listGetElementsFilter(ElementFactory.ListType type,
                                                         PluginFeature.Rank minrank,
                                                         Caps caps,
                                                         PadDirection direction,
                                                         boolean subsetonly)

Get a list of factories that match the given parameter. It is a combination of listGetElement and listFilter passing all the results of the first call to the second. This method improves performance because there is no need to map to java list the elements returned by the first call.

Parameters:

type - a ElementFactory.ListType

minrank - Minimum rank

caps - a Caps

direction - a PadDirection to filter on

subsetonly - whether to filter on caps subsets or not.

Returns:

a List of ElementFactory elements that match the given requisits.

make

public static Element make(String factoryName,
                           String name)

Creates a new Element from the specified factory.

Parameters:

factoryName - The name of the factory to use to produce the Element

name - The name to assign to the created Element

Returns:

A new GstElemElement