GstPlugin

GstPlugin

GObject
    ╰──GInitiallyUnowned
        ╰──GstObject
            ╰──GstPlugin

Class structure

gst_plugin_add_dependency

gst_plugin_add_dependency (GstPlugin * plugin,
                           const gchar ** env_vars,
                           const gchar ** paths,
                           const gchar ** 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).

GStreamer will re-inspect plugins with external dependencies whenever any of the external dependencies change. This is useful for plugins which wrap other plugin systems, e.g. a plugin which wraps a plugin-based visualisation library and makes visualisations available as GStreamer elements, or a codec loader which exposes elements and/or caps dependent on what external codec libraries are currently installed.

gst_plugin_add_dependency_simple

gst_plugin_add_dependency_simple (GstPlugin * plugin,
                                  const gchar * env_vars,
                                  const gchar * paths,
                                  const gchar * 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).

GStreamer will re-inspect plugins with external dependencies whenever any of the external dependencies change. This is useful for plugins which wrap other plugin systems, e.g. a plugin which wraps a plugin-based visualisation library and makes visualisations available as GStreamer elements, or a codec loader which exposes elements and/or caps dependent on what external codec libraries are currently installed.

Convenience wrapper function for gst_plugin_add_dependency which takes simple strings as arguments instead of string arrays, with multiple arguments separated by predefined delimiters (see above).

gst_plugin_add_status_error

gst_plugin_add_status_error (GstPlugin * plugin,
                             const gchar * message)

Since : 1.24

gst_plugin_add_status_info

gst_plugin_add_status_info (GstPlugin * plugin,
                            const gchar * message)

Since : 1.24

gst_plugin_add_status_warning

gst_plugin_add_status_warning (GstPlugin * plugin,
                               const gchar * message)

Since : 1.24

gst_plugin_get_cache_data

const GstStructure *
gst_plugin_get_cache_data (GstPlugin * plugin)

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.

gst_plugin_get_description

const gchar *
gst_plugin_get_description (GstPlugin * plugin)

Get the long descriptive name of the plugin

gst_plugin_get_filename

const gchar *
gst_plugin_get_filename (GstPlugin * plugin)

get the filename of the plugin

gst_plugin_get_license

const gchar *
gst_plugin_get_license (GstPlugin * plugin)

get the license of the plugin

gst_plugin_get_name

const gchar *
gst_plugin_get_name (GstPlugin * plugin)

Get the short name of the plugin

gst_plugin_get_origin

const gchar *
gst_plugin_get_origin (GstPlugin * plugin)

get the URL where the plugin comes from

gst_plugin_get_package

const gchar *
gst_plugin_get_package (GstPlugin * plugin)

get the package the plugin belongs to.

gst_plugin_get_release_date_string

const gchar *
gst_plugin_get_release_date_string (GstPlugin * plugin)

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").

There may be plugins that do not have a valid release date set on them.

gst_plugin_get_source

const gchar *
gst_plugin_get_source (GstPlugin * plugin)

get the source module the plugin belongs to.

gst_plugin_get_status_errors

gchar **
gst_plugin_get_status_errors (GstPlugin * plugin)

Since : 1.24

gst_plugin_get_status_infos

gchar **
gst_plugin_get_status_infos (GstPlugin * plugin)

Since : 1.24

gst_plugin_get_status_warnings

gchar **
gst_plugin_get_status_warnings (GstPlugin * plugin)

Since : 1.24

gst_plugin_get_version

const gchar *
gst_plugin_get_version (GstPlugin * plugin)

get the version of the plugin

gst_plugin_is_loaded

gboolean
gst_plugin_is_loaded (GstPlugin * plugin)

queries if the plugin is loaded into memory

gst_plugin_load

GstPlugin *
gst_plugin_load (GstPlugin * plugin)

Loads plugin. Note that the return value is the loaded plugin; plugin is untouched. The normal use pattern of this function goes like this:

 GstPlugin *loaded_plugin;
 loaded_plugin = gst_plugin_load (plugin);
 // presumably, we're no longer interested in the potentially-unloaded plugin
 gst_object_unref (plugin);
 plugin = loaded_plugin;

gst_plugin_set_cache_data

gst_plugin_set_cache_data (GstPlugin * plugin,
                           GstStructure * cache_data)

Adds plugin specific data to cache. Passes the ownership of the structure to the plugin.

The cache is flushed every time the registry is rebuilt.

gst_plugin_list_free

gst_plugin_list_free (GList * list)

Unrefs each member of list, then frees the list.

gst_plugin_load_by_name

GstPlugin *
gst_plugin_load_by_name (const gchar * name)

Load the named plugin. Refs the plugin.

gst_plugin_load_file

GstPlugin *
gst_plugin_load_file (const gchar * filename,
                      GError ** error)

Loads the given plugin and refs it. Caller needs to unref after use.

gst_plugin_register_static

gboolean
gst_plugin_register_static (gint major_version,
                            gint minor_version,
                            const gchar * name,
                            const gchar * description,
                            GstPluginInitFunc init_func,
                            const gchar * version,
                            const gchar * license,
                            const gchar * source,
                            const gchar * package,
                            const gchar * 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).

