source-git / gstreamer1

Clone
Source Code
GIT

Blame docs/gst/html/GstPlugin.html

c8 c8s master
  1.   a6ee4b6682de8ff228181cdedb215e3ba4adfb74
  2.   docs
  3.   gst
  4.   html
  5.   GstPlugin.html
Blob History Raw
Packit a6ee4b
Packit a6ee4b 
<html>
Packit a6ee4b 
<head>
Packit a6ee4b 
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit a6ee4b 
<title>GstPlugin: GStreamer 1.0 Core Reference Manual</title>
Packit a6ee4b 
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
Packit a6ee4b 
<link rel="home" href="index.html" title="GStreamer 1.0 Core Reference Manual">
Packit a6ee4b 
<link rel="up" href="libgstreamer.html" title="GStreamer Core Library">
Packit a6ee4b 
<link rel="prev" href="GstPipeline.html" title="GstPipeline">
Packit a6ee4b 
<link rel="next" href="GstPluginFeature.html" title="GstPluginfeature">
Packit a6ee4b 
<meta name="generator" content="GTK-Doc V1.28 (XML mode)">
Packit a6ee4b 
<link rel="stylesheet" href="style.css" type="text/css">
Packit a6ee4b 
</head>
Packit a6ee4b 
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
Top  | 
Packit a6ee4b 
                  Description  | 
Packit a6ee4b 
                  Object Hierarchy
Packit a6ee4b
Packit a6ee4b 
Home
Packit a6ee4b 
Up
Packit a6ee4b 
Prev
Packit a6ee4b 
Next
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
GstPlugin
Packit a6ee4b 
GstPlugin — Container for features loaded from a shared object module
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
Functions
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
GQuark
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gst_plugin_error_quark ()
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gboolean
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
(*GstPluginInitFunc) ()
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gboolean
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
(*GstPluginInitFullFunc) ()
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
#define
Packit a6ee4b
Packit a6ee4b 
GST_PLUGIN_DEFINE()
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
#define
Packit a6ee4b
Packit a6ee4b 
GST_PLUGIN_STATIC_DECLARE()
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
#define
Packit a6ee4b
Packit a6ee4b 
GST_PLUGIN_STATIC_REGISTER()
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gboolean
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
(*GstPluginFilter) ()
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
const gchar *
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gst_plugin_get_name ()
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
const gchar *
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gst_plugin_get_description ()
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
const gchar *
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gst_plugin_get_filename ()
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
const gchar *
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gst_plugin_get_license ()
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
const gchar *
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gst_plugin_get_package ()
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
const gchar *
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gst_plugin_get_origin ()
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
const gchar *
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gst_plugin_get_source ()
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
const gchar *
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gst_plugin_get_version ()
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
const gchar *
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gst_plugin_get_release_date_string ()
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gboolean
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gst_plugin_is_loaded ()
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
const GstStructure *
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gst_plugin_get_cache_data ()
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
void
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gst_plugin_set_cache_data ()
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
GstPlugin *
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gst_plugin_load_file ()
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
GstPlugin *
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gst_plugin_load ()
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
GstPlugin *
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gst_plugin_load_by_name ()
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
void
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gst_plugin_list_free ()
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gboolean
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gst_plugin_register_static ()
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gboolean
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gst_plugin_register_static_full ()
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
void
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gst_plugin_add_dependency ()
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
void
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gst_plugin_add_dependency_simple ()
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
Types and Values
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
#define
Packit a6ee4b 
GST_PLUGIN_ERROR
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
enum
Packit a6ee4b 
GstPluginError
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
 
Packit a6ee4b 
GstPlugin
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
struct
Packit a6ee4b 
GstPluginDesc
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
#define
Packit a6ee4b 
GST_LICENSE_UNKNOWN
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
enum
Packit a6ee4b 
GstPluginFlags
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
enum
Packit a6ee4b 
GstPluginDependencyFlags
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
Object Hierarchy
Packit a6ee4b 
    GObject
Packit a6ee4b 
    ╰── GInitiallyUnowned
Packit a6ee4b 
        ╰── GstObject
