Plugin

GStreamer is extensible, so #GstElement instances can be loaded at runtime. A plugin system can provide one or more of the basic GStreamer #GstPluginFeature 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 #GstPlugin. 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 #GstRegistry), you can add any object that subclasses #GstPluginFeature.

Usually plugins are always automatically loaded so you don't need to call gst.plugin.Plugin.load 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 gst.plugin.Plugin.load can be needed to bring the plugin into memory.

class Plugin : ObjectGst {

static gst.plugin.Plugin loadByName(string name);

static gst.plugin.Plugin loadFile(string filename);

static bool registerStatic(int majorVersion, int minorVersion, string name, string description, gst.types.PluginInitFunc initFunc, string version_, string license, string source, string package_, string origin);

static bool registerStaticFull(int majorVersion, int minorVersion, string name, string description, gst.types.PluginInitFullFunc initFullFunc, string version_, string license, string source, string package_, string origin);

void addDependency(string[] envVars, string[] paths, string[] names, gst.types.PluginDependencyFlags flags);

void addDependencySimple(string envVars, string paths, string names, gst.types.PluginDependencyFlags flags);

void addStatusError(string message);

void addStatusInfo(string message);

void addStatusWarning(string message);

gst.structure.Structure getCacheData();

string getDescription();

string getFilename();

string getLicense();

string getName();

string getOrigin();

string getPackage();

string getReleaseDateString();

string getSource();

string[] getStatusErrors();

string[] getStatusInfos();

string[] getStatusWarnings();

string getVersion();

bool isLoaded();

gst.plugin.Plugin load();

void setCacheData(gst.structure.Structure cacheData);

}

Members

Functions

addDependency void addDependency(string[] envVars, string[] paths, string[] names, gst.types.PluginDependencyFlags flags): Make GStreamer aware of external dependencies which affect the feature set of this plugin (ie. the elements or typefinders associated with it).
addDependencySimple void addDependencySimple(string envVars, string paths, string names, gst.types.PluginDependencyFlags flags): Make GStreamer aware of external dependencies which affect the feature set of this plugin (ie. the elements or typefinders associated with it).
addStatusError void addStatusError(string message)
addStatusInfo void addStatusInfo(string message)
addStatusWarning void addStatusWarning(string message)
getCacheData gst.structure.Structure getCacheData(): Gets the plugin specific data cache. If it is null there is no cached data stored. This is the case when the registry is getting rebuilt.
getDescription string getDescription(): Get the long descriptive name of the plugin
getFilename string getFilename(): get the filename of the plugin
getLicense string getLicense(): get the license of the plugin
getName string getName(): Get the short name of the plugin
getOrigin string getOrigin(): get the URL where the plugin comes from
getPackage string getPackage(): get the package the plugin belongs to.
getReleaseDateString string getReleaseDateString(): Get the release date (and possibly time) in form of a string, if available.
getSource string getSource(): get the source module the plugin belongs to.
getStatusErrors string[] getStatusErrors()
getStatusInfos string[] getStatusInfos()
getStatusWarnings string[] getStatusWarnings()
getVersion string getVersion(): get the version of the plugin
isLoaded bool isLoaded(): queries if the plugin is loaded into memory
load gst.plugin.Plugin load(): Loads plugin. Note that the *return value* is the loaded plugin; plugin is untouched. The normal use pattern of this function goes like this:
setCacheData void setCacheData(gst.structure.Structure cacheData): Adds plugin specific data to cache. Passes the ownership of the structure to the plugin.

Static functions

loadByName gst.plugin.Plugin loadByName(string name): Load the named plugin. Refs the plugin.
loadFile gst.plugin.Plugin loadFile(string filename): Loads the given plugin and refs it. Caller needs to unref after use.
registerStatic bool registerStatic(int majorVersion, int minorVersion, string name, string description, gst.types.PluginInitFunc initFunc, string version_, string license, string source, string package_, string origin): Registers a static plugin, ie. a plugin which is private to an application or library and contained within the application or library (as opposed to being shipped as a separate module file).
registerStaticFull bool registerStaticFull(int majorVersion, int minorVersion, string name, string description, gst.types.PluginInitFullFunc initFullFunc, string version_, string license, string source, string package_, string origin): Registers a static plugin, ie. a plugin which is private to an application or library and contained within the application or library (as opposed to being shipped as a separate module file) with a #GstPluginInitFullFunc which allows user data to be passed to the callback function (useful for bindings).

Inherited Members

From ObjectGst

