blob: ce7ccd9b1dbfa53fa78eef98ecc64893c51b93db [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gstpbutils</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="GStreamer Base Plugins 1.0 Library Reference Manual">
<link rel="up" href="gstreamer-base-utils.html" title="Base Utils Library">
<link rel="prev" href="gstreamer-base-utils.html" title="Base Utils Library">
<link rel="next" href="gst-plugins-base-libs-gstpluginsbaseversion.html" title="gstpluginsbaseversion">
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="gstreamer-base-utils.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="gstreamer-base-utils.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GStreamer Base Plugins 1.0 Library Reference Manual</th>
<td><a accesskey="n" href="gst-plugins-base-libs-gstpluginsbaseversion.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#gst-plugins-base-libs-gstpbutils.synopsis" class="shortcut">Top</a>
 | 
<a href="#gst-plugins-base-libs-gstpbutils.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="gst-plugins-base-libs-gstpbutils"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gst-plugins-base-libs-gstpbutils.top_of_page"></a>gstpbutils</span></h2>
<p>gstpbutils — General Application and Plugin Utility Library</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="gst-plugins-base-libs-gstpbutils.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;gst/pbutils/pbutils.h&gt;
<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>);
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-base-libs-gstpbutils.description"></a><h2>Description</h2>
<p>
</p>
<div class="refsect2">
<a name="id-1.2.13.3.4.2.1"></a><h3>Linking to this library</h3>
<p>
libgstpbutils is a general utility library for plugins and applications.
It currently provides the
following:
</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>
human-readable description strings of codecs, elements, sources, decoders,
encoders, or sinks from decoder/encoder caps, element names, or protocol
names.
</p></li>
<li class="listitem"><p>
support for applications to initiate installation of missing plugins (if
this is supported by the distribution or operating system used)
</p></li>
<li class="listitem"><p>
API for GStreamer elements to create missing-plugin messages in order to
communicate to the application that a certain type of plugin is missing
(decoder, encoder, URI protocol source, URI protocol sink, named element)
</p></li>
<li class="listitem"><p>
API for applications to recognise and handle missing-plugin messages
</p></li>
</ul></div>
<p>
You should obtain the required CFLAGS and LIBS using pkg-config on the
gstreamer-plugins-base-0.10 module. You will then also need to add
'-lgstpbutils-0.10' manually to your LIBS line.
</p>
<p>
Before using any of its functions, applications and plugins must call
<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.
</p>
</div>
<p>
</p>
</div>
<div class="refsect1">
<a name="gst-plugins-base-libs-gstpbutils.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="gst-pb-utils-init"></a><h3>gst_pb_utils_init ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gst_pb_utils_init (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Initialises the base utils support library. This function is not
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>,
plugins should call it from their plugin_init function.
</p>
<p>
This function may be called multiple times. It will do nothing if the
library has already been initialised.
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>