Packit a6ee4b 
            ╰── GstPlugin
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
Includes
Packit a6ee4b 
#include <gst/gst.h>
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
Description
Packit a6ee4b 
GStreamer is extensible, so GstElement instances can be loaded at runtime.
Packit a6ee4b 
A plugin system can provide one or more of the basic
Packit a6ee4b 
GStreamerGstPluginFeature subclasses.
Packit a6ee4b 
A plugin should export a symbol gst_plugin_desc that is a
Packit a6ee4b 
struct of type GstPluginDesc.
Packit a6ee4b 
the plugin loader will check the version of the core library the plugin was
Packit a6ee4b 
linked against and will create a new GstPlugin. It will then call the
Packit a6ee4b 
GstPluginInitFunc function that was provided in the
Packit a6ee4b 
gst_plugin_desc.
Packit a6ee4b 
Once you have a handle to a GstPlugin (e.g. from the GstRegistry), you
Packit a6ee4b 
can add any object that subclasses GstPluginFeature.
Packit a6ee4b 
Usually plugins are always automatically loaded so you don't need to call
Packit a6ee4b 
gst_plugin_load() explicitly to bring it into memory. There are options to
Packit a6ee4b 
statically link plugins to an app or even use GStreamer without a plugin
Packit a6ee4b 
repository in which case gst_plugin_load() can be needed to bring the plugin
Packit a6ee4b 
into memory.
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
Functions
Packit a6ee4b
Packit a6ee4b 
gst_plugin_error_quark ()
Packit a6ee4b 
GQuark
Packit a6ee4b 
gst_plugin_error_quark (void);
Packit a6ee4b 
Get the error quark.
Packit a6ee4b
Packit a6ee4b 
Returns
Packit a6ee4b 
 The error quark used in GError messages
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
GstPluginInitFunc ()
Packit a6ee4b 
gboolean
Packit a6ee4b 
(*GstPluginInitFunc) (GstPlugin *plugin);
Packit a6ee4b 
A plugin should provide a pointer to a function of this type in the
Packit a6ee4b 
plugin_desc struct.
Packit a6ee4b 
This function will be called by the loader at startup. One would then
Packit a6ee4b 
register each GstPluginFeature.
Packit a6ee4b
Packit a6ee4b 
Parameters
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
plugin
Packit a6ee4b 
The plugin object
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
Returns
Packit a6ee4b 
 TRUE if plugin initialised successfully
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
GstPluginInitFullFunc ()
Packit a6ee4b 
gboolean
Packit a6ee4b 
(*GstPluginInitFullFunc) (GstPlugin *plugin,
Packit a6ee4b 
                          gpointer user_data);
Packit a6ee4b 
A plugin should provide a pointer to a function of either GstPluginInitFunc
Packit a6ee4b 
or this type in the plugin_desc struct.
Packit a6ee4b 
The function will be called by the loader at startup. One would then
Packit a6ee4b 
register each GstPluginFeature. This version allows
Packit a6ee4b 
user data to be passed to init function (useful for bindings).
Packit a6ee4b
Packit a6ee4b 
Parameters
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
plugin
Packit a6ee4b 
The plugin object
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
user_data
Packit a6ee4b 
extra data
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
Returns
Packit a6ee4b 
 TRUE if plugin initialised successfully
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
GST_PLUGIN_DEFINE()
Packit a6ee4b 
#define             GST_PLUGIN_DEFINE(major,minor,name,description,init,version,license,package,origin)
Packit a6ee4b 
This macro needs to be used to define the entry point and meta data of a
Packit a6ee4b 
plugin. One would use this macro to export a plugin, so that it can be used
Packit a6ee4b 
by other applications.
Packit a6ee4b 
The macro uses a define named PACKAGE for the GstPluginDesc,source field.
Packit a6ee4b 
When using autoconf, this is usually set automatically via the AC_INIT
Packit a6ee4b 
macro, and set in config.h. If you are not using autoconf, you will need to
Packit a6ee4b 
define PACKAGE yourself and set it to a short mnemonic string identifying
Packit a6ee4b 
your application/package, e.g. 'someapp' or 'my-plugins-foo.
Packit a6ee4b 
If defined, the GST_PACKAGE_RELEASE_DATETIME will also be used for the
Packit a6ee4b 
GstPluginDesc,release_datetime field.
Packit a6ee4b
Packit a6ee4b 
Parameters
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
major
Packit a6ee4b 
major version number of the gstreamer-core that plugin was compiled for
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
minor
Packit a6ee4b 
minor version number of the gstreamer-core that plugin was compiled for
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
name
Packit a6ee4b 
short, but unique name of the plugin
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
description
Packit a6ee4b 
information about the purpose of the plugin
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
init
Packit a6ee4b 
function pointer to the plugin_init method with the signature of static gboolean plugin_init (GstPlugin * plugin).
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
version
Packit a6ee4b 
full version string (e.g. VERSION from config.h)
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
license
Packit a6ee4b 
under which licence the package has been released, e.g. GPL, LGPL.
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
package
Packit a6ee4b 
the package-name (e.g. PACKAGE_NAME from config.h)
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
origin
Packit a6ee4b 
a description from where the package comes from (e.g. the homepage URL)
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
GST_PLUGIN_STATIC_DECLARE()
Packit a6ee4b 
#define             GST_PLUGIN_STATIC_DECLARE(name)
Packit a6ee4b 
This macro can be used to initialize statically linked plugins. It is
Packit a6ee4b 
necessary to call this macro before the plugin can be used.
Packit a6ee4b 
It has to be used in combination with GST_PLUGIN_STATIC_REGISTER
Packit a6ee4b 
and must be placed outside any block to declare the plugin initialization
Packit a6ee4b 
function.
Packit a6ee4b
Packit a6ee4b 
Parameters
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
name
Packit a6ee4b 
short, but unique name of the plugin
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
Since: 1.2
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
GST_PLUGIN_STATIC_REGISTER()
Packit a6ee4b 
#define GST_PLUGIN_STATIC_REGISTER(name) G_PASTE(gst_plugin_, G_PASTE(name, _register)) ()
Packit a6ee4b
Packit a6ee4b 
This macro can be used to initialize statically linked plugins. It is
Packit a6ee4b 
necessary to call this macro before the plugin can be used.
Packit a6ee4b 
It has to be used in combination with GST_PLUGIN_STATIC_DECLARE and
Packit a6ee4b 
calls the plugin initialization function.
Packit a6ee4b
Packit a6ee4b 
Parameters
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
name
Packit a6ee4b 
short, but unique name of the plugin
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
Since: 1.2
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
GstPluginFilter ()
Packit a6ee4b 
gboolean
Packit a6ee4b 
(*GstPluginFilter) (GstPlugin *plugin,
Packit a6ee4b 
                    gpointer user_data);
