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

This file is indexed.

/usr/share/gtk-doc/html/farstream-libs-1.0/FsConference.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
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
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
<!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: FsConference</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="ch01.html" title="Farstream Core Library">
<link rel="prev" href="ch01.html" title="Farstream Core Library">
<link rel="next" href="FsParticipant.html" title="FsParticipant">
<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="#FsConference.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
                  <a href="#FsConference.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> 
                  <a href="#FsConference.implemented-interfaces" class="shortcut">Implemented Interfaces</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="ch01.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="FsParticipant.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="FsConference"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="FsConference.top_of_page"></a>FsConference</span></h2>
<p>FsConference — Interface for farstream conference elements</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="FsConference.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">
<a class="link" href="FsSession.html" title="FsSession"><span class="returnvalue">FsSession</span></a> *
</td>
<td class="function_name">
<a class="link" href="FsConference.html#fs-conference-new-session" title="fs_conference_new_session ()">fs_conference_new_session</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="FsParticipant.html" title="FsParticipant"><span class="returnvalue">FsParticipant</span></a> *
</td>
<td class="function_name">
<a class="link" href="FsConference.html#fs-conference-new-participant" title="fs_conference_new_participant ()">fs_conference_new_participant</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="FsConference.html#FS-ERROR:CAPS" title="FS_ERROR">FS_ERROR</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="FsConference.html#FS-ERROR-IS-FATAL:CAPS" title="FS_ERROR_IS_FATAL()">FS_ERROR_IS_FATAL</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="FsConference.html#fs-parse-error" title="fs_parse_error ()">fs_parse_error</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="FsConference.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="FsConference.html#FsConference-struct" title="struct FsConference">FsConference</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="FsConference.html#FsError" title="enum FsError">FsError</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="FsConference.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> GInitiallyUnowned
        <span class="lineart">╰──</span> GstObject
            <span class="lineart">╰──</span> GstElement
                <span class="lineart">╰──</span> GstBin
                    <span class="lineart">╰──</span> FsConference
</pre>
</div>
<div class="refsect1">
<a name="FsConference.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
FsConference implements
 GstChildProxy.</p>
