<!-- ##### MACRO GST_BUFFER_DURATION ##### -->
<para>
-
+Gets the duration in nanoseconds of the data in the buffer.
+Value will be GST_CLOCK_TIME_NONE if the duration is unknown.
</para>
-@buf:
+@buf: a #GstBuffer to get the duration from.
<!-- ##### MACRO GST_BUFFER_OFFSET ##### -->
<para>
-Gets the offset in the source file of this buffer.
+Gets the offset in the source file of the beinning of this buffer.
</para>
@buf: a #GstBuffer to get offset of.
<!-- ##### MACRO GST_BUFFER_OFFSET_END ##### -->
<para>
-
+Gets the offset in the source file of the end of this buffer.
</para>
-@buf:
+@buf: a #GstBuffer to get offset of.
<!-- ##### MACRO gst_buffer_ref ##### -->
<!-- ##### MACRO GST_BUFFER_FREE_DATA_FUNC ##### -->
<para>
-
+A function that should be called if the buffer has no more references left.
+Elements that utilize hardware memory could use this to re-queue
+the buffer after it's been unreferenced. If no free_data_func has been
+provided, the default will be used which simply deallocates the memory
+region and the GstBuffer object. Manual implementations that want to
+free their own memory but don't do anything special otherwise are
+suggested to set the GST_BUFFER_DONTFREE flag on the buffer and call the
+default data free function (gst_buffer_default_free()) from their manual
+implementation.
</para>
-@buf:
+@buf: the #GstBuffer this function belongs to
<!-- ##### USER_FUNCTION GstBufferFreeDataFunc ##### -->
<para>
-
+the type for the GST_BUFFER_FREE_DATA_FUNC
</para>
-@buffer:
+@buffer: the #GstBuffer on which it will operate, when called
<!-- ##### MACRO GST_BUFFER_PRIVATE ##### -->
<para>
-
+Private data for the buffer. This can be used to store a pointer to the
+object that can then be retrieved in something like the BUFFER_FREE_DATA_FUNC.
</para>
-@buf:
+@buf: the #GstBuffer this data belongs to
<!-- ##### MACRO GST_BUFFER_OFFSET_NONE ##### -->
<!-- ##### MACRO GST_BUFFER_DURATION_IS_VALID ##### -->
<para>
-
+Tests if the duration is known.
</para>
-@buffer:
+@buffer: the #GstBuffer to check for the duration
<!-- ##### MACRO GST_BUFFER_TIMESTAMP_IS_VALID ##### -->
<para>
-
+Tests if the timestamp is known.
</para>
-@buffer:
+@buffer: the #GstBuffer to check for the timestamp
<!-- ##### MACRO GST_BUFFER_OFFSET_IS_VALID ##### -->
<!-- ##### MACRO GST_ELEMENT_ERROR ##### -->
<para>
-
+Utility function that elements can use in case they encountered a fatal
+data processing error. The pipeline will throw an error signal and the
+application will be requested to stop further media processing.
</para>
-@el:
+@el: the element that throws the error
@domain:
@code:
-@message:
+@message: the message to display
@debug:
loaded will use this variable to initialize the plugin.
</para>
-@major_version: The minor version of the gstreamer library this plugin was created with
-@minor_version: The minor version of the gstreamer library this plugin was created with
-@name: The name of the plugin
+@major_version: the major version number of core that plugin was compiled for
+@minor_version: the minor version number of core that plugin was compiled for
+@name: a unique name of the plugin
@description:
@plugin_init: The init function of this plugin.
@plugin_exit:
-@version:
-@license:
-@package:
-@origin:
+@version: version of the plugin
+@license: effective license of plugin
+@package: package plugin belongs to
+@origin: URL to provider of plugin
@_gst_reserved:
<!-- ##### USER_FUNCTION GstPluginInitFunc ##### -->
<!-- ##### USER_FUNCTION GstPluginExitFunc ##### -->
<para>
-
+Exiting function when plugin is unloaded.
</para>
-@plugin:
+@plugin: The plugin object that can be used to unregister stuff for this plugin.
<!-- ##### MACRO GST_PLUGIN_DEFINE ##### -->
<para>
-
+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
</para>
-@major:
-@minor:
-@name:
-@description:
-@init:
-@version:
-@license:
-@package:
-@origin:
+@major: major version number of the gstreamer-core that plugin was compiled for
+@minor: minor version number of the gstreamer-core that plugin was compiled for
+@name: short, but unique name of the plugin
+@description: information about the purpose of the plugin
+@init: function pointer to the plugin_init method with the signature of <code>static gboolean plugin_init (GstPlugin * plugin)</code>.
+@version: full version string (e.g. VERSION from config.h)
+@license: under which licence the package has been released, e.g. GPL, LGPL.
+@package: the package-name (e.g. PACKAGE_NAME from config.h)
+@origin: a description from where the package comes from (e.g. the homepage URL)
<!-- ##### MACRO GST_PLUGIN_DEFINE_STATIC ##### -->
<para>
-
+This macro needs to be used to define the entry point and meta data of a local plugin.
+One would use this macro to define a local plugin that can only be used by the own application.
</para>
-@major:
-@minor:
-@name:
-@description:
-@init:
-@version:
-@license:
-@package:
-@origin:
+@major: major version number of the gstreamer-core that plugin was compiled for
+@minor: minor version number of the gstreamer-core that plugin was compiled for
+@name: short, but unique name of the plugin
+@description: information about the purpose of the plugin
+@init: function pointer to the plugin_init method with the signature of <code>static gboolean plugin_init (GstPlugin * plugin)</code>.
+@version: full version string (e.g. VERSION from config.h)
+@license: under which licence the package has been released, e.g. GPL, LGPL.
+@package: the package-name (e.g. PACKAGE_NAME from config.h)
+@origin: a description from where the package comes from (e.g. the homepage URL)
<!-- ##### MACRO GST_LICENSE_UNKNOWN ##### -->
$Id$
+* existing gstreamer interfaces
+ ./gstreamer/gst/gsttaginterface.c
+ ./gstreamer/gst/gstinterface.c
+ ./gstreamer/gst/gsturi.c
+ ./gst-plugins/gst-libs/gst/propertyprobe/propertyprobe.c
+ ./gst-plugins/gst-libs/gst/mixer/mixer.c
+ ./gst-plugins/gst-libs/gst/tuner/tuner.c
+ ./gst-plugins/gst-libs/gst/xoverlay/xoverlay.c
+ ./gst-plugins/gst-libs/gst/colorbalance/colorbalance.c
+ ./gst-plugins/gst-libs/gst/navigation/navigation.c
* new general interfaces
* GST_TYPE_PRESET_MANAGER
- add preset managment
G_BEGIN_DECLS
-/* make our own type for poptOption because gtkdoc (1.2) can not handle functions with
- * return types like 'struct abc'
+/* make our own type for poptOption because gtkdoc-1.2 can not handle functions
+ * with return types like 'struct abc'
* Filed as http://bugzilla.gnome.org/show_bug.cgi?id=148507
+ *
+ * Btw. popt provides a typedef, but it is:
+ * typedef struct poptOption *poptOption
*/
typedef struct poptOption GstPoptOption;
gpointer _gst_reserved[GST_PADDING];
};
-/**
- * GST_PLUGIN_DEFINE:
- * @major: major version number
- * @minor: minor version number
- * @name: short name of the plugin
- * @description: information about the purpose of the plugin
- * @init: function pointer to the plugin_init method with the signature of <code>static gboolean plugin_init (GstPlugin * plugin)</code>.
- * @version: full version string (e.g. VERSION from config.h)
- * @license: under which licence the package has been released, e.g. GPL, LGPL.
- * @package: the package-name (e.g. PACKAGE_NAME from config.h)
- * @origin: a description from where the package comes from (e.g. the homepage URL)
- *
- * 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.
- */
#define GST_PLUGIN_DEFINE(major,minor,name,description,init,version,license,package,origin) \
GST_PLUGIN_EXPORT GstPluginDesc gst_plugin_desc = { \
major, \
GST_PADDING_INIT \
};
-/**
- * GST_PLUGIN_DEFINE_STATIC:
- * @major: major version number
- * @minor: minor version number
- * @name: short name of the plugin
- * @description: information about the purpose of the plugin
- * @init: function pointer to the plugin_init method with the signature of <code>static gboolean plugin_init (GstPlugin * plugin)</code>.
- * @version: full version string (e.g. VERSION from config.h)
- * @license: under which licence the package has been released, e.g. GPL, LGPL.
- * @package: the package-name (e.g. PACKAGE_NAME from config.h)
- * @origin: a description from where the package comes from (e.g. the homepage URL)
- *
- * This macro needs to be used to define the entry point and meta data of a local plugin.
- * One would use this macro to define a local plugin that can only be used by the own application.
- */
#define GST_PLUGIN_DEFINE_STATIC(major,minor,name,description,init,version,license,package,origin) \
static void GST_GNUC_CONSTRUCTOR \
_gst_plugin_static_init__ ##init (void) \
projects / platform / upstream / gstreamer.git / commitdiff