libfarstream-0.2-doc 0.2.3-1ubuntu2 / usr / share / gtk-doc / html / farstream-libs-1.0 / farstream-libs-FsPlugin.html

This file is indexed.

/usr/share/gtk-doc/html/farstream-libs-1.0/farstream-libs-FsPlugin.html is in libfarstream-0.2-doc 0.2.3-1ubuntu2.

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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Farstream Reference Manual: FsPlugin</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Farstream Reference Manual">
<link rel="up" href="ch05.html" title="Farstream Plugins Infrastructure">
<link rel="prev" href="ch05.html" title="Farstream Plugins Infrastructure">
<meta name="generator" content="GTK-Doc V1.20 (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="10"><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="#farstream-libs-FsPlugin.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
                  <a href="#farstream-libs-FsPlugin.object-hierarchy" class="shortcut">Object Hierarchy</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="ch05.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch05.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><img src="right-insensitive.png" width="16" height="16" border="0"></td>
</tr></table>
<div class="refentry">
<a name="farstream-libs-FsPlugin"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="farstream-libs-FsPlugin.top_of_page"></a>FsPlugin</span></h2>
<p>FsPlugin — A class for defining Farstream plugins</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="farstream-libs-FsPlugin.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">GObject</span> *
</td>
<td class="function_name">
<a class="link" href="farstream-libs-FsPlugin.html#fs-plugin-create-valist" title="fs_plugin_create_valist ()">fs_plugin_create_valist</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GObject</span> *
</td>
<td class="function_name">
<a class="link" href="farstream-libs-FsPlugin.html#fs-plugin-create" title="fs_plugin_create ()">fs_plugin_create</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="farstream-libs-FsPlugin.html#FS-INIT-PLUGIN:CAPS" title="FS_INIT_PLUGIN()">FS_INIT_PLUGIN</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> **
</td>
<td class="function_name">
<a class="link" href="farstream-libs-FsPlugin.html#fs-plugin-list-available" title="fs_plugin_list_available ()">fs_plugin_list_available</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="farstream-libs-FsPlugin.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table 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="farstream-libs-FsPlugin.html#FsPlugin" title="struct FsPlugin">FsPlugin</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="farstream-libs-FsPlugin.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">
</pre>
</div>
<div class="refsect1">
<a name="farstream-libs-FsPlugin.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;farstream/fs-plugin.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="farstream-libs-FsPlugin.description"></a><h2>Description</h2>
<p>This class is a generic class to load GType plugins based on their name.
With this simple class, you can only have one type per plugin.</p>
</div>
<div class="refsect1">
<a name="farstream-libs-FsPlugin.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="fs-plugin-create-valist"></a><h3>fs_plugin_create_valist ()</h3>
<pre class="programlisting"><span class="returnvalue">GObject</span> *
fs_plugin_create_valist (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                         <em class="parameter"><code>const <span class="type">gchar</span> *type_suffix</code></em>,
                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>,
                         <em class="parameter"><code>const <span class="type">gchar</span> *first_property_name</code></em>,
                         <em class="parameter"><code><span class="type">va_list</span> var_args</code></em>);</pre>
<p>Loads the appropriate plugin if necessary and creates a GObject of
the requested type</p>
<div class="refsect3">
<a name="id-1.3.3.2.8.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>name</p></td>
<td class="parameter_description"><p>The name of the plugin to load</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>type_suffix</p></td>
<td class="parameter_description"><p>The type of plugin to load (normally "transmitter")</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 NULL if no error occured</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>first_property_name</p></td>
<td class="parameter_description"><p>The name of the first property to be set on the
object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>var_args</p></td>
<td class="parameter_description"><p>The rest of the arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.3.2.8.2.6"></a><h4>Returns</h4>
<p> The object created (or NULL if there is an error). </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="fs-plugin-create"></a><h3>fs_plugin_create ()</h3>
<pre class="programlisting"><span class="returnvalue">GObject</span> *
fs_plugin_create (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                  <em class="parameter"><code>const <span class="type">gchar</span> *type_suffix</code></em>,
                  <em class="parameter"><code><span class="type">GError</span> **error</code></em>,
                  <em class="parameter"><code>const <span class="type">gchar</span> *first_property_name</code></em>,
                  <em class="parameter"><code>...</code></em>);</pre>
<p>Loads the appropriate plugin if necessary and creates a GObject of
the requested type</p>
<div class="refsect3">
<a name="id-1.3.3.2.8.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>name</p></td>
<td class="parameter_description"><p>The name of the plugin to load</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>type_suffix</p></td>
<td class="parameter_description"><p>The type of plugin to load (normally "transmitter")</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 NULL if no error occured</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>first_property_name</p></td>
<td class="parameter_description"><p>The name of the first property to be set on the
object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p>The NULL-terminated list of properties to set on the transmitter</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.3.2.8.3.6"></a><h4>Returns</h4>
<p> The object created (or NULL if there is an error). </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="FS-INIT-PLUGIN:CAPS"></a><h3>FS_INIT_PLUGIN()</h3>
<pre class="programlisting">#define             FS_INIT_PLUGIN(type_register_func)</pre>
<p>This macro is used to declare Farstream plugins and must be used once
in any farstream plugin.</p>
<div class="refsect3">
<a name="id-1.3.3.2.8.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>type_register_func</p></td>
<td class="parameter_description"><p>A function that register a <span class="type">GType</span> and returns it</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="fs-plugin-list-available"></a><h3>fs_plugin_list_available ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> **
fs_plugin_list_available (<em class="parameter"><code>const <span class="type">gchar</span> *type_suffix</code></em>);</pre>
<p>Gets the list of all available plugins of a certain type</p>
<div class="refsect3">
<a name="id-1.3.3.2.8.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>type_suffix</p></td>
<td class="parameter_description"><p>Get list of plugins with this type suffix</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.3.2.8.5.6"></a><h4>Returns</h4>
<p> a newly allocated NULL terminated array of
strings or <code class="literal">NULL</code> if no strings were found.
It should be freed with <code class="function">g_strfreev()</code>. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="farstream-libs-FsPlugin.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="FsPlugin"></a><h3>struct FsPlugin</h3>
<pre class="programlisting">struct FsPlugin {
  GTypeModule parent;
};
</pre>
<p>This structure represents a plugin, it is opaque.</p>
<div class="refsect3">
<a name="id-1.3.3.2.9.2.5"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody><tr>
<td class="struct_member_name"><p><span class="type">GTypeModule</span> <em class="structfield"><code><a name="FsPlugin.parent"></a>parent</code></em>;</p></td>
<td class="struct_member_description"><p>the parent object</p></td>
<td class="struct_member_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.20</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.