</div>
<div class="refsect1">
<a name="FsConference.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;farstream/fs-conference.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="FsConference.description"></a><h2>Description</h2>
<p>A Farstream conference is a conversation space that takes place between 2 or
more participants. Each conference must have one or more Farstream sessions
that are associated to the conference participants.</p>
<p>This will communicate asynchronous events to the user through <span class="type">GstMessage</span>
of type <span class="type">GST_MESSAGE_ELEMENT</span> sent over the <span class="type">GstBus</span>.</p>
<div class="refsect2">
<a name="id-1.2.2.2.8.4"></a><h3>The "<code class="literal">farstream-error</code>" message</h3>
<div class="informalexample"><pre class="programlisting">
"src-object"       #GObject           The object (#FsConference, #FsSession or #FsStream) that emitted the error
"error-no"         #FsError           The Error number
"error-msg"        #gchar*            The error message
</pre></div>
<p>
The message is sent on asynchronous errors.
</p>
</div>
</div>
<div class="refsect1">
<a name="FsConference.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="fs-conference-new-session"></a><h3>fs_conference_new_session ()</h3>
<pre class="programlisting"><a class="link" href="FsSession.html" title="FsSession"><span class="returnvalue">FsSession</span></a> *
fs_conference_new_session (<em class="parameter"><code><a class="link" href="FsConference.html" title="FsConference"><span class="type">FsConference</span></a> *conference</code></em>,
                           <em class="parameter"><code><a class="link" href="farstream-libs-FsCodec.html#FsMediaType" title="enum FsMediaType"><span class="type">FsMediaType</span></a> media_type</code></em>,
                           <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Create a new Farstream session for the given conference.</p>
<div class="refsect3">
<a name="id-1.2.2.2.9.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>conference</p></td>
<td class="parameter_description"><p><a class="link" href="FsConference.html" title="FsConference"><span class="type">FsConference</span></a> interface of a <span class="type">GstElement</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>media_type</p></td>
<td class="parameter_description"><p><a class="link" href="farstream-libs-FsCodec.html#FsMediaType" title="enum FsMediaType"><span class="type">FsMediaType</span></a> of the new session</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="id-1.2.2.2.9.2.6"></a><h4>Returns</h4>
<p> the new <a class="link" href="FsSession.html" title="FsSession"><span class="type">FsSession</span></a> that has been created.
The <a class="link" href="FsSession.html" title="FsSession"><span class="type">FsSession</span></a> must be unref'd by the user when closing the session. </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-conference-new-participant"></a><h3>fs_conference_new_participant ()</h3>
<pre class="programlisting"><a class="link" href="FsParticipant.html" title="FsParticipant"><span class="returnvalue">FsParticipant</span></a> *
fs_conference_new_participant (<em class="parameter"><code><a class="link" href="FsConference.html" title="FsConference"><span class="type">FsConference</span></a> *conference</code></em>,
                               <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Create a new Farstream Participant for the type of the given conference.</p>
<div class="refsect3">
<a name="id-1.2.2.2.9.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>conference</p></td>
<td class="parameter_description"><p><a class="link" href="FsConference.html" title="FsConference"><span class="type">FsConference</span></a> interface of a <span class="type">GstElement</span></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="id-1.2.2.2.9.3.6"></a><h4>Returns</h4>
<p> the new <a class="link" href="FsParticipant.html" title="FsParticipant"><span class="type">FsParticipant</span></a> that has been created.
The <a class="link" href="FsParticipant.html" title="FsParticipant"><span class="type">FsParticipant</span></a> is owned by the user and he must unref it when he is
done with it. </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-ERROR:CAPS"></a><h3>FS_ERROR</h3>
<pre class="programlisting">#define FS_ERROR (fs_error_quark ())
</pre>
<p>This quark is used to denote errors coming from Farstream objects</p>
</div>
<hr>
<div class="refsect2">
<a name="FS-ERROR-IS-FATAL:CAPS"></a><h3>FS_ERROR_IS_FATAL()</h3>
<pre class="programlisting">#define             FS_ERROR_IS_FATAL(error)</pre>
<p>Tells the programmer if an error if fatal or not, if it returns <code class="literal">TRUE</code>,
the error is fatal, and the object that created it should
be discarded. It returns <code class="literal">FALSE</code> otherwise.</p>
<div class="refsect3">
<a name="id-1.2.2.2.9.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>error</p></td>
<td class="parameter_description"><p>a <a class="link" href="FsConference.html#FsError" title="enum FsError"><span class="type">FsError</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="fs-parse-error"></a><h3>fs_parse_error ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
fs_parse_error (<em class="parameter"><code><span class="type">GObject</span> *object</code></em>,
                <em class="parameter"><code><span class="type">GstMessage</span> *message</code></em>,
                <em class="parameter"><code><a class="link" href="FsConference.html#FsError" title="enum FsError"><span class="type">FsError</span></a> *error</code></em>,
                <em class="parameter"><code>const <span class="type">gchar</span> **error_msg</code></em>);</pre>
<p>Parses a "farstream-farstream" message and checks if it matches
the <em class="parameter"><code>object</code></em>
 parameters.</p>
<div class="refsect3">
<a name="id-1.2.2.2.9.6.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>object</p></td>
<td class="parameter_description"><p>a <span class="type">GObject</span> to match against the message</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>message</p></td>
<td class="parameter_description"><p>a <span class="type">GstMessage</span> to parse</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p> Returns the <a class="link" href="FsConference.html#FsError" title="enum FsError"><span class="type">FsError</span></a> error number in
the message if not <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error_msg</p></td>
<td class="parameter_description"><p>Returns the error message if not <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>][<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.2.9.6.6"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the message matches the object and is valid.</p>
<p></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="FsConference.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="FsConference-struct"></a><h3>struct FsConference</h3>
<pre class="programlisting">struct FsConference;</pre>
<p>The <a class="link" href="FsConference.html" title="FsConference"><span class="type">FsConference</span></a> structure, all the members are private</p>
</div>
<hr>
<div class="refsect2">
<a name="FsError"></a><h3>enum FsError</h3>
<p>This is the enum of error numbers that will come either on the "error"
signal, from the Gst Bus or for error in the FS_ERROR domain in GErrors</p>
<div class="refsect3">
<a name="id-1.2.2.2.10.3.4"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="FS-ERROR-CONSTRUCTION:CAPS"></a>FS_ERROR_CONSTRUCTION</p></td>
<td class="enum_member_description">
<p>Error constructing some of the sub-elements, this
probably denotes an error in the installation of the gstreamer elements.
It is a fatal error.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="FS-ERROR-INTERNAL:CAPS"></a>FS_ERROR_INTERNAL</p></td>
<td class="enum_member_description">
<p>An internal error happened in Farstream, it may be in
an inconsistent state. The object from which this error comes should be
discarded.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="FS-ERROR-INVALID-ARGUMENTS:CAPS"></a>FS_ERROR_INVALID_ARGUMENTS</p></td>
<td class="enum_member_description">
<p>Invalid arguments to the function, this
is a programming error and should not be reported to the user</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="FS-ERROR-NETWORK:CAPS"></a>FS_ERROR_NETWORK</p></td>
<td class="enum_member_description">
<p>A network related error, this should probably be
 reported to the user.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="FS-ERROR-NOT-IMPLEMENTED:CAPS"></a>FS_ERROR_NOT_IMPLEMENTED</p></td>
<td class="enum_member_description">
<p>The optional functionality is not implemented by
this plugin.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="FS-ERROR-NEGOTIATION-FAILED:CAPS"></a>FS_ERROR_NEGOTIATION_FAILED</p></td>
<td class="enum_member_description">
<p>The codec negotiation has failed, this means
that there are no common codecs between the local and remote codecs.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="FS-ERROR-UNKNOWN-CODEC:CAPS"></a>FS_ERROR_UNKNOWN_CODEC</p></td>
<td class="enum_member_description">
<p>Data is received on an unknown codec, this most
likely denotes an error on the remote side, the buffers will be ignored.
It can safely be ignored in most cases (but may result in a call with no
media received).</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="FS-ERROR-NO-CODECS:CAPS"></a>FS_ERROR_NO_CODECS</p></td>
<td class="enum_member_description">
<p>There are no codecs detected for that media type.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="FS-ERROR-NO-CODECS-LEFT:CAPS"></a>FS_ERROR_NO_CODECS_LEFT</p></td>
<td class="enum_member_description">
<p>All of the codecs have been disabled by the
codec preferences, one should try less strict codec preferences.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="FS-ERROR-CONNECTION-FAILED:CAPS"></a>FS_ERROR_CONNECTION_FAILED</p></td>
<td class="enum_member_description">
<p>Could not connect to the to remote party.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="FS-ERROR-DISPOSED:CAPS"></a>FS_ERROR_DISPOSED</p></td>
<td class="enum_member_description">
<p>The object has been disposed.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="FS-ERROR-ALREADY-EXISTS:CAPS"></a>FS_ERROR_ALREADY_EXISTS</p></td>
<td class="enum_member_description">
<p>The object already exists</p>
</td>
<td class="enum_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.