← Back to branch summary

~ubuntu-branches/ubuntu/karmic/farsight2/karmic

« back to all changes in this revision

Viewing changes to docs/libs/html/farsight2-libs-FsCodec.html

  • Committer: Bazaar Package Importer
  • Author(s): Sjoerd Simons
  • Date: 2009-05-29 12:20:24 UTC
  • mfrom: (1.1.4 upstream) (2.1.1 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090529122024-w0uzozcjda8zsul7
Tags: 0.0.12-1
New Upstream Version

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/libs/html/farsight2-libs-FsCodec.html
8
8
<link rel="up" href="ch02.html" title="Farsight Core Library">
9
9
<link rel="prev" href="farsight2-libs-FsCandidate.html" title="FsCandidate">
10
10
<link rel="next" href="ch03.html" title="Farsight Utility Functions and Objects">
11
 
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="part" href="pt01.html" title="Part I. User-oriented classes, interfaces and functions">
14
14
<link rel="chapter" href="ch01.html" title="Farsight GStreamer Interfaces">
28
28
<th width="100%" align="center">Farsight2 Reference Manual</th>
29
29
<td><a accesskey="n" href="ch03.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
30
30
</tr>
31
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#farsight2-libs-FsCodec.synopsis" class="shortcut">Top</a>
32
 
                   | 
33
 
                  <a href="#farsight2-libs-FsCodec.description" class="shortcut">Description</a></nobr></td></tr>
 
31
<tr><td colspan="5" class="shortcuts">
 
32
<a href="#farsight2-libs-FsCodec.synopsis" class="shortcut">Top</a>
 
33
                 | 
 
34
                <a href="#farsight2-libs-FsCodec.description" class="shortcut">Description</a>
 
35
</td></tr>
34
36
</table>
35
37
<div class="refentry" lang="en">
36
38
<a name="farsight2-libs-FsCodec"></a><div class="titlepage"></div>
50
52
                    <a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec">FsCodec</a>;
51
53
enum                <a class="link" href="farsight2-libs-FsCodec.html#FsMediaType" title="enum FsMediaType">FsMediaType</a>;
52
54
                    <a class="link" href="farsight2-libs-FsCodec.html#FsCodecParameter" title="FsCodecParameter">FsCodecParameter</a>;
53
 
#define             <a class="link" href="farsight2-libs-FsCodec.html#FS-CODEC-ID-ANY:CAPS" title="FS_CODEC_ID_ANY">FS_CODEC_ID_ANY</a>
54
 
#define             <a class="link" href="farsight2-libs-FsCodec.html#FS-CODEC-ID-DISABLE:CAPS" title="FS_CODEC_ID_DISABLE">FS_CODEC_ID_DISABLE</a>
55
 
<a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec">FsCodec</a>*            <a class="link" href="farsight2-libs-FsCodec.html#fs-codec-new" title="fs_codec_new ()">fs_codec_new</a>                        (int id,
 
55
#define             <a class="link" href="farsight2-libs-FsCodec.html#FS-CODEC-ID-ANY--CAPS" title="FS_CODEC_ID_ANY">FS_CODEC_ID_ANY</a>
 
56
#define             <a class="link" href="farsight2-libs-FsCodec.html#FS-CODEC-ID-DISABLE--CAPS" title="FS_CODEC_ID_DISABLE">FS_CODEC_ID_DISABLE</a>
 
57
<a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec">FsCodec</a> *           <a class="link" href="farsight2-libs-FsCodec.html#fs-codec-new" title="fs_codec_new ()">fs_codec_new</a>                        (int id,
56
58
                                                         const char *encoding_name,
57
59
                                                         <a class="link" href="farsight2-libs-FsCodec.html#FsMediaType" title="enum FsMediaType">FsMediaType</a> media_type,
58
60
                                                         <a
59
61
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
60
62
>guint</a> clock_rate);
61
 