Packit a6ee4b 
A function that can be used with e.g. gst_registry_plugin_filter()
Packit a6ee4b 
to get a list of plugins that match certain criteria.
Packit a6ee4b
Packit a6ee4b 
Parameters
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
plugin
Packit a6ee4b 
the plugin to check
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
user_data
Packit a6ee4b 
the user_data that has been passed on e.g. gst_registry_plugin_filter()
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
Returns
Packit a6ee4b 
 TRUE for a positive match, FALSE otherwise
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gst_plugin_get_name ()
Packit a6ee4b 
const gchar *
Packit a6ee4b 
gst_plugin_get_name (GstPlugin *plugin);
Packit a6ee4b 
Get the short name of the plugin
Packit a6ee4b
Packit a6ee4b 
Parameters
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
plugin
Packit a6ee4b 
plugin to get the name of
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
Returns
Packit a6ee4b 
 the name of the plugin
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gst_plugin_get_description ()
Packit a6ee4b 
const gchar *
Packit a6ee4b 
gst_plugin_get_description (GstPlugin *plugin);
Packit a6ee4b 
Get the long descriptive name of the plugin
Packit a6ee4b
Packit a6ee4b 
Parameters
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
plugin
Packit a6ee4b 
plugin to get long name of
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
Returns
Packit a6ee4b 
 the long name of the plugin
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gst_plugin_get_filename ()
Packit a6ee4b 
const gchar *
Packit a6ee4b 
gst_plugin_get_filename (GstPlugin *plugin);
Packit a6ee4b 
get the filename of the plugin
Packit a6ee4b
Packit a6ee4b 
Parameters
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
plugin
Packit a6ee4b 
plugin to get the filename of
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
Returns
Packit a6ee4b 
the filename of the plugin.
Packit a6ee4b 
[type filename]
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gst_plugin_get_license ()
Packit a6ee4b 
const gchar *
Packit a6ee4b 
gst_plugin_get_license (GstPlugin *plugin);
Packit a6ee4b 
get the license of the plugin
Packit a6ee4b
Packit a6ee4b 
Parameters
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
plugin
Packit a6ee4b 
plugin to get the license of
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
Returns
Packit a6ee4b 
 the license of the plugin
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gst_plugin_get_package ()
Packit a6ee4b 
const gchar *
Packit a6ee4b 
gst_plugin_get_package (GstPlugin *plugin);
Packit a6ee4b 
get the package the plugin belongs to.
Packit a6ee4b
Packit a6ee4b 
Parameters
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
plugin
Packit a6ee4b 
plugin to get the package of
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
Returns
Packit a6ee4b 
 the package of the plugin
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gst_plugin_get_origin ()
Packit a6ee4b 
const gchar *
Packit a6ee4b 
gst_plugin_get_origin (GstPlugin *plugin);
Packit a6ee4b 
get the URL where the plugin comes from
Packit a6ee4b
Packit a6ee4b 
Parameters
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
plugin
Packit a6ee4b 
plugin to get the origin of
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
Returns
Packit a6ee4b 
 the origin of the plugin
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gst_plugin_get_source ()
Packit a6ee4b 
const gchar *
Packit a6ee4b 
gst_plugin_get_source (GstPlugin *plugin);
Packit a6ee4b 
get the source module the plugin belongs to.
Packit a6ee4b
Packit a6ee4b 
Parameters
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
plugin
Packit a6ee4b 
plugin to get the source of
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
Returns
Packit a6ee4b 
 the source of the plugin
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gst_plugin_get_version ()
Packit a6ee4b 
const gchar *
Packit a6ee4b 
gst_plugin_get_version (GstPlugin *plugin);
Packit a6ee4b 
get the version of the plugin
Packit a6ee4b
Packit a6ee4b 
Parameters
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
plugin
Packit a6ee4b 
plugin to get the version of
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
Returns
Packit a6ee4b 
 the version of the plugin
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gst_plugin_get_release_date_string ()
Packit a6ee4b 
const gchar *
Packit a6ee4b 
gst_plugin_get_release_date_string (GstPlugin *plugin);
Packit a6ee4b 
Get the release date (and possibly time) in form of a string, if available.
Packit a6ee4b 
For normal GStreamer plugin releases this will usually just be a date in
Packit a6ee4b 
the form of "YYYY-MM-DD", while pre-releases and builds from git may contain
Packit a6ee4b 
a time component after the date as well, in which case the string will be
Packit a6ee4b 
formatted like "YYYY-MM-DDTHH:MMZ" (e.g. "2012-04-30T09:30Z").
Packit a6ee4b 
There may be plugins that do not have a valid release date set on them.
Packit a6ee4b
Packit a6ee4b 
Parameters
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
plugin
Packit a6ee4b 
plugin to get the release date of
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
Returns
Packit a6ee4b 
the date string of the plugin, or NULL if not
Packit a6ee4b 
available.
Packit a6ee4b 
[nullable]
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gst_plugin_is_loaded ()
Packit a6ee4b 
gboolean
Packit a6ee4b 
gst_plugin_is_loaded (GstPlugin *plugin);
Packit a6ee4b 
queries if the plugin is loaded into memory
Packit a6ee4b
Packit a6ee4b 
Parameters
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
plugin
Packit a6ee4b 
plugin to query
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
Returns
Packit a6ee4b 
 TRUE is loaded, FALSE otherwise
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gst_plugin_get_cache_data ()
Packit a6ee4b 
const GstStructure *
Packit a6ee4b 
gst_plugin_get_cache_data (GstPlugin *plugin);
Packit a6ee4b 
Gets the plugin specific data cache. If it is NULL there is no cached data
Packit a6ee4b 
stored. This is the case when the registry is getting rebuilt.
Packit a6ee4b
Packit a6ee4b 
Parameters
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
plugin
Packit a6ee4b 
a plugin
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
Returns
Packit a6ee4b 
The cached data as a
Packit a6ee4b 
GstStructure or NULL.
Packit a6ee4b 
[transfer none][nullable]
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gst_plugin_set_cache_data ()
Packit a6ee4b 
void
Packit a6ee4b 
gst_plugin_set_cache_data (GstPlugin *plugin,
Packit a6ee4b 
                           GstStructure *cache_data);
