mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-06-18 05:50:41 +00:00
307 lines
4.3 KiB
Plaintext
307 lines
4.3 KiB
Plaintext
<!-- ##### SECTION Title ##### -->
|
|
GstPlugin
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
|
Dynamically loadable Elements
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
<para>
|
|
GStreamer is extensible so <classname>GstElements</classname> can be loaded at runtime. A plugin
|
|
system can provide one or more of the following basic <application>GStreamer</application>
|
|
objects factories:
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>
|
|
A #GstElementFactory: the components to build a pipeline.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
A #GstTypeFactory: A MIME type and an optional typefind function.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
A #GstAutoplugFactory: An object used to automatically construct pipelines.
|
|
</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
<para>
|
|
A new plugin is created with gst_plugin_new(). this function will return a handle
|
|
to the GstPlugin or NULL if the plugin could not be created.
|
|
</para>
|
|
<para>
|
|
Once a GstPlugin element has been created, you can add the different types of factories
|
|
to it with gst_plugin_add_factory(), gst_plugin_add_type(), gst_plugin_add_autoplugger().
|
|
</para>
|
|
<para>
|
|
<application>Gstreamer</application> plugins should have a method plugin_init that is called
|
|
by the loader.
|
|
</para>
|
|
<para>
|
|
use gst_plugin_find(), gst_plugin_get_list(), gst_plugin_get_factory_list(), gst_plugin_get_type_list() and
|
|
gst_plugin_get_autoplug_list() to query the plugin repository.
|
|
</para>
|
|
<para>
|
|
Plugins are always automaticlly loaded so you don't need to call gst_plugin_load() explicitly
|
|
to bring it into memory.
|
|
</para>
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
<para>
|
|
#GstElement, #GstType, #GstAutoplug
|
|
</para>
|
|
|
|
<!-- ##### STRUCT GstPlugin ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@name:
|
|
@longname:
|
|
@filename:
|
|
@types:
|
|
@numtypes:
|
|
@elements:
|
|
@numelements:
|
|
@autopluggers:
|
|
@numautopluggers:
|
|
@loaded:
|
|
|
|
<!-- ##### STRUCT GstPluginElement ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
<!-- ##### USER_FUNCTION GstPluginInitFunc ##### -->
|
|
<para>
|
|
A plugin should implement this function called plugin_init. It will be called
|
|
by the loader at statup.
|
|
</para>
|
|
|
|
@module: The <classname>GModule</classname> it was loaded from
|
|
@Returns: The plugin or NULL is an error was detected.
|
|
|
|
|
|
<!-- ##### FUNCTION gst_plugin_new ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@name:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_plugin_set_name ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@plugin:
|
|
@name:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_plugin_get_name ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@plugin:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_plugin_get_longname ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@plugin:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_plugin_set_longname ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@plugin:
|
|
@longname:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_plugin_get_filename ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@plugin:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_plugin_is_loaded ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@plugin:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_plugin_load_all ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_plugin_load ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@name:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_plugin_load_absolute ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@name:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_plugin_add_path ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@path:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_library_load ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@name:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_plugin_add_factory ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@plugin:
|
|
@factory:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_plugin_add_type ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@plugin:
|
|
@factory:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_plugin_add_autoplugger ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@plugin:
|
|
@factory:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_plugin_find ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@name:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_plugin_get_list ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_plugin_get_factory_list ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@plugin:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_plugin_get_type_list ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@plugin:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_plugin_get_autoplug_list ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@plugin:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_plugin_load_elementfactory ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@name:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_plugin_load_typefactory ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@mime:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_plugin_load_autoplugfactory ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@name:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_plugin_load_thyself ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@parent:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_plugin_save_thyself ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@parent:
|
|
@Returns:
|
|
|
|
|