checkUniqueness bool checkUniqueness(gst.object.ObjectGst[] list, string name): Checks to see if there is any object named name in list. This function does not do any locking of any kind. You might want to protect the provided list with the lock of the owner of the list. This function will lock each #GstObject in the list to compare the name, so be careful when passing a list with a locked object.
defaultDeepNotify void defaultDeepNotify(gobject.object.ObjectG object, gst.object.ObjectGst orig, gobject.param_spec.ParamSpec pspec, string[] excludedProps): A default deep_notify signal callback for an object. The user data should contain a pointer to an array of strings that should be excluded from the notify. The default handler will print the new value of the property using g_print.
replace bool replace(gst.object.ObjectGst oldobj, gst.object.ObjectGst newobj): Atomically modifies a pointer to point to a new object. The reference count of oldobj is decreased and the reference count of newobj is increased.
addControlBinding bool addControlBinding(gst.control_binding.ControlBinding binding): Attach the #GstControlBinding to the object. If there already was a #GstControlBinding for this property it will be replaced.
defaultError void defaultError(glib.error.ErrorG error, string debug_): A default error function that uses glib.global.printerr to display the error message and the optional debug string..
getControlBinding gst.control_binding.ControlBinding getControlBinding(string propertyName): Gets the corresponding #GstControlBinding for the property. This should be unreferenced again after use.
getControlRate gst.types.ClockTime getControlRate(): Obtain the control-rate for this object. Audio processing #GstElement objects will use this rate to sub-divide their processing loop and call gst.object.ObjectGst.syncValues in between. The length of the processing segment should be up to control-rate nanoseconds.
getGValueArray bool getGValueArray(string propertyName, gst.types.ClockTime timestamp, gst.types.ClockTime interval, gobject.value.Value[] values): Gets a number of #GValues for the given controlled property starting at the requested time. The array values need to hold enough space for n_values of #GValue.
getName string getName(): Returns a copy of the name of object. Caller should glib.global.gfree the return value after usage. For a nameless object, this returns null, which you can safely glib.global.gfree as well.
getParent gst.object.ObjectGst getParent(): Returns the parent of object. This function increases the refcount of the parent object so you should gst.object.ObjectGst.unref it after usage.
getPathString string getPathString(): Generates a string describing the path of object in the object hierarchy. Only useful (or used) for debugging.
getValue gobject.value.Value getValue(string propertyName, gst.types.ClockTime timestamp): Gets the value for the given controlled property at the requested time.
hasActiveControlBindings bool hasActiveControlBindings(): Check if the object has active controlled properties.
hasAncestor bool hasAncestor(gst.object.ObjectGst ancestor): Check if object has an ancestor ancestor somewhere up in the hierarchy. One can e.g. check if a #GstElement is inside a #GstPipeline.
hasAsAncestor bool hasAsAncestor(gst.object.ObjectGst ancestor): Check if object has an ancestor ancestor somewhere up in the hierarchy. One can e.g. check if a #GstElement is inside a #GstPipeline.
hasAsParent bool hasAsParent(gst.object.ObjectGst parent): Check if parent is the parent of object. E.g. a #GstElement can check if it owns a given #GstPad.
removeControlBinding bool removeControlBinding(gst.control_binding.ControlBinding binding): Removes the corresponding #GstControlBinding. If it was the last ref of the binding, it will be disposed.
setControlBindingDisabled void setControlBindingDisabled(string propertyName, bool disabled): This function is used to disable the control bindings on a property for some time, i.e. gst.object.ObjectGst.syncValues will do nothing for the property.
setControlBindingsDisabled void setControlBindingsDisabled(bool disabled): This function is used to disable all controlled properties of the object for some time, i.e. gst.object.ObjectGst.syncValues will do nothing.
setControlRate void setControlRate(gst.types.ClockTime controlRate): Change the control-rate for this object. Audio processing #GstElement objects will use this rate to sub-divide their processing loop and call gst.object.ObjectGst.syncValues in between. The length of the processing segment should be up to control-rate nanoseconds.
setName bool setName(string name): Sets the name of object, or gives object a guaranteed unique name (if name is null). This function makes a copy of the provided name, so the caller retains ownership of the name it sent.
setParent bool setParent(gst.object.ObjectGst parent): Sets the parent of object to parent. The object's reference count will be incremented, and any floating reference will be removed (see gst.object.ObjectGst.refSink).
suggestNextSync gst.types.ClockTime suggestNextSync(): Returns a suggestion for timestamps where buffers should be split to get best controller results.
syncValues bool syncValues(gst.types.ClockTime timestamp): Sets the properties of the object, according to the #GstControlSources that (maybe) handle them and for the given timestamp.
unparent void unparent(): Clear the parent of object, removing the associated reference. This function decreases the refcount of object.
connectDeepNotify ulong connectDeepNotify(string detail, T callback, Flag!"After" after): Connect to DeepNotify signal.

gst plugin classes

Plugin