Packit a6ee4b 
Adds plugin specific data to cache. Passes the ownership of the structure to
Packit a6ee4b 
the plugin
Packit a6ee4b 
.
Packit a6ee4b 
The cache is flushed every time the registry is rebuilt.
Packit a6ee4b
Packit a6ee4b 
Parameters
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
plugin
Packit a6ee4b 
a plugin
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
cache_data
Packit a6ee4b 
a structure containing the data to cache.
Packit a6ee4b 
[transfer full]
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gst_plugin_load_file ()
Packit a6ee4b 
GstPlugin *
Packit a6ee4b 
gst_plugin_load_file (const gchar *filename,
Packit a6ee4b 
                      GError **error);
Packit a6ee4b 
Loads the given plugin and refs it.  Caller needs to unref after use.
Packit a6ee4b
Packit a6ee4b 
Parameters
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
filename
Packit a6ee4b 
the plugin filename to load.
Packit a6ee4b 
[type filename]
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
error
Packit a6ee4b 
pointer to a NULL-valued GError
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
Returns
Packit a6ee4b 
a reference to the existing loaded GstPlugin, a
Packit a6ee4b 
reference to the newly-loaded GstPlugin, or NULL if an error occurred.
Packit a6ee4b 
[transfer full]
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gst_plugin_load ()
Packit a6ee4b 
GstPlugin *
Packit a6ee4b 
gst_plugin_load (GstPlugin *plugin);
Packit a6ee4b 
Loads plugin
Packit a6ee4b 
. Note that the *return value* is the loaded plugin; plugin
Packit a6ee4b 
 is
