/usr/share/gtk-doc/html/farstream-libs-0.2/FsElementAddedNotifier.html is in libfarstream-0.2-doc 0.2.8-4.1~build1.
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 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>FsElementAddedNotifier: Farstream Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Farstream Reference Manual">
<link rel="up" href="ch03.html" title="Farstream Utility Functions and Objects">
<link rel="prev" href="ch03.html" title="Farstream Utility Functions and Objects">
<link rel="next" href="farstream-libs-Utility-functions.html" title="Utility functions">
<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="#FsElementAddedNotifier.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#FsElementAddedNotifier.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#FsElementAddedNotifier.signals" class="shortcut">Signals</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="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch03.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="farstream-libs-Utility-functions.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="FsElementAddedNotifier"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="FsElementAddedNotifier.top_of_page"></a>FsElementAddedNotifier</span></h2>
<p>FsElementAddedNotifier — Recursive element addition notifier</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="FsElementAddedNotifier.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 class="link" href="FsElementAddedNotifier.html" title="FsElementAddedNotifier"><span class="returnvalue">FsElementAddedNotifier</span></a> *
</td>
<td class="function_name">
<a class="link" href="FsElementAddedNotifier.html#fs-element-added-notifier-new" title="fs_element_added_notifier_new ()">fs_element_added_notifier_new</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="FsElementAddedNotifier.html#fs-element-added-notifier-add" title="fs_element_added_notifier_add ()">fs_element_added_notifier_add</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="FsElementAddedNotifier.html#fs-element-added-notifier-remove" title="fs_element_added_notifier_remove ()">fs_element_added_notifier_remove</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gulong</span>
</td>
<td class="function_name">
<a class="link" href="FsElementAddedNotifier.html#fs-element-added-notifier-set-properties-from-keyfile" title="fs_element_added_notifier_set_properties_from_keyfile ()">fs_element_added_notifier_set_properties_from_keyfile</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="FsElementAddedNotifier.html#fs-element-added-notifier-set-properties-from-file" title="fs_element_added_notifier_set_properties_from_file ()">fs_element_added_notifier_set_properties_from_file</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gulong</span>
</td>
<td class="function_name">
<a class="link" href="FsElementAddedNotifier.html#fs-element-added-notifier-set-default-properties" title="fs_element_added_notifier_set_default_properties ()">fs_element_added_notifier_set_default_properties</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="FsElementAddedNotifier.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody><tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="FsElementAddedNotifier.html#FsElementAddedNotifier-element-added" title="The “element-added” signal">element-added</a></td>
<td class="signal_flags">Run Last</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="FsElementAddedNotifier.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="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="FsElementAddedNotifier.html#FsElementAddedNotifier-struct" title="struct FsElementAddedNotifier">FsElementAddedNotifier</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="FsElementAddedNotifier.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> FsElementAddedNotifier
</pre>
</div>
<div class="refsect1">
<a name="FsElementAddedNotifier.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <farstream/fs-element-added-notifier.h>
</pre>
</div>
<div class="refsect1">
<a name="FsElementAddedNotifier.description"></a><h2>Description</h2>
<p>This object can be attach to any <span class="type">GstBin</span> and will emit a the
<a class="link" href="FsElementAddedNotifier.html#FsElementAddedNotifier-element-added" title="The “element-added” signal"><span class="type">“element-added”</span></a> signal for every element inside the
<span class="type">GstBin</span> or any sub-bin and any element added in the future to the bin or
its sub-bins. There is also a utility method to have it used to
set the properties of elements based on a GKeyfile.</p>
</div>
<div class="refsect1">
<a name="FsElementAddedNotifier.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="fs-element-added-notifier-new"></a><h3>fs_element_added_notifier_new ()</h3>
<pre class="programlisting"><a class="link" href="FsElementAddedNotifier.html" title="FsElementAddedNotifier"><span class="returnvalue">FsElementAddedNotifier</span></a> *
fs_element_added_notifier_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <a class="link" href="FsElementAddedNotifier.html" title="FsElementAddedNotifier"><span class="type">FsElementAddedNotifier</span></a> object</p>
<div class="refsect3">
<a name="fs-element-added-notifier-new.returns"></a><h4>Returns</h4>
<p> the newly-created <a class="link" href="FsElementAddedNotifier.html" title="FsElementAddedNotifier"><span class="type">FsElementAddedNotifier</span></a></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="fs-element-added-notifier-add"></a><h3>fs_element_added_notifier_add ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
fs_element_added_notifier_add (<em class="parameter"><code><a class="link" href="FsElementAddedNotifier.html" title="FsElementAddedNotifier"><span class="type">FsElementAddedNotifier</span></a> *notifier</code></em>,
<em class="parameter"><code><span class="type">GstBin</span> *bin</code></em>);</pre>
<p>Add a <span class="type">GstBin</span> to on which the <a class="link" href="FsElementAddedNotifier.html#FsElementAddedNotifier-element-added" title="The “element-added” signal"><span class="type">“element-added”</span></a> signal
will be called on every element and sub-element present and added in the
future.</p>
<div class="refsect3">
<a name="fs-element-added-notifier-add.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>notifier</p></td>
<td class="parameter_description"><p>a <a class="link" href="FsElementAddedNotifier.html" title="FsElementAddedNotifier"><span class="type">FsElementAddedNotifier</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>bin</p></td>
<td class="parameter_description"><p>A <span class="type">GstBin</span> to watch to added elements</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="fs-element-added-notifier-remove"></a><h3>fs_element_added_notifier_remove ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
fs_element_added_notifier_remove (<em class="parameter"><code><a class="link" href="FsElementAddedNotifier.html" title="FsElementAddedNotifier"><span class="type">FsElementAddedNotifier</span></a> *notifier</code></em>,
<em class="parameter"><code><span class="type">GstBin</span> *bin</code></em>);</pre>
<p>Stop watching the passed bin and its subbins.</p>
<div class="refsect3">
<a name="fs-element-added-notifier-remove.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>notifier</p></td>
<td class="parameter_description"><p>a <a class="link" href="FsElementAddedNotifier.html" title="FsElementAddedNotifier"><span class="type">FsElementAddedNotifier</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>bin</p></td>
<td class="parameter_description"><p>A <span class="type">GstBin</span> to stop watching</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="fs-element-added-notifier-remove.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the <span class="type">GstBin</span> was being watched, <code class="literal">FALSE</code> otherwise</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="fs-element-added-notifier-set-properties-from-keyfile"></a><h3>fs_element_added_notifier_set_properties_from_keyfile ()</h3>
<pre class="programlisting"><span class="returnvalue">gulong</span>
fs_element_added_notifier_set_properties_from_keyfile
(<em class="parameter"><code><a class="link" href="FsElementAddedNotifier.html" title="FsElementAddedNotifier"><span class="type">FsElementAddedNotifier</span></a> *notifier</code></em>,
<em class="parameter"><code><span class="type">GKeyFile</span> *keyfile</code></em>);</pre>
<p>Using a <span class="type">GKeyFile</span> where the groups are the element's type or name
and the key=value are the property and its value, this function
will set the properties on the elements added to this object after
this function has been called. It will take ownership of the
GKeyFile structure. It will first try the group as the element type, if that
does not match, it will check its name.</p>
<div class="refsect3">
<a name="fs-element-added-notifier-set-properties-from-keyfile.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>notifier</p></td>
<td class="parameter_description"><p>a <a class="link" href="FsElementAddedNotifier.html" title="FsElementAddedNotifier"><span class="type">FsElementAddedNotifier</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>keyfile</p></td>
<td class="parameter_description"><p>a <span class="type">GKeyFile</span>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="fs-element-added-notifier-set-properties-from-keyfile.returns"></a><h4>Returns</h4>
<p> The id of the signal connection, this can be used to disconnect
this property setter using <code class="function">g_signal_handler_disconnect()</code>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="fs-element-added-notifier-set-properties-from-file"></a><h3>fs_element_added_notifier_set_properties_from_file ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
fs_element_added_notifier_set_properties_from_file
(<em class="parameter"><code><a class="link" href="FsElementAddedNotifier.html" title="FsElementAddedNotifier"><span class="type">FsElementAddedNotifier</span></a> *notifier</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Same as <a class="link" href="FsElementAddedNotifier.html#fs-element-added-notifier-set-properties-from-keyfile" title="fs_element_added_notifier_set_properties_from_keyfile ()"><code class="function">fs_element_added_notifier_set_properties_from_keyfile()</code></a> but using
the name of the file to load instead of the <span class="type">GKeyFile</span> directly.</p>
<div class="refsect3">
<a name="fs-element-added-notifier-set-properties-from-file.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>notifier</p></td>
<td class="parameter_description"><p>a <a class="link" href="FsElementAddedNotifier.html" title="FsElementAddedNotifier"><span class="type">FsElementAddedNotifier</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>The name of the keyfile to use</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>location of a <span class="type">GError</span>, or <code class="literal">NULL</code> if no error occured</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="fs-element-added-notifier-set-properties-from-file.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the file was successfully loaded, <code class="literal">FALSE</code> otherwise</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="fs-element-added-notifier-set-default-properties"></a><h3>fs_element_added_notifier_set_default_properties ()</h3>
<pre class="programlisting"><span class="returnvalue">gulong</span>
fs_element_added_notifier_set_default_properties
(<em class="parameter"><code><a class="link" href="FsElementAddedNotifier.html" title="FsElementAddedNotifier"><span class="type">FsElementAddedNotifier</span></a> *notifier</code></em>,
<em class="parameter"><code><span class="type">GstElement</span> *element</code></em>);</pre>
<p>Same as first calling <a class="link" href="farstream-libs-Utility-functions.html#fs-utils-get-default-element-properties" title="fs_utils_get_default_element_properties ()"><code class="function">fs_utils_get_default_element_properties()</code></a> and using
the result with
<a class="link" href="FsElementAddedNotifier.html#fs-element-added-notifier-set-properties-from-keyfile" title="fs_element_added_notifier_set_properties_from_keyfile ()"><code class="function">fs_element_added_notifier_set_properties_from_keyfile()</code></a> .</p>
<p>This is binding friendly (since GKeyFile doesn't have a boxed type).</p>
<div class="refsect3">
<a name="fs-element-added-notifier-set-default-properties.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>notifier</p></td>
<td class="parameter_description"><p>a <a class="link" href="FsElementAddedNotifier.html" title="FsElementAddedNotifier"><span class="type">FsElementAddedNotifier</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>element</p></td>
<td class="parameter_description"><p>Element for which to set the default codec
preferences</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="fs-element-added-notifier-set-default-properties.returns"></a><h4>Returns</h4>
<p> The id of the signal connection, this can be used to disconnect
this property setter using <code class="function">g_signal_handler_disconnect()</code>.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="FsElementAddedNotifier.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="FsElementAddedNotifier-struct"></a><h3>struct FsElementAddedNotifier</h3>
<pre class="programlisting">struct FsElementAddedNotifier;</pre>
<p>All members are private</p>
</div>
</div>
<div class="refsect1">
<a name="FsElementAddedNotifier.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="FsElementAddedNotifier-element-added"></a><h3>The <code class="literal">“element-added”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="FsElementAddedNotifier.html" title="FsElementAddedNotifier"><span class="type">FsElementAddedNotifier</span></a> *self,
<span class="type">GstBin</span> *bin,
<span class="type">GstElement</span> *element,
<span class="type">gpointer</span> user_data)</pre>
<p>This signal is emitted when an element is added to a <span class="type">GstBin</span> that was added
to this object or one of its sub-bins.
Be careful, there is no guarantee that this will be emitted on your
main thread, it will be emitted in the thread that added the element.
The bin may be <code class="literal">NULL</code> if this is the top-level bin.</p>
<div class="refsect3">
<a name="FsElementAddedNotifier-element-added.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>self</p></td>
<td class="parameter_description"><p><a class="link" href="FsElementAddedNotifier.html" title="FsElementAddedNotifier"><span class="type">FsElementAddedNotifier</span></a> that emitted the signal</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>bin</p></td>
<td class="parameter_description"><p>The <span class="type">GstBin</span> to which this object was added</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>element</p></td>
<td class="parameter_description"><p>The <span class="type">GstElement</span> that was added</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|