Plugin

GStreamer is extensible, so #GstElement instances can be loaded at runtime. A plugin system can provide one or more of the basic <application>GStreamer</application> #GstPluginFeature subclasses.

A plugin should export a symbol <symbol>gst_plugin_desc</symbol> 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 <symbol>gst_plugin_desc</symbol>.

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_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_load() can be needed to bring the plugin into memory.

class Plugin : ObjectGst {

protected

GstPlugin* gstPlugin;

GstPlugin* getPluginStruct();

void* getStruct();

void setStruct(GObject* obj);

this(GstPlugin* gstPlugin, bool ownedRef);

static GType getType();

static void listFree(ListG list);

static Plugin loadByName(string name);

static Plugin loadFile(string filename);

static bool registerStatic(int majorVersion, int minorVersion, string name, string description, GstPluginInitFunc initFunc, string versio, string license, string source, string p, string origin);

static bool registerStaticFull(int majorVersion, int minorVersion, string name, string description, GstPluginInitFullFunc initFullFunc, string versio, string license, string source, string p, string origin, void* userData);

void addDependency(string[] envVars, string[] paths, string[] names, GstPluginDependencyFlags flags);

void addDependencySimple(string envVars, string paths, string names, GstPluginDependencyFlags flags);

Structure getCacheData();

string getDescription();

string getFilename();

string getLicense();

string getName();

string getOrigin();

string getPackage();

string getReleaseDateString();

string getSource();

string getVersion();

bool isLoaded();

Plugin load();

void setCacheData(Structure cacheData);

static GQuark pluginErrorQuark();

}

Constructors

this this(GstPlugin* gstPlugin, bool ownedRef): Sets our main struct and passes it to the parent class.

Members

Functions

addDependency void addDependency(string[] envVars, string[] paths, string[] names, GstPluginDependencyFlags 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, GstPluginDependencyFlags flags): Make GStreamer aware of external dependencies which affect the feature set of this plugin (ie. the elements or typefinders associated with it).
getCacheData 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.
getPluginStruct GstPlugin* getPluginStruct(): Get the main Gtk struct
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.
getStruct void* getStruct(): the main Gtk struct as a void*
getVersion string getVersion(): get the version of the plugin
isLoaded bool isLoaded(): queries if the plugin is loaded into memory
load 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(Structure cacheData): Adds plugin specific data to cache. Passes the ownership of the structure to the @plugin.
setStruct void setStruct(GObject* obj): Undocumented in source. Be warned that the author may not have intended to support it.

Static functions

getType GType getType()
listFree void listFree(ListG list): Unrefs each member of @list, then frees the list.
loadByName Plugin loadByName(string name): Load the named plugin. Refs the plugin.
loadFile Plugin loadFile(string filename): Loads the given plugin and refs it. Caller needs to unref after use.
pluginErrorQuark GQuark pluginErrorQuark(): Get the error quark.
registerStatic bool registerStatic(int majorVersion, int minorVersion, string name, string description, GstPluginInitFunc initFunc, string versio, string license, string source, string p, 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, GstPluginInitFullFunc initFullFunc, string versio, string license, string source, string p, string origin, void* userData): 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).

Variables

gstPlugin GstPlugin* gstPlugin;: the main Gtk struct

Inherited Members

From ObjectGst

gstObject GstObject* gstObject;: the main Gtk struct
getObjectGstStruct GstObject* getObjectGstStruct(): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
setStruct void setStruct(GObject* obj): Undocumented in source. Be warned that the author may not have intended to support it.
getType GType getType()
checkUniqueness bool checkUniqueness(ListG 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(ObjectG object, ObjectGst orig, 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.
refSink void* refSink(void* object): Increase the reference count of @object, and possibly remove the floating reference, if @object has a floating reference.
replace bool replace(ObjectGst oldobj, 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(ControlBinding binding): Attach the #GstControlBinding to the object. If there already was a #GstControlBinding for this property it will be replaced.
defaultError void defaultError(ErrorG error, string dbg): A default error function that uses g_printerr() to display the error message and the optional debug sting..
getControlBinding ControlBinding getControlBinding(string propertyName): Gets the corresponding #GstControlBinding for the property. This should be unreferenced again after use.
getControlRate GstClockTime 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_sync_values() inbetween. The length of the processing segment should be up to @control-rate nanoseconds.
getGValueArray bool getGValueArray(string propertyName, GstClockTime timestamp, GstClockTime interval, uint nValues, 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 g_free() the return value after usage. For a nameless object, this returns %NULL, which you can safely g_free() as well.
getParent ObjectGst getParent(): Returns the parent of @object. This function increases the refcount of the parent object so you should gst_object_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 Value getValue(string propertyName, GstClockTime timestamp): Gets the value for the given controlled property at the requested time.
getValueArray bool getValueArray(string propertyName, GstClockTime timestamp, GstClockTime interval, uint nValues, void* values): Gets a number of values for the given controlled property starting at the requested time. The array @values need to hold enough space for @n_values of the same type as the objects property's type.
hasActiveControlBindings bool hasActiveControlBindings(): Check if the @object has an active controlled properties.
hasAncestor bool hasAncestor(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.
doref ObjectGst doref(): Increments the reference count on @object. This function does not take the lock on @object because it relies on atomic refcounting.
removeControlBinding bool removeControlBinding(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_sync_values() 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_sync_values() will do nothing.
setControlRate void setControlRate(GstClockTime 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_sync_values() inbetween. 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(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_ref_sink()).
suggestNextSync GstClockTime suggestNextSync(): Returns a suggestion for timestamps where buffers should be split to get best controller results.
syncValues bool syncValues(GstClockTime 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.
unref void unref(): Decrements the reference count on @object. If reference count hits zero, destroy @object. This function does not take the lock on @object as it relies on atomic refcounting.
connectedSignals int[string] connectedSignals;: Undocumented in source.
onDeepNotifyListeners void delegate(ObjectGst, ParamSpec, ObjectGst)[] onDeepNotifyListeners;: Undocumented in source.
addOnDeepNotify void addOnDeepNotify(void delegate(ObjectGst, ParamSpec, ObjectGst) dlg, ConnectFlags connectFlags): The deep notify signal is used to be notified of property changes. It is typically attached to the toplevel bin to receive notifications from all the elements contained in that bin.
callBackDeepNotify void callBackDeepNotify(GstObject* objectgstStruct, GstObject* propObject, GParamSpec* prop, ObjectGst _objectgst): Undocumented in source. Be warned that the author may not have intended to support it.