Packit a6ee4b 
untouched. The normal use pattern of this function goes like this:
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
        
1
Packit a6ee4b 
2
Packit a6ee4b 
3
Packit a6ee4b 
4
Packit a6ee4b 
5
Packit a6ee4b 
        
GstPlugin *loaded_plugin;
Packit a6ee4b 
loaded_plugin = gst_plugin_load (plugin);
Packit a6ee4b 
// presumably, we're no longer interested in the potentially-unloaded plugin
Packit a6ee4b 
gst_object_unref (plugin);
Packit a6ee4b 
plugin = loaded_plugin;
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
Parameters
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
plugin
Packit a6ee4b 
plugin to load.
Packit a6ee4b 
[transfer none]
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
Returns
Packit a6ee4b 
a reference to a loaded plugin, or
Packit a6ee4b 
NULL on error.
Packit a6ee4b 
[transfer full][nullable]
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gst_plugin_load_by_name ()
Packit a6ee4b 
GstPlugin *
Packit a6ee4b 
gst_plugin_load_by_name (const gchar *name);
Packit a6ee4b 
Load the named plugin. Refs the plugin.
Packit a6ee4b
Packit a6ee4b 
Parameters
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
name
Packit a6ee4b 
name of plugin to load
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
Returns
Packit a6ee4b 
a reference to a loaded plugin, or
Packit a6ee4b 
NULL on error.
Packit a6ee4b 
[transfer full][nullable]
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gst_plugin_list_free ()
Packit a6ee4b 
void
Packit a6ee4b 
gst_plugin_list_free (GList *list);
Packit a6ee4b 
Unrefs each member of list
Packit a6ee4b 
, then frees the list.
Packit a6ee4b
Packit a6ee4b 
Parameters
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
list
Packit a6ee4b 
list of GstPlugin.
Packit a6ee4b 
[transfer full][element-type Gst.Plugin]
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gst_plugin_register_static ()
Packit a6ee4b 
gboolean
Packit a6ee4b 
gst_plugin_register_static (gint major_version,
Packit a6ee4b 
                            gint minor_version,
Packit a6ee4b 
                            const gchar *name,
Packit a6ee4b 
                            const gchar *description,
Packit a6ee4b 
                            GstPluginInitFunc init_func,
Packit a6ee4b 
                            const gchar *version,
Packit a6ee4b 
                            const gchar *license,
Packit a6ee4b 
                            const gchar *source,
Packit a6ee4b 
                            const gchar *package,
Packit a6ee4b 
                            const gchar *origin);
Packit a6ee4b 
Registers a static plugin, ie. a plugin which is private to an application
Packit a6ee4b 
or library and contained within the application or library (as opposed to
Packit a6ee4b 
being shipped as a separate module file).
Packit a6ee4b 
You must make sure that GStreamer has been initialised (with gst_init() or
Packit a6ee4b 
via gst_init_get_option_group()) before calling this function.
Packit a6ee4b
Packit a6ee4b 
Parameters
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
major_version
Packit a6ee4b 
the major version number of the GStreamer core that the
Packit a6ee4b 
plugin was compiled for, you can just use GST_VERSION_MAJOR here
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
minor_version
Packit a6ee4b 
the minor version number of the GStreamer core that the
Packit a6ee4b 
plugin was compiled for, you can just use GST_VERSION_MINOR here
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
name
Packit a6ee4b 
a unique name of the plugin (ideally prefixed with an application- or
Packit a6ee4b 
library-specific namespace prefix in order to avoid name conflicts in
Packit a6ee4b 
case a similar plugin with the same name ever gets added to GStreamer)
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
description
Packit a6ee4b 
description of the plugin
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
init_func
Packit a6ee4b 
pointer to the init function of this plugin.
Packit a6ee4b 
[scope call]
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
version
Packit a6ee4b 
version string of the plugin
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
license
Packit a6ee4b 
effective license of plugin. Must be one of the approved licenses
Packit a6ee4b 
(see GstPluginDesc above) or the plugin will not be registered.
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
source
Packit a6ee4b 
source module plugin belongs to
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
package
Packit a6ee4b 
shipped package plugin belongs to
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
origin
Packit a6ee4b 
URL to provider of plugin
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
Returns
Packit a6ee4b 
 TRUE if the plugin was registered correctly, otherwise FALSE.
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gst_plugin_register_static_full ()
Packit a6ee4b 
gboolean
Packit a6ee4b 
gst_plugin_register_static_full (gint major_version,
Packit a6ee4b 
                                 gint minor_version,
Packit a6ee4b 
                                 const gchar *name,
Packit a6ee4b 
                                 const gchar *description,
Packit a6ee4b 
                                 GstPluginInitFullFunc init_full_func,
Packit a6ee4b 
                                 const gchar *version,
Packit a6ee4b 
                                 const gchar *license,
Packit a6ee4b 
                                 const gchar *source,
Packit a6ee4b 
                                 const gchar *package,
Packit a6ee4b 
                                 const gchar *origin,
Packit a6ee4b 
                                 gpointer user_data);
