org.freedesktop.gstreamer

Class Plugin

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

All Implemented Interfaces:

AutoCloseable

public class Plugin
extends GstObject

Container for features loaded from a shared object module

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

GStreamer is extensible, so Element instances can be loaded at runtime. A plugin system can provide one or more of the basic GStreamer PluginFeature subclasses.

A plugin should export a symbol gst_plugin_desc that is a struct of type GstPluginDesc. the plugin loader will check the version of the core library the plugin was linked against and will create a new Plugin. It will then call the #GstPluginInitFunc function that was provided in the gst_plugin_desc.

Once you have a handle to a #GstPlugin (e.g. from the #GstRegistryPool), you can add any object that subclasses #GstPluginFeature.

Use gst_plugin_find_feature() and gst_plugin_get_feature_list() to find features in a plugin.

Usually plugins are always automatically loaded so you don't need to call loadByName(java.lang.String) explicitly to bring it into memory. There are options to statically link plugins to an app or even use GStreamer without a plugin repository in which case loadByName(java.lang.String) can be needed to bring the plugin into memory.

See Also:

PluginFeature, ElementFactory

Nested Class Summary

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
String	getDescription() Get the long descriptive name of the plugin.
String	getFilename() Get the filename of the plugin.
String	getLicense() Get the license of the plugin.
String	getName() Get the short name of the plugin.
String	getOrigin() Get the URL where the plugin comes from.
String	getPackage() Get the package the plugin belongs to.
String	getReleaseDateString() Get the release date (and possibly time) in form of a string, if available.
String	getSource() Get the source module the plugin belongs to.
String	getVersion() Get the version of the plugin.
boolean	isLoaded() Queries if the plugin is loaded into memory.
static Plugin	loadByName(String pluginName) Load the named plugin.

Methods inherited from class org.freedesktop.gstreamer.GstObject

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

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

loadByName

public static Plugin loadByName(String pluginName)

Load the named plugin.

Parameters:

pluginName -

Returns:

A new Plugin reference if the plugin was loaded, else null.

getName

public String getName()

Get the short name of the plugin.

Overrides:

getName in class GstObject

Returns:

the name of the plugin.

getDescription

public String getDescription()

Get the long descriptive name of the plugin.

Returns:

The long name of the plugin.

getFilename

public String getFilename()

Get the filename of the plugin.

Returns:

The filename of the plugin.

getVersion

public String getVersion()

Get the version of the plugin.

Returns:

The version of the plugin.

getLicense

public String getLicense()

Get the license of the plugin.

Returns:

The license of the plugin.

getSource

public String getSource()

Get the source module the plugin belongs to.

Returns:

The source of the plugin.

getPackage

public String getPackage()

Get the package the plugin belongs to.

Returns:

The package of the plugin.

getOrigin

public String getOrigin()

Get the URL where the plugin comes from.

Returns:

The origin of the plugin.

getReleaseDateString

public String getReleaseDateString()

Get the release date (and possibly time) in form of a string, if available. For normal GStreamer plugin releases this will usually just be a date in the form of "YYYY-MM-DD", while pre-releases and builds from git may contain a time component after the date as well, in which case the string will be formatted like "YYYY-MM-DDTHH:MMZ" (e.g. "2012-04-30T09:30Z").Test

isLoaded

public boolean isLoaded()

Queries if the plugin is loaded into memory.

Returns:

true if it is loaded, false otherwise.