You must make sure that GStreamer has been initialised (with gst_init or via gst_init_get_option_group) before calling this function.

gst_plugin_register_static_full

gboolean
gst_plugin_register_static_full (gint major_version,
                                 gint minor_version,
                                 const gchar * name,
                                 const gchar * description,
                                 GstPluginInitFullFunc init_full_func,
                                 const gchar * version,
                                 const gchar * license,
                                 const gchar * source,
                                 const gchar * package,
                                 const gchar * origin,
                                 gpointer user_data)

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

You must make sure that GStreamer has been initialised (with gst_init or via gst_init_get_option_group) before calling this function.

GstPluginDesc

gst_plugin_error_quark

GQuark
gst_plugin_error_quark ()

Get the error quark.

GST_PLUGIN_CAST

#define GST_PLUGIN_CAST(obj)           ((GstPlugin*)(obj))

GST_PLUGIN_DEFINE

#define GST_PLUGIN_DEFINE(major,minor,name,description,init,version,license,package,origin) \
G_BEGIN_DECLS \
GST_PLUGIN_EXPORT const GstPluginDesc * G_PASTE(gst_plugin_, G_PASTE(name, _get_desc)) (void); \
GST_PLUGIN_EXPORT void G_PASTE(gst_plugin_, G_PASTE(name, _register)) (void); \
\
static const GstPluginDesc gst_plugin_desc = { \
  major, \
  minor, \
  G_STRINGIFY(name), \
  (gchar *) description, \
  init, \
  version, \
  license, \
  PACKAGE, \
  package, \
  origin, \
  __GST_PACKAGE_RELEASE_DATETIME, \
  GST_PADDING_INIT \
};                                       \
\
const GstPluginDesc * \
G_PASTE(gst_plugin_, G_PASTE(name, _get_desc)) (void) \
{ \
    return &gst_plugin_desc; \
} \
\
void \
G_PASTE(gst_plugin_, G_PASTE(name, _register)) (void) \
{ \
  gst_plugin_register_static (major, minor, G_STRINGIFY(name), \
      description, init, version, license, \
      PACKAGE, package, origin); \
} \
G_END_DECLS

This macro needs to be used to define the entry point and meta data of a plugin. One would use this macro to export a plugin, so that it can be used by other applications.

The macro uses a define named PACKAGE for the GstPluginDesc,source field. When using autoconf, this is usually set automatically via the AC_INIT macro, and set in config.h. If you are not using autoconf, you will need to define PACKAGE yourself and set it to a short mnemonic string identifying your application/package, e.g. 'someapp' or 'my-plugins-foo.

If defined, the GST_PACKAGE_RELEASE_DATETIME will also be used for the GstPluginDesc,release_datetime field.

GST_PLUGIN_STATIC_DECLARE

#define GST_PLUGIN_STATIC_DECLARE(name) \
  extern void G_PASTE(gst_plugin_, G_PASTE(name, _register)) (void)

This macro can be used to initialize statically linked plugins. It is necessary to call this macro before the plugin can be used. It has to be used in combination with GST_PLUGIN_STATIC_REGISTER and must be placed outside any block to declare the plugin initialization function.

Since : 1.2

GST_PLUGIN_STATIC_REGISTER

#define GST_PLUGIN_STATIC_REGISTER(name) G_PASTE(gst_plugin_, G_PASTE(name, _register)) ()

This macro can be used to initialize statically linked plugins. It is necessary to call this macro before the plugin can be used. It has to be used in combination with GST_PLUGIN_STATIC_DECLARE and calls the plugin initialization function.

Since : 1.2

GstPluginDependencyFlags

Flags used in connection with gst_plugin_add_dependency.

GstPluginError

The plugin loading errors

GstPluginFlags

The plugin loading state

GST_LICENSE_UNKNOWN

#define GST_LICENSE_UNKNOWN "unknown"

To be used in GST_PLUGIN_DEFINE if unsure about the licence.

GST_PLUGIN_ERROR

#define GST_PLUGIN_ERROR gst_plugin_error_quark ()

The error message category quark

__GST_PACKAGE_RELEASE_DATETIME

#define __GST_PACKAGE_RELEASE_DATETIME GST_PACKAGE_RELEASE_DATETIME

GstPluginFilter

gboolean
(*GstPluginFilter) (GstPlugin * plugin,
                    gpointer user_data)

A function that can be used with e.g. gst_registry_plugin_filter to get a list of plugins that match certain criteria.

GstPluginInitFullFunc

gboolean
(*GstPluginInitFullFunc) (GstPlugin * plugin,
                          gpointer user_data)

A plugin should provide a pointer to a function of either GstPluginInitFunc or this type in the plugin_desc struct. The function will be called by the loader at startup. One would then register each GstPluginFeature. This version allows user data to be passed to init function (useful for bindings).

GstPluginInitFunc

gboolean
(*GstPluginInitFunc) (GstPlugin * plugin)

A plugin should provide a pointer to a function of this type in the plugin_desc struct. This function will be called by the loader at startup. One would then register each GstPluginFeature.