Packit a6ee4b 
Registers a static plugin, ie. a plugin which is private to an application
Packit a6ee4b 
or library and contained within the application or library (as opposed to
Packit a6ee4b 
being shipped as a separate module file) with a GstPluginInitFullFunc
Packit a6ee4b 
which allows user data to be passed to the callback function (useful
Packit a6ee4b 
for bindings).
Packit a6ee4b 
You must make sure that GStreamer has been initialised (with gst_init() or
Packit a6ee4b 
via gst_init_get_option_group()) before calling this function.
Packit a6ee4b
Packit a6ee4b 
Parameters
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
major_version
Packit a6ee4b 
the major version number of the GStreamer core that the
Packit a6ee4b 
plugin was compiled for, you can just use GST_VERSION_MAJOR here
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
minor_version
Packit a6ee4b 
the minor version number of the GStreamer core that the
Packit a6ee4b 
plugin was compiled for, you can just use GST_VERSION_MINOR here
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
name
Packit a6ee4b 
a unique name of the plugin (ideally prefixed with an application- or
Packit a6ee4b 
library-specific namespace prefix in order to avoid name conflicts in
Packit a6ee4b 
case a similar plugin with the same name ever gets added to GStreamer)
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
description
Packit a6ee4b 
description of the plugin
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
init_full_func
Packit a6ee4b 
pointer to the init function with user data
Packit a6ee4b 
of this plugin.
Packit a6ee4b 
[scope call]
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
version
Packit a6ee4b 
version string of the plugin
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
license
Packit a6ee4b 
effective license of plugin. Must be one of the approved licenses
Packit a6ee4b 
(see GstPluginDesc above) or the plugin will not be registered.
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
source
Packit a6ee4b 
source module plugin belongs to
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
package
Packit a6ee4b 
shipped package plugin belongs to
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
origin
Packit a6ee4b 
URL to provider of plugin
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
user_data
Packit a6ee4b 
gpointer to user data
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
Returns
Packit a6ee4b 
 TRUE if the plugin was registered correctly, otherwise FALSE.
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gst_plugin_add_dependency ()
Packit a6ee4b 
void
Packit a6ee4b 
gst_plugin_add_dependency (GstPlugin *plugin,
Packit a6ee4b 
                           const gchar **env_vars,
Packit a6ee4b 
                           const gchar **paths,
Packit a6ee4b 
                           const gchar **names,
Packit a6ee4b 
                           GstPluginDependencyFlags flags);
Packit a6ee4b 
Make GStreamer aware of external dependencies which affect the feature
Packit a6ee4b 
set of this plugin (ie. the elements or typefinders associated with it).
Packit a6ee4b 
GStreamer will re-inspect plugins with external dependencies whenever any
Packit a6ee4b 
of the external dependencies change. This is useful for plugins which wrap
Packit a6ee4b 
other plugin systems, e.g. a plugin which wraps a plugin-based visualisation
Packit a6ee4b 
library and makes visualisations available as GStreamer elements, or a
Packit a6ee4b 
codec loader which exposes elements and/or caps dependent on what external
Packit a6ee4b 
codec libraries are currently installed.
Packit a6ee4b
Packit a6ee4b 
Parameters
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
plugin
Packit a6ee4b 
a GstPlugin
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
env_vars
Packit a6ee4b 
NULL-terminated array of environment variables affecting the
Packit a6ee4b 
feature set of the plugin (e.g. an environment variable containing
Packit a6ee4b 
paths where to look for additional modules/plugins of a library),
Packit a6ee4b 
or NULL. Environment variable names may be followed by a path component
Packit a6ee4b 
which will be added to the content of the environment variable, e.g.
Packit a6ee4b 
"HOME/.mystuff/plugins".
Packit a6ee4b 
[allow-none][array zero-terminated=1]
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
paths
Packit a6ee4b 
NULL-terminated array of directories/paths where dependent files
Packit a6ee4b 
may be, or NULL.
Packit a6ee4b 
[allow-none][array zero-terminated=1]
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
names
Packit a6ee4b 
NULL-terminated array of file names (or file name suffixes,
Packit a6ee4b 
depending on flags
Packit a6ee4b 
) to be used in combination with the paths from
Packit a6ee4b 
paths
Packit a6ee4b 
and/or the paths extracted from the environment variables in
Packit a6ee4b 
env_vars
Packit a6ee4b 
, or NULL.
Packit a6ee4b 
[allow-none][array zero-terminated=1]
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
flags
Packit a6ee4b 
optional flags, or GST_PLUGIN_DEPENDENCY_FLAG_NONE
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gst_plugin_add_dependency_simple ()
Packit a6ee4b 
void
Packit a6ee4b 
gst_plugin_add_dependency_simple (GstPlugin *plugin,
Packit a6ee4b 
                                  const gchar *env_vars,
Packit a6ee4b 
                                  const gchar *paths,
Packit a6ee4b 
                                  const gchar *names,
Packit a6ee4b 
                                  GstPluginDependencyFlags flags);