void                <a class="link" href="farsight2-libs-FsCodec.html#fs-codec-destroy" title="fs_codec_destroy ()">fs_codec_destroy</a>                    (<a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec">FsCodec</a> *codec);
62
 
<a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec">FsCodec</a>*            <a class="link" href="farsight2-libs-FsCodec.html#fs-codec-copy" title="fs_codec_copy ()">fs_codec_copy</a>                       (const <a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec">FsCodec</a> *codec);
 
63
<a
 
64
href="/usr/share/gtk-doc/html/gnutls/gnutls-gnutls.html#void"
 
65
>void</a>                <a class="link" href="farsight2-libs-FsCodec.html#fs-codec-destroy" title="fs_codec_destroy ()">fs_codec_destroy</a>                    (<a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec">FsCodec</a> *codec);
 
66
<a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec">FsCodec</a> *           <a class="link" href="farsight2-libs-FsCodec.html#fs-codec-copy" title="fs_codec_copy ()">fs_codec_copy</a>                       (const <a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec">FsCodec</a> *codec);
63
67
<a
64
68
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
65
69
>gboolean</a>            <a class="link" href="farsight2-libs-FsCodec.html#fs-codec-are-equal" title="fs_codec_are_equal ()">fs_codec_are_equal</a>                  (const <a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec">FsCodec</a> *codec1,
66
70
                                                         const <a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec">FsCodec</a> *codec2);
67
71
<a
68
72
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
69
 
>GList</a>*              <a class="link" href="farsight2-libs-FsCodec.html#fs-codec-list-from-keyfile" title="fs_codec_list_from_keyfile ()">fs_codec_list_from_keyfile</a>          (const <a
 
73
>GList</a> *             <a class="link" href="farsight2-libs-FsCodec.html#fs-codec-list-from-keyfile" title="fs_codec_list_from_keyfile ()">fs_codec_list_from_keyfile</a>          (const <a
70
74
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
71
75
>gchar</a> *filename,
72
76
                                                         <a
73
77
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
74
78
>GError</a> **error);
75
 
void                <a class="link" href="farsight2-libs-FsCodec.html#fs-codec-list-destroy" title="fs_codec_list_destroy ()">fs_codec_list_destroy</a>               (<a
 
79
<a
 
80
href="/usr/share/gtk-doc/html/gnutls/gnutls-gnutls.html#void"
 
81
>void</a>                <a class="link" href="farsight2-libs-FsCodec.html#fs-codec-list-destroy" title="fs_codec_list_destroy ()">fs_codec_list_destroy</a>               (<a
76
82
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
77
83
>GList</a> *codec_list);
78
84
<a
79
85
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
80
 
>GList</a>*              <a class="link" href="farsight2-libs-FsCodec.html#fs-codec-list-copy" title="fs_codec_list_copy ()">fs_codec_list_copy</a>                  (const <a
 
86
>GList</a> *             <a class="link" href="farsight2-libs-FsCodec.html#fs-codec-list-copy" title="fs_codec_list_copy ()">fs_codec_list_copy</a>                  (const <a
81
87
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
82
88
>GList</a> *codec_list);
83
89
<a
90
96
>GList</a> *list2);
91
97
<a
92
98
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
93
 
>gchar</a>*              <a class="link" href="farsight2-libs-FsCodec.html#fs-codec-to-string" title="fs_codec_to_string ()">fs_codec_to_string</a>                  (const <a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec">FsCodec</a> *codec);
94
 
void                <a class="link" href="farsight2-libs-FsCodec.html#fs-codec-add-optional-parameter" title="fs_codec_add_optional_parameter ()">fs_codec_add_optional_parameter</a>     (<a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec">FsCodec</a> *codec,
 
99
>gchar</a> *             <a class="link" href="farsight2-libs-FsCodec.html#fs-codec-to-string" title="fs_codec_to_string ()">fs_codec_to_string</a>                  (const <a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec">FsCodec</a> *codec);
 
100
<a
 
101
href="/usr/share/gtk-doc/html/gnutls/gnutls-gnutls.html#void"
 
102
>void</a>                <a class="link" href="farsight2-libs-FsCodec.html#fs-codec-add-optional-parameter" title="fs_codec_add_optional_parameter ()">fs_codec_add_optional_parameter</a>     (<a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec">FsCodec</a> *codec,
95
103
                                                         const <a
96
104
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
97
105
>gchar</a> *name,
98
106
                                                         const <a
99
107
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
100
108
>gchar</a> *value);
101
 
void                <a class="link" href="farsight2-libs-FsCodec.html#fs-codec-remove-optional-parameter" title="fs_codec_remove_optional_parameter ()">fs_codec_remove_optional_parameter</a>  (<a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec">FsCodec</a> *codec,
 
109
<a
 
110
href="/usr/share/gtk-doc/html/gnutls/gnutls-gnutls.html#void"
 
111
>void</a>                <a class="link" href="farsight2-libs-FsCodec.html#fs-codec-remove-optional-parameter" title="fs_codec_remove_optional_parameter ()">fs_codec_remove_optional_parameter</a>  (<a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec">FsCodec</a> *codec,
102
112
                                                         <a class="link" href="farsight2-libs-FsCodec.html#FsCodecParameter" title="FsCodecParameter">FsCodecParameter</a> *param);
103
 
<a class="link" href="farsight2-libs-FsCodec.html#FsCodecParameter" title="FsCodecParameter">FsCodecParameter</a>*   <a class="link" href="farsight2-libs-FsCodec.html#fs-codec-get-optional-parameter" title="fs_codec_get_optional_parameter ()">fs_codec_get_optional_parameter</a>     (<a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec">FsCodec</a> *codec,
 
113
<a class="link" href="farsight2-libs-FsCodec.html#FsCodecParameter" title="FsCodecParameter">FsCodecParameter</a> *  <a class="link" href="farsight2-libs-FsCodec.html#fs-codec-get-optional-parameter" title="fs_codec_get_optional_parameter ()">fs_codec_get_optional_parameter</a>     (<a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec">FsCodec</a> *codec,
104
114
                                                         const <a
105
115
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
106
116
>gchar</a> *name,
107
117
                                                         const <a
108
118
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
109
119
>gchar</a> *value);
110
 
#define             <a class="link" href="farsight2-libs-FsCodec.html#FS-CODEC-FORMAT:CAPS" title="FS_CODEC_FORMAT">FS_CODEC_FORMAT</a>
111
 
#define             <a class="link" href="farsight2-libs-FsCodec.html#FS-CODEC-ARGS:CAPS" title="FS_CODEC_ARGS()">FS_CODEC_ARGS</a>                       (codec)
 
120
#define             <a class="link" href="farsight2-libs-FsCodec.html#FS-CODEC-FORMAT--CAPS" title="FS_CODEC_FORMAT">FS_CODEC_FORMAT</a>
 
121
#define             <a class="link" href="farsight2-libs-FsCodec.html#FS-CODEC-ARGS--CAPS" title="FS_CODEC_ARGS()">FS_CODEC_ARGS</a>                       (codec)
112
122
const <a
113
123
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
114
 
>gchar</a>*        <a class="link" href="farsight2-libs-FsCodec.html#fs-media-type-to-string" title="fs_media_type_to_string ()">fs_media_type_to_string</a>             (<a class="link" href="farsight2-libs-FsCodec.html#FsMediaType" title="enum FsMediaType">FsMediaType</a> media_type);
 
124
>gchar</a> *       <a class="link" href="farsight2-libs-FsCodec.html#fs-media-type-to-string" title="fs_media_type_to_string ()">fs_media_type_to_string</a>             (<a class="link" href="farsight2-libs-FsCodec.html#FsMediaType" title="enum FsMediaType">FsMediaType</a> media_type);
115
125
</pre>
116
126
</div>
117
127
<div class="refsect1" lang="en">
121
131
Farsight. The information specified in this structure is usually
122
132
representative of the codec information exchanged in the signaling.</p>
123
133
<p>
124
 
 
125
134
</p>
126
135
</div>
127
136
<div class="refsect1" lang="en">
140
149
<p>
141
150
This structure reprensents one codec that can be offered or received</p>
142
151
<p>
143
 
 
144
152
</p>
145
153
<div class="variablelist"><table border="0">
146
154
<col align="left" valign="top">
199
207
<p>
200
208
Enum used to signify the media type of a codec or stream.</p>
201
209
<p>
202
 
 
203
210
</p>
204
211
<div class="variablelist"><table border="0">
205
212
<col align="left" valign="top">
206
213
<tbody>
207
214
<tr>
208
 
<td><p><a name="FS-MEDIA-TYPE-AUDIO:CAPS"></a><span class="term"><code class="literal">FS_MEDIA_TYPE_AUDIO</code></span></p></td>
 
215
<td><p><a name="FS-MEDIA-TYPE-AUDIO--CAPS"></a><span class="term"><code class="literal">FS_MEDIA_TYPE_AUDIO</code></span></p></td>
209
216
<td> A media type that encodes audio.
210
217
</td>
211
218
</tr>
212
219
<tr>
213
 
<td><p><a name="FS-MEDIA-TYPE-VIDEO:CAPS"></a><span class="term"><code class="literal">FS_MEDIA_TYPE_VIDEO</code></span></p></td>
 
220
<td><p><a name="FS-MEDIA-TYPE-VIDEO--CAPS"></a><span class="term"><code class="literal">FS_MEDIA_TYPE_VIDEO</code></span></p></td>
214
221
<td> A media type that encodes video.
215
222
</td>
216
223
</tr>
217
224
<tr>
218
 
<td><p><a name="FS-MEDIA-TYPE-LAST:CAPS"></a><span class="term"><code class="literal">FS_MEDIA_TYPE_LAST</code></span></p></td>
 
225
<td><p><a name="FS-MEDIA-TYPE-LAST--CAPS"></a><span class="term"><code class="literal">FS_MEDIA_TYPE_LAST</code></span></p></td>
219
226
<td> Largest valid <a class="link" href="farsight2-libs-FsCodec.html#FsMediaType" title="enum FsMediaType"><span class="type">FsMediaType</span></a>
220
227
</td>
221
228
</tr>
233
240
<p>
234
241
Used to store arbitary parameters for a codec</p>
235
242
<p>
236
 
 
237
243
</p>
238
244
<div class="variablelist"><table border="0">
239
245
<col align="left" valign="top">
257
263
</div>
258
264
<hr>
259
265
<div class="refsect2" lang="en">
260
 
<a name="FS-CODEC-ID-ANY:CAPS"></a><h3>FS_CODEC_ID_ANY</h3>
 
266
<a name="FS-CODEC-ID-ANY--CAPS"></a><h3>FS_CODEC_ID_ANY</h3>
261
267
<pre class="programlisting">#define FS_CODEC_ID_ANY            (-1)
262
268
</pre>
263
269
<p>
264
 
If the id of a <a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec"><span class="type">FsCodec</span></a> is <a class="link" href="farsight2-libs-FsCodec.html#FS-CODEC-ID-ANY:CAPS" title="FS_CODEC_ID_ANY"><span class="type">FS_CODEC_ID_ANY</span></a>, then it will be replaced
 
270
If the id of a <a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec"><span class="type">FsCodec</span></a> is <a class="link" href="farsight2-libs-FsCodec.html#FS-CODEC-ID-ANY--CAPS" title="FS_CODEC_ID_ANY"><span class="type">FS_CODEC_ID_ANY</span></a>, then it will be replaced
265
271
with a dynamic payload type at runtime</p>
266
272
<p>
267
 
 
268
273
</p>
269
274
</div>
270
275
<hr>
271
276
<div class="refsect2" lang="en">
272
 
<a name="FS-CODEC-ID-DISABLE:CAPS"></a><h3>FS_CODEC_ID_DISABLE</h3>
 
277
<a name="FS-CODEC-ID-DISABLE--CAPS"></a><h3>FS_CODEC_ID_DISABLE</h3>
273
278
<pre class="programlisting">#define FS_CODEC_ID_DISABLE        (-2)
274
279
</pre>
275
280
<p>
276
 
If the id of a <a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec"><span class="type">FsCodec</span></a> is <a class="link" href="farsight2-libs-FsCodec.html#FS-CODEC-ID-DISABLE:CAPS" title="FS_CODEC_ID_DISABLE"><span class="type">FS_CODEC_ID_DISABLE</span></a>, then this codec will
 
281
If the id of a <a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec"><span class="type">FsCodec</span></a> is <a class="link" href="farsight2-libs-FsCodec.html#FS-CODEC-ID-DISABLE--CAPS" title="FS_CODEC_ID_DISABLE"><span class="type">FS_CODEC_ID_DISABLE</span></a>, then this codec will
277
282
not be used</p>
278
283
<p>
279
 
 
280
284
</p>
281
285
</div>
282
286
<hr>
283
287
<div class="refsect2" lang="en">
284
288
<a name="fs-codec-new"></a><h3>fs_codec_new ()</h3>
285
 
<pre class="programlisting"><a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec">FsCodec</a>*            fs_codec_new                        (int id,
 
289
<pre class="programlisting"><a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec">FsCodec</a> *           fs_codec_new                        (int id,
286
290
                                                         const char *encoding_name,
287
291
                                                         <a class="link" href="farsight2-libs-FsCodec.html#FsMediaType" title="enum FsMediaType">FsMediaType</a> media_type,
288
292
                                                         <a
291
295
<p>
292
296
Allocates and initializes a <a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec"><span class="type">FsCodec</span></a> structure</p>
293
297
<p>
294
 
 
295
298
</p>
296
299
<div class="variablelist"><table border="0">
297
300
<col align="left" valign="top">
327
330
<hr>
328
331
<div class="refsect2" lang="en">
329
332
<a name="fs-codec-destroy"></a><h3>fs_codec_destroy ()</h3>
330
 
<pre class="programlisting">void                fs_codec_destroy                    (<a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec">FsCodec</a> *codec);</pre>
 
333
<pre class="programlisting"><a
 
334
href="/usr/share/gtk-doc/html/gnutls/gnutls-gnutls.html#void"
 
335
>void</a>                fs_codec_destroy                    (<a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec">FsCodec</a> *codec);</pre>
331
336
<p>
332
337
Deletes a <a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec"><span class="type">FsCodec</span></a> structure and all its data. Is a no-op on <a
333
 
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
 
338
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
334
339
><code class="literal">NULL</code></a> codec</p>
335
340
<p>
336
 
 
337
341
</p>
338
342
<div class="variablelist"><table border="0">
339
343
<col align="left" valign="top">
347
351
<hr>
348
352
<div class="refsect2" lang="en">
349
353
<a name="fs-codec-copy"></a><h3>fs_codec_copy ()</h3>
350
 
<pre class="programlisting"><a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec">FsCodec</a>*            fs_codec_copy                       (const <a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec">FsCodec</a> *codec);</pre>
 
354
<pre class="programlisting"><a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec">FsCodec</a> *           fs_codec_copy                       (const <a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec">FsCodec</a> *codec);</pre>
351
355
<p>
352
356
Copies a <a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec"><span class="type">FsCodec</span></a> structure.</p>
353
357
<p>
354
 
 
355
358
</p>
356
359
<div class="variablelist"><table border="0">
357
360
<col align="left" valign="top">
379
382
<p>
380
383
Compare two codecs, it will declare two codecs to be identical even
381
384
if their optional parameters are in a different order. <a
382
 
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
 
385
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
383
386
><code class="literal">NULL</code></a> encoding names
384
387
are ignored.</p>
385
388
<p>
386
 
 
387
389
</p>
388
390
<div class="variablelist"><table border="0">
389
391
<col align="left" valign="top">
401
403
<tr>
402
404
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
403
405
<td> <a
404
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
 
406
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE--CAPS"
405
407
><code class="literal">TRUE</code></a> of the codecs are identical, <a
406
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
 
408
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE--CAPS"
407
409
><code class="literal">FALSE</code></a> otherwise
408
410
</td>
409
411
</tr>
415
417
<a name="fs-codec-list-from-keyfile"></a><h3>fs_codec_list_from_keyfile ()</h3>
416
418
<pre class="programlisting"><a
417
419
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
418
 
>GList</a>*              fs_codec_list_from_keyfile          (const <a
 
420
>GList</a> *             fs_codec_list_from_keyfile          (const <a
419
421
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
420
422
>gchar</a> *filename,
421
423
                                                         <a
444
446
another_param=WOW
445
447
</pre></div>
446
448
<p>
447
 
 
448
449
</p>
449
450
<div class="variablelist"><table border="0">
450
451
<col align="left" valign="top">
468
469
<td> The <a
469
470
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
470
471
><span class="type">GList</span></a> of <a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec"><span class="type">FsCodec</span></a> or <a
471
 
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
 
472
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
472
473
><code class="literal">NULL</code></a> if the keyfile was empty
473
474
 or an error occured.
474
475
</td>
479
480
<hr>
480
481
<div class="refsect2" lang="en">
481
482
<a name="fs-codec-list-destroy"></a><h3>fs_codec_list_destroy ()</h3>
482
 
<pre class="programlisting">void                fs_codec_list_destroy               (<a
 
483
<pre class="programlisting"><a
 
484
href="/usr/share/gtk-doc/html/gnutls/gnutls-gnutls.html#void"
 
485
>void</a>                fs_codec_list_destroy               (<a
483
486
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
484
487
>GList</a> *codec_list);</pre>
485
488
<p>
486
489
Deletes a list of <a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec"><span class="type">FsCodec</span></a> structures and the list itself.
487
490
Does nothing on <a
488
 
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
 
491
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
489
492
><code class="literal">NULL</code></a> lists.</p>
490
493
<p>
491
 
 
492
494
</p>
493
495
<div class="variablelist"><table border="0">
494
496
<col align="left" valign="top">
504
506
<a name="fs-codec-list-copy"></a><h3>fs_codec_list_copy ()</h3>
505
507
<pre class="programlisting"><a
506
508
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
507
 
>GList</a>*              fs_codec_list_copy                  (const <a
 
509
>GList</a> *             fs_codec_list_copy                  (const <a
508
510
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
509
511
>GList</a> *codec_list);</pre>
510
512
<p>
511
513
Copies a list of <a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec"><span class="type">FsCodec</span></a> structures.</p>
512
514
<p>
513
 
 
514
515
</p>
515
516
<div class="variablelist"><table border="0">
516
517
<col align="left" valign="top">
542
543
<p>
543
544
Verifies if two glist of fscodecs are identical</p>
544
545
<p>
545
 
 
546
546
</p>
547
547
<div class="variablelist"><table border="0">
548
548
<col align="left" valign="top">
564
564
<tr>
565
565
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
566
566
<td> <a
567
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
 
567
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE--CAPS"
568
568
><code class="literal">TRUE</code></a> if they are identical, <a
569
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
 
569
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE--CAPS"
570
570
><code class="literal">FALSE</code></a> otherwise
571
571
</td>
572
572
</tr>
578
578
<a name="fs-codec-to-string"></a><h3>fs_codec_to_string ()</h3>
579
579
<pre class="programlisting"><a
580
580
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
581
 
>gchar</a>*              fs_codec_to_string                  (const <a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec">FsCodec</a> *codec);</pre>
 
581
>gchar</a> *             fs_codec_to_string                  (const <a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec">FsCodec</a> *codec);</pre>
582
582
<p>
583
583
Returns a newly-allocated string representing the codec</p>
584
584
<p>
585
 
 
586
585
</p>
587
586
<div class="variablelist"><table border="0">
588
587
<col align="left" valign="top">
603
602
<hr>
604
603
<div class="refsect2" lang="en">
605
604
<a name="fs-codec-add-optional-parameter"></a><h3>fs_codec_add_optional_parameter ()</h3>
606
 
<pre class="programlisting">void                fs_codec_add_optional_parameter     (<a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec">FsCodec</a> *codec,
 
605
<pre class="programlisting"><a
 
606
href="/usr/share/gtk-doc/html/gnutls/gnutls-gnutls.html#void"
 
607
>void</a>                fs_codec_add_optional_parameter     (<a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec">FsCodec</a> *codec,
607
608
                                                         const <a
608
609
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
609
610
>gchar</a> *name,
613
614
<p>
614
615
This function adds an new optional parameter to a <a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec"><span class="type">FsCodec</span></a></p>
615
616
<p>
616
 
 
617
617
</p>
618
618
<div class="variablelist"><table border="0">
619
619
<col align="left" valign="top">
639
639
<hr>
640
640
<div class="refsect2" lang="en">
641
641
<a name="fs-codec-remove-optional-parameter"></a><h3>fs_codec_remove_optional_parameter ()</h3>
642
 
<pre class="programlisting">void                fs_codec_remove_optional_parameter  (<a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec">FsCodec</a> *codec,
 
642
<pre class="programlisting"><a
 
643
href="/usr/share/gtk-doc/html/gnutls/gnutls-gnutls.html#void"
 
644
>void</a>                fs_codec_remove_optional_parameter  (<a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec">FsCodec</a> *codec,
643
645
                                                         <a class="link" href="farsight2-libs-FsCodec.html#FsCodecParameter" title="FsCodecParameter">FsCodecParameter</a> *param);</pre>
644
646
<p>
645
647
Removes an optional parameter from a codec</p>
646
648
<p>
647
 
 
648
649
</p>
649
650
<div class="variablelist"><table border="0">
650
651
<col align="left" valign="top">
665
666
<hr>
666
667
<div class="refsect2" lang="en">
667
668
<a name="fs-codec-get-optional-parameter"></a><h3>fs_codec_get_optional_parameter ()</h3>
668
 
<pre class="programlisting"><a class="link" href="farsight2-libs-FsCodec.html#FsCodecParameter" title="FsCodecParameter">FsCodecParameter</a>*   fs_codec_get_optional_parameter     (<a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec">FsCodec</a> *codec,
 
669
<pre class="programlisting"><a class="link" href="farsight2-libs-FsCodec.html#FsCodecParameter" title="FsCodecParameter">FsCodecParameter</a> *  fs_codec_get_optional_parameter     (<a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec">FsCodec</a> *codec,
669
670
                                                         const <a
670
671
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
671
672
>gchar</a> *name,
675
676
<p>
676
677
Finds the <a class="link" href="farsight2-libs-FsCodec.html#FsCodecParameter" title="FsCodecParameter"><span class="type">FsCodecParameter</span></a> in the <a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec"><span class="type">FsCodec</span></a> that has the requested name
677
678
and, if not <a
678
 
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
 
679
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
679
680
><code class="literal">NULL</code></a>, the requested value</p>
680
681
<p>
681
 
 
682
682
</p>
683
683
<div class="variablelist"><table border="0">
684
684
<col align="left" valign="top">
696
696
<tr>
697
697
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
698
698
<td> The value of the parameter to search for or <a
699
 
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
 
699
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
700
700
><code class="literal">NULL</code></a> for any value
701
701
</td>
702
702
</tr>
703
703
<tr>
704
704
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
705
705
<td> the <a class="link" href="farsight2-libs-FsCodec.html#FsCodecParameter" title="FsCodecParameter"><span class="type">FsCodecParameter</span></a> from the <a class="link" href="farsight2-libs-FsCodec.html#FsCodec" title="FsCodec"><span class="type">FsCodec</span></a> or <a
706
 
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
 
706
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
707
707
><code class="literal">NULL</code></a>
708
708
</td>
709
709
</tr>
712
712
</div>
713
713
<hr>
714
714
<div class="refsect2" lang="en">
715
 
<a name="FS-CODEC-FORMAT:CAPS"></a><h3>FS_CODEC_FORMAT</h3>
 
715
<a name="FS-CODEC-FORMAT--CAPS"></a><h3>FS_CODEC_FORMAT</h3>
716
716
<pre class="programlisting">#define FS_CODEC_FORMAT "%d: %s %s clock:%d channels:%d params:%p"
717
717
</pre>
718
718
<p>
719
719
A format that can be used in printf like format strings to format a FsCodec</p>
720
720
<p>
721
 
 
722
721
</p>
723
722
</div>
724
723
<hr>
725
724
<div class="refsect2" lang="en">
726
 
<a name="FS-CODEC-ARGS:CAPS"></a><h3>FS_CODEC_ARGS()</h3>
 
725
<a name="FS-CODEC-ARGS--CAPS"></a><h3>FS_CODEC_ARGS()</h3>
727
726
<pre class="programlisting">#define             FS_CODEC_ARGS(codec)</pre>
728
727
<p>
729
728
Formats the codec in args for FS_CODEC_FORMAT</p>
730
729
<p>
731
 
 
732
730
</p>
733
731
<div class="variablelist"><table border="0">
734
732
<col align="left" valign="top">
744
742
<a name="fs-media-type-to-string"></a><h3>fs_media_type_to_string ()</h3>
745
743
<pre class="programlisting">const <a
746
744
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
747
 
>gchar</a>*        fs_media_type_to_string             (<a class="link" href="farsight2-libs-FsCodec.html#FsMediaType" title="enum FsMediaType">FsMediaType</a> media_type);</pre>
 
745
>gchar</a> *       fs_media_type_to_string             (<a class="link" href="farsight2-libs-FsCodec.html#FsMediaType" title="enum FsMediaType">FsMediaType</a> media_type);</pre>
748
746
<p>
749
747
Gives a user-printable string representing the media type</p>
750
748
<p>
751
 
 
752
749
</p>
753
750
<div class="variablelist"><table border="0">
754
751
<col align="left" valign="top">
770
767
</div>
771
768
<div class="footer">
772
769
<hr>
773
 
          Generated by GTK-Doc V1.10</div>
 
770
          Generated by GTK-Doc V1.11</div>
774
771
</body>
775
772
</html>