1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>gstpbutils</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7 <link rel="home" href="index.html" title="GStreamer Base Plugins 0.10 Library Reference Manual">
8 <link rel="up" href="gstreamer-base-utils.html" title="Base Utils Library">
9 <link rel="prev" href="gstreamer-base-utils.html" title="Base Utils Library">
10 <link rel="next" href="gst-plugins-base-libs-gstpbutilscodecutils.html" title="gstpbutilscodecutils">
11 <meta name="generator" content="GTK-Doc V1.17 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17 <td><a accesskey="p" href="gstreamer-base-utils.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="gstreamer-base-utils.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20 <th width="100%" align="center">GStreamer Base Plugins 0.10 Library Reference Manual</th>
21 <td><a accesskey="n" href="gst-plugins-base-libs-gstpbutilscodecutils.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#gst-plugins-base-libs-gstpbutils.synopsis" class="shortcut">Top</a>
26 <a href="#gst-plugins-base-libs-gstpbutils.description" class="shortcut">Description</a>
29 <div class="refentry">
30 <a name="gst-plugins-base-libs-gstpbutils"></a><div class="titlepage"></div>
31 <div class="refnamediv"><table width="100%"><tr>
33 <h2><span class="refentrytitle"><a name="gst-plugins-base-libs-gstpbutils.top_of_page"></a>gstpbutils</span></h2>
34 <p>gstpbutils — General Application and Plugin Utility Library</p>
36 <td valign="top" align="right"></td>
38 <div class="refsynopsisdiv">
39 <a name="gst-plugins-base-libs-gstpbutils.synopsis"></a><h2>Synopsis</h2>
40 <pre class="synopsis">
41 #include <gst/pbutils/pbutils.h>
43 <span class="returnvalue">void</span> <a class="link" href="gst-plugins-base-libs-gstpbutils.html#gst-pb-utils-init" title="gst_pb_utils_init ()">gst_pb_utils_init</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
45 #define <a class="link" href="gst-plugins-base-libs-gstpbutils.html#GST-PLUGINS-BASE-VERSION-MAJOR:CAPS" title="GST_PLUGINS_BASE_VERSION_MAJOR">GST_PLUGINS_BASE_VERSION_MAJOR</a>
46 #define <a class="link" href="gst-plugins-base-libs-gstpbutils.html#GST-PLUGINS-BASE-VERSION-MINOR:CAPS" title="GST_PLUGINS_BASE_VERSION_MINOR">GST_PLUGINS_BASE_VERSION_MINOR</a>
47 #define <a class="link" href="gst-plugins-base-libs-gstpbutils.html#GST-PLUGINS-BASE-VERSION-MICRO:CAPS" title="GST_PLUGINS_BASE_VERSION_MICRO">GST_PLUGINS_BASE_VERSION_MICRO</a>
48 #define <a class="link" href="gst-plugins-base-libs-gstpbutils.html#GST-PLUGINS-BASE-VERSION-NANO:CAPS" title="GST_PLUGINS_BASE_VERSION_NANO">GST_PLUGINS_BASE_VERSION_NANO</a>
49 #define <a class="link" href="gst-plugins-base-libs-gstpbutils.html#GST-CHECK-PLUGINS-BASE-VERSION:CAPS" title="GST_CHECK_PLUGINS_BASE_VERSION()">GST_CHECK_PLUGINS_BASE_VERSION</a> (major,
52 <span class="returnvalue">void</span> <a class="link" href="gst-plugins-base-libs-gstpbutils.html#gst-plugins-base-version" title="gst_plugins_base_version ()">gst_plugins_base_version</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *major</code></em>,
53 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *minor</code></em>,
54 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *micro</code></em>,
55 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *nano</code></em>);
56 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gst-plugins-base-libs-gstpbutils.html#gst-plugins-base-version-string" title="gst_plugins_base_version_string ()">gst_plugins_base_version_string</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
59 <div class="refsect1">
60 <a name="gst-plugins-base-libs-gstpbutils.description"></a><h2>Description</h2>
63 <div class="refsect2">
64 <a name="idp19337104"></a><h3>Linking to this library</h3>
66 libgstpbutils is a general utility library for plugins and applications,
67 available since gst-plugins-base 0.10.12. It currently provides the
70 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
71 <li class="listitem"><p>
72 human-readable description strings of codecs, elements, sources, decoders,
73 encoders, or sinks from decoder/encoder caps, element names, or protocol
76 <li class="listitem"><p>
77 support for applications to initiate installation of missing plugins (if
78 this is supported by the distribution or operating system used)
80 <li class="listitem"><p>
81 API for GStreamer elements to create missing-plugin messages in order to
82 communicate to the application that a certain type of plugin is missing
83 (decoder, encoder, URI protocol source, URI protocol sink, named element)
85 <li class="listitem"><p>
86 API for applications to recognise and handle missing-plugin messages
90 You should obtain the required CFLAGS and LIBS using pkg-config on the
91 gstreamer-plugins-base-0.10 module. You will then also need to add
92 '-lgstpbutils-0.10' manually to your LIBS line.
95 Before using any of its functions, applications and plugins must call
96 <a class="link" href="gst-plugins-base-libs-gstpbutils.html#gst-pb-utils-init" title="gst_pb_utils_init ()"><code class="function">gst_pb_utils_init()</code></a> to initialise the library.
102 <div class="refsect1">
103 <a name="gst-plugins-base-libs-gstpbutils.details"></a><h2>Details</h2>
104 <div class="refsect2">
105 <a name="gst-pb-utils-init"></a><h3>gst_pb_utils_init ()</h3>
106 <pre class="programlisting"><span class="returnvalue">void</span> gst_pb_utils_init (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
108 Initialises the base utils support library. This function is not
109 thread-safe. Applications should call it after calling <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-Gst.html#gst-init"><code class="function">gst_init()</code></a>,
110 plugins should call it from their plugin_init function.
113 This function may be called multiple times. It will do nothing if the
114 library has already been initialised.
116 <p class="since">Since 0.10.12</p>
119 <div class="refsect2">
120 <a name="GST-PLUGINS-BASE-VERSION-MAJOR:CAPS"></a><h3>GST_PLUGINS_BASE_VERSION_MAJOR</h3>
121 <pre class="programlisting">#define GST_PLUGINS_BASE_VERSION_MAJOR (0)
124 The major version of GStreamer's gst-plugins-base libraries at compile time.
126 <p class="since">Since 0.10.31</p>
129 <div class="refsect2">
130 <a name="GST-PLUGINS-BASE-VERSION-MINOR:CAPS"></a><h3>GST_PLUGINS_BASE_VERSION_MINOR</h3>
131 <pre class="programlisting">#define GST_PLUGINS_BASE_VERSION_MINOR (10)
134 The minor version of GStreamer's gst-plugins-base libraries at compile time.
136 <p class="since">Since 0.10.31</p>
139 <div class="refsect2">
140 <a name="GST-PLUGINS-BASE-VERSION-MICRO:CAPS"></a><h3>GST_PLUGINS_BASE_VERSION_MICRO</h3>
141 <pre class="programlisting">#define GST_PLUGINS_BASE_VERSION_MICRO (34)
144 The micro version of GStreamer's gst-plugins-base libraries at compile time.
146 <p class="since">Since 0.10.31</p>
149 <div class="refsect2">
150 <a name="GST-PLUGINS-BASE-VERSION-NANO:CAPS"></a><h3>GST_PLUGINS_BASE_VERSION_NANO</h3>
151 <pre class="programlisting">#define GST_PLUGINS_BASE_VERSION_NANO (0)
154 The nano version of GStreamer's gst-plugins-base libraries at compile time.
155 Actual releases have 0, GIT versions have 1, prerelease versions have 2-...
157 <p class="since">Since 0.10.31</p>
160 <div class="refsect2">
161 <a name="GST-CHECK-PLUGINS-BASE-VERSION:CAPS"></a><h3>GST_CHECK_PLUGINS_BASE_VERSION()</h3>
162 <pre class="programlisting">#define GST_CHECK_PLUGINS_BASE_VERSION(major,minor,micro)</pre>
165 <div class="refsect2">
166 <a name="gst-plugins-base-version"></a><h3>gst_plugins_base_version ()</h3>
167 <pre class="programlisting"><span class="returnvalue">void</span> gst_plugins_base_version (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *major</code></em>,
168 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *minor</code></em>,
169 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *micro</code></em>,
170 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *nano</code></em>);</pre>
172 Gets the version number of the GStreamer Plugins Base libraries.
174 <div class="variablelist"><table border="0">
175 <col align="left" valign="top">
178 <td><p><span class="term"><em class="parameter"><code>major</code></em> :</span></p></td>
179 <td>pointer to a guint to store the major version number, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
183 <td><p><span class="term"><em class="parameter"><code>minor</code></em> :</span></p></td>
184 <td>pointer to a guint to store the minor version number, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
188 <td><p><span class="term"><em class="parameter"><code>micro</code></em> :</span></p></td>
189 <td>pointer to a guint to store the micro version number, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
193 <td><p><span class="term"><em class="parameter"><code>nano</code></em> :</span></p></td>
194 <td>pointer to a guint to store the nano version number, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
199 <p class="since">Since 0.10.31</p>
202 <div class="refsect2">
203 <a name="gst-plugins-base-version-string"></a><h3>gst_plugins_base_version_string ()</h3>
204 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gst_plugins_base_version_string (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
206 This function returns a string that is useful for describing this version
207 of GStreamer's gst-plugins-base libraries to the outside world: user agent
208 strings, logging, about dialogs ...
210 <div class="variablelist"><table border="0">
211 <col align="left" valign="top">
213 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
214 <td>a newly allocated string describing this version of gst-plugins-base</td>
217 <p class="since">Since 0.10.31</p>
223 Generated by GTK-Doc V1.17</div>