Packit a6ee4b 
Make GStreamer aware of external dependencies which affect the feature
Packit a6ee4b 
set of this plugin (ie. the elements or typefinders associated with it).
Packit a6ee4b 
GStreamer will re-inspect plugins with external dependencies whenever any
Packit a6ee4b 
of the external dependencies change. This is useful for plugins which wrap
Packit a6ee4b 
other plugin systems, e.g. a plugin which wraps a plugin-based visualisation
Packit a6ee4b 
library and makes visualisations available as GStreamer elements, or a
Packit a6ee4b 
codec loader which exposes elements and/or caps dependent on what external
Packit a6ee4b 
codec libraries are currently installed.
Packit a6ee4b 
Convenience wrapper function for gst_plugin_add_dependency() which
Packit a6ee4b 
takes simple strings as arguments instead of string arrays, with multiple
Packit a6ee4b 
arguments separated by predefined delimiters (see above).
Packit a6ee4b
Packit a6ee4b 
Parameters
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
plugin
Packit a6ee4b 
the GstPlugin
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
env_vars
Packit a6ee4b 
one or more environment variables (separated by ':', ';' or ','),
Packit a6ee4b 
or NULL. Environment variable names may be followed by a path component
Packit a6ee4b 
which will be added to the content of the environment variable, e.g.
Packit a6ee4b 
"HOME/.mystuff/plugins:MYSTUFF_PLUGINS_PATH".
Packit a6ee4b 
[allow-none]
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
paths
Packit a6ee4b 
one ore more directory paths (separated by ':' or ';' or ','),
Packit a6ee4b 
or NULL. Example: "/usr/lib/mystuff/plugins".
Packit a6ee4b 
[allow-none]
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
names
Packit a6ee4b 
one or more file names or file name suffixes (separated by commas),
Packit a6ee4b 
or NULL.
Packit a6ee4b 
[allow-none]
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
flags
Packit a6ee4b 
optional flags, or GST_PLUGIN_DEPENDENCY_FLAG_NONE
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
Types and Values
Packit a6ee4b
Packit a6ee4b 
GST_PLUGIN_ERROR
Packit a6ee4b 
#define GST_PLUGIN_ERROR gst_plugin_error_quark ()
Packit a6ee4b
Packit a6ee4b 
The error message category quark
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
enum GstPluginError
Packit a6ee4b 
The plugin loading errors
Packit a6ee4b
Packit a6ee4b 
Members
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
GST_PLUGIN_ERROR_MODULE
Packit a6ee4b
Packit a6ee4b 
The plugin could not be loaded
Packit a6ee4b
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
GST_PLUGIN_ERROR_DEPENDENCIES
Packit a6ee4b
Packit a6ee4b 
The plugin has unresolved dependencies
Packit a6ee4b
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
GST_PLUGIN_ERROR_NAME_MISMATCH
Packit a6ee4b
Packit a6ee4b 
The plugin has already be loaded from a different file
Packit a6ee4b
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
GstPlugin
Packit a6ee4b 
typedef struct _GstPlugin GstPlugin;
Packit a6ee4b 
The opaque plugin object
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
struct GstPluginDesc
Packit a6ee4b 
struct GstPluginDesc {
Packit a6ee4b 
  gint major_version;
Packit a6ee4b 
  gint minor_version;
Packit a6ee4b 
  const gchar *name;
Packit a6ee4b 
  const gchar *description;
Packit a6ee4b 
  GstPluginInitFunc plugin_init;
Packit a6ee4b 
  const gchar *version;
Packit a6ee4b 
  const gchar *license;
Packit a6ee4b 
  const gchar *source;
Packit a6ee4b 
  const gchar *package;
Packit a6ee4b 
  const gchar *origin;
Packit a6ee4b 
  const gchar *release_datetime;
Packit a6ee4b 
};
Packit a6ee4b
Packit a6ee4b 
A plugin should export a variable of this type called plugin_desc. The plugin
Packit a6ee4b 
loader will use the data provided there to initialize the plugin.
Packit a6ee4b 
The licence
Packit a6ee4b 
 parameter must be one of: LGPL, GPL, QPL, GPL/QPL, MPL,
