1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2<html> 3<head> 4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 5<title>Pbutils: GStreamer Base Plugins 1.0 Library Reference Manual</title> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="index.html" title="GStreamer Base Plugins 1.0 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-Version.html" title="Version"> 11<meta name="generator" content="GTK-Doc V1.28 (XML mode)"> 12<link rel="stylesheet" href="style.css" type="text/css"> 13</head> 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="5"><tr valign="middle"> 16<td width="100%" align="left" class="shortcuts"> 17<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 18 <a href="#gst-plugins-base-libs-Pbutils.description" class="shortcut">Description</a></span> 19</td> 20<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> 21<td><a accesskey="u" href="gstreamer-base-utils.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> 22<td><a accesskey="p" href="gstreamer-base-utils.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 23<td><a accesskey="n" href="gst-plugins-base-libs-Version.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> 24</tr></table> 25<div class="refentry"> 26<a name="gst-plugins-base-libs-Pbutils"></a><div class="titlepage"></div> 27<div class="refnamediv"><table width="100%"><tr> 28<td valign="top"> 29<h2><span class="refentrytitle"><a name="gst-plugins-base-libs-Pbutils.top_of_page"></a>Pbutils</span></h2> 30<p>Pbutils — General Application and Plugin Utility Library</p> 31</td> 32<td class="gallery_image" valign="top" align="right"></td> 33</tr></table></div> 34<div class="refsect1"> 35<a name="gst-plugins-base-libs-Pbutils.functions"></a><h2>Functions</h2> 36<div class="informaltable"><table class="informaltable" width="100%" border="0"> 37<colgroup> 38<col width="150px" class="functions_return"> 39<col class="functions_name"> 40</colgroup> 41<tbody><tr> 42<td class="function_type"> 43<span class="returnvalue">void</span> 44</td> 45<td class="function_name"> 46<a class="link" href="gst-plugins-base-libs-Pbutils.html#gst-pb-utils-init" title="gst_pb_utils_init ()">gst_pb_utils_init</a> <span class="c_punctuation">()</span> 47</td> 48</tr></tbody> 49</table></div> 50</div> 51<div class="refsect1"> 52<a name="gst-plugins-base-libs-Pbutils.includes"></a><h2>Includes</h2> 53<pre class="synopsis">#include <gst/pbutils/pbutils.h> 54</pre> 55</div> 56<div class="refsect1"> 57<a name="gst-plugins-base-libs-Pbutils.description"></a><h2>Description</h2> 58<p>libgstpbutils is a general utility library for plugins and applications. 59It currently provides the 60following:</p> 61<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 62<li class="listitem"><p>human-readable description strings of codecs, elements, sources, decoders, 63encoders, or sinks from decoder/encoder caps, element names, or protocol 64names.</p></li> 65<li class="listitem"><p>support for applications to initiate installation of missing plugins (if 66this is supported by the distribution or operating system used)</p></li> 67<li class="listitem"><p>API for GStreamer elements to create missing-plugin messages in order to 68communicate to the application that a certain type of plugin is missing 69(decoder, encoder, URI protocol source, URI protocol sink, named element)</p></li> 70<li class="listitem"><p>API for applications to recognise and handle missing-plugin messages</p></li> 71</ul></div> 72<div class="refsect3"> 73<a name="id-1.2.14.3.5.4"></a><h4>Linking to this library</h4> 74<p>You should obtain the required CFLAGS and LIBS using pkg-config on the 75gstreamer-plugins-base-1.0 module. You will then also need to add 76'-lgstreamer-pbutils-1.0' manually to your LIBS line.</p> 77</div> 78<div class="refsect3"> 79<a name="id-1.2.14.3.5.5"></a><h4>Library initialisation</h4> 80<p>Before using any of its functions, applications and plugins must call 81<a class="link" href="gst-plugins-base-libs-Pbutils.html#gst-pb-utils-init" title="gst_pb_utils_init ()"><code class="function">gst_pb_utils_init()</code></a> to initialise the library.</p> 82</div> 83</div> 84<div class="refsect1"> 85<a name="gst-plugins-base-libs-Pbutils.functions_details"></a><h2>Functions</h2> 86<div class="refsect2"> 87<a name="gst-pb-utils-init"></a><h3>gst_pb_utils_init ()</h3> 88<pre class="programlisting"><span class="returnvalue">void</span> 89gst_pb_utils_init (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> 90<p>Initialises the base utils support library. This function is not 91thread-safe. Applications should call it after calling <a href="/usr/share/gtk-doc/html/gstreamer-1.0/gstreamer-Gst.html#gst-init"><code class="function">gst_init()</code></a>, 92plugins should call it from their plugin_init function.</p> 93<p>This function may be called multiple times. It will do nothing if the 94library has already been initialised.</p> 95</div> 96</div> 97<div class="refsect1"> 98<a name="gst-plugins-base-libs-Pbutils.other_details"></a><h2>Types and Values</h2> 99</div> 100</div> 101<div class="footer"> 102<hr>Generated by GTK-Doc V1.28</div> 103</body> 104</html>
