/usr/share/gtk-doc/html/ges-1.0/ges-Initialization.html is in libges-1.0-doc 1.14.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Initialization: GStreamer Editing Services 1.14.0 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GStreamer Editing Services 1.14.0 Reference Manual">
<link rel="up" href="ch01.html" title="GStreamer Editing Services Overview">
<link rel="prev" href="ges-architecture.html" title="Overview and architecture">
<link rel="next" href="ges-GES-Enums.html" title="GES Enumerations">
<meta name="generator" content="GTK-Doc V1.27 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#ges-Initialization.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ges-architecture.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ges-GES-Enums.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="ges-Initialization"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ges-Initialization.top_of_page"></a>Initialization</span></h2>
<p>Initialization</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="ges-Initialization.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="ges-Initialization.html#ges-init" title="ges_init ()">ges_init</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="ges-Initialization.html#ges-init-check" title="ges_init_check ()">ges_init_check</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ges-Initialization.html#ges-deinit" title="ges_deinit ()">ges_deinit</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ges-Initialization.html#ges-version" title="ges_version ()">ges_version</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ges-Initialization.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="ges-Initialization.html#GES-VERSION-MAJOR:CAPS" title="GES_VERSION_MAJOR">GES_VERSION_MAJOR</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="ges-Initialization.html#GES-VERSION-MICRO:CAPS" title="GES_VERSION_MICRO">GES_VERSION_MICRO</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="ges-Initialization.html#GES-VERSION-MINOR:CAPS" title="GES_VERSION_MINOR">GES_VERSION_MINOR</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="ges-Initialization.html#GES-VERSION-NANO:CAPS" title="GES_VERSION_NANO">GES_VERSION_NANO</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ges-Initialization.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <ges/ges.h>
</pre>
</div>
<div class="refsect1">
<a name="ges-Initialization.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="ges-Initialization.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="ges-init"></a><h3>ges_init ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
ges_init (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Initialize the GStreamer Editing Service. Call this before any usage of
GES. You should take care of initilizing GStreamer before calling this
function.</p>
</div>
<hr>
<div class="refsect2">
<a name="ges-init-check"></a><h3>ges_init_check ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
ges_init_check (<em class="parameter"><code><span class="type">int</span> *argc</code></em>,
<em class="parameter"><code><span class="type">char</span> **argv[]</code></em>,
<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);</pre>
<p>Initializes the GStreamer Editing Services library, setting up internal path lists,
and loading evrything needed.</p>
<p>This function will return <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if GES could not be initialized
for some reason.</p>
<div class="refsect3">
<a name="ges-init-check.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>argc</p></td>
<td class="parameter_description"><p>pointer to application's argc. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>argv</p></td>
<td class="parameter_description"><p>pointer to application's argv. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=argc][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>err</p></td>
<td class="parameter_description"><p>pointer to a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> to which a message will be posted on error</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ges-init-check.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if GES could be initialized.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ges-deinit"></a><h3>ges_deinit ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
ges_deinit (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Clean up any resources created by GES in <a class="link" href="ges-Initialization.html#ges-init" title="ges_init ()"><code class="function">ges_init()</code></a>.</p>
<p>It is normally not needed to call this function in a normal application as the
resources will automatically be freed when the program terminates.
This function is therefore mostly used by testsuites and other memory profiling tools.</p>
<p>After this call GES (including this method) should not be used anymore.</p>
</div>
<hr>
<div class="refsect2">
<a name="ges-version"></a><h3>ges_version ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
ges_version (<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *major</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *minor</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *micro</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *nano</code></em>);</pre>
<p>Gets the version number of the GStreamer Editing Services library.</p>
<div class="refsect3">
<a name="ges-version.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>major</p></td>
<td class="parameter_description"><p>pointer to a guint to store the major version number. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>minor</p></td>
<td class="parameter_description"><p>pointer to a guint to store the minor version number. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>micro</p></td>
<td class="parameter_description"><p>pointer to a guint to store the micro version number. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>nano</p></td>
<td class="parameter_description"><p>pointer to a guint to store the nano version number. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="ges-Initialization.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GES-VERSION-MAJOR:CAPS"></a><h3>GES_VERSION_MAJOR</h3>
<pre class="programlisting">#define GES_VERSION_MAJOR (1)
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GES-VERSION-MICRO:CAPS"></a><h3>GES_VERSION_MICRO</h3>
<pre class="programlisting">#define GES_VERSION_MICRO (0)
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GES-VERSION-MINOR:CAPS"></a><h3>GES_VERSION_MINOR</h3>
<pre class="programlisting">#define GES_VERSION_MINOR (14)
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GES-VERSION-NANO:CAPS"></a><h3>GES_VERSION_NANO</h3>
<pre class="programlisting">#define GES_VERSION_NANO (0)
</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|