Packit a6ee4b 
BSD, MIT/X11, Proprietary, unknown.
Packit a6ee4b
Packit a6ee4b 
Members
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gint major_version;
Packit a6ee4b 
the major version number of core that plugin was compiled for
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
gint minor_version;
Packit a6ee4b 
the minor version number of core that plugin was compiled for
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
const gchar *name;
Packit a6ee4b 
a unique name of the plugin
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
const gchar *description;
Packit a6ee4b 
description of plugin
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
GstPluginInitFunc plugin_init;
Packit a6ee4b 
pointer to the init function of this plugin.
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
const gchar *version;
Packit a6ee4b 
version of the plugin
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
const gchar *license;
Packit a6ee4b 
effective license of plugin
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
const gchar *source;
Packit a6ee4b 
source module plugin belongs to
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
const gchar *package;
Packit a6ee4b 
shipped package plugin belongs to
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
const gchar *origin;
Packit a6ee4b 
URL to provider of plugin
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
const gchar *release_datetime;
Packit a6ee4b 
date time string in ISO 8601
Packit a6ee4b 
format (or rather, a subset thereof), or NULL. Allowed are the
Packit a6ee4b 
following formats: "YYYY-MM-DD" and "YYY-MM-DDTHH:MMZ" (with
Packit a6ee4b 
'T' a separator and 'Z' indicating UTC/Zulu time). This field
Packit a6ee4b 
should be set via the GST_PACKAGE_RELEASE_DATETIME
Packit a6ee4b 
preprocessor macro.
Packit a6ee4b 
[allow-none]
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
GST_LICENSE_UNKNOWN
Packit a6ee4b 
#define GST_LICENSE_UNKNOWN "unknown"
Packit a6ee4b
Packit a6ee4b 
To be used in GST_PLUGIN_DEFINE if unsure about the licence.
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
enum GstPluginFlags
Packit a6ee4b 
The plugin loading state
Packit a6ee4b
Packit a6ee4b 
Members
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
GST_PLUGIN_FLAG_CACHED
Packit a6ee4b
Packit a6ee4b 
Temporarily loaded plugins
Packit a6ee4b
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
GST_PLUGIN_FLAG_BLACKLISTED
Packit a6ee4b
Packit a6ee4b 
The plugin won't be scanned (again)
Packit a6ee4b
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
enum GstPluginDependencyFlags
Packit a6ee4b 
Flags used in connection with gst_plugin_add_dependency().
Packit a6ee4b
Packit a6ee4b 
Members
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
GST_PLUGIN_DEPENDENCY_FLAG_NONE
Packit a6ee4b
Packit a6ee4b 
no special flags
Packit a6ee4b
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
GST_PLUGIN_DEPENDENCY_FLAG_RECURSE
Packit a6ee4b
Packit a6ee4b 
recurse into subdirectories
Packit a6ee4b
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
GST_PLUGIN_DEPENDENCY_FLAG_PATHS_ARE_DEFAULT_ONLY
Packit a6ee4b
Packit a6ee4b 
use paths
Packit a6ee4b 
        argument only if none of the environment variables is set
Packit a6ee4b
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
GST_PLUGIN_DEPENDENCY_FLAG_FILE_NAME_IS_SUFFIX
Packit a6ee4b
Packit a6ee4b 
interpret
Packit a6ee4b 
        filename argument as filter suffix and check all matching files in
Packit a6ee4b 
        the directory
Packit a6ee4b
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
GST_PLUGIN_DEPENDENCY_FLAG_FILE_NAME_IS_PREFIX
Packit a6ee4b
Packit a6ee4b 
interpret
Packit a6ee4b 
        filename argument as filter prefix and check all matching files in
Packit a6ee4b 
        the directory. Since: 1.8.
Packit a6ee4b
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
GST_PLUGIN_DEPENDENCY_FLAG_PATHS_ARE_RELATIVE_TO_EXE
Packit a6ee4b
Packit a6ee4b 
interpret
Packit a6ee4b 
  non-absolute paths as relative to the main executable directory. Since
Packit a6ee4b 
  1.14.
Packit a6ee4b
Packit a6ee4b 
 
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
See Also
Packit a6ee4b 
GstPluginFeature, GstElementFactory
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b
Packit a6ee4b 
Generated by GTK-Doc V1.28
Packit a6ee4b 
</body>
Packit a6ee4b 
</html>

Powered by Pagure 5.14.1

SSH Hostkey/Fingerprint | Documentation