~ubuntu-branches/ubuntu/karmic/gst-plugins-base0.10/karmic-updates

« back to all changes in this revision

Viewing changes to docs/libs/html/gst-plugins-base-libs-gsttagvorbis.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastian Dröge
  • Date: 2009-10-05 18:10:19 UTC
  • mfrom: (14.3.4 squeeze)
  • Revision ID: james.westby@ubuntu.com-20091005181019-vcb3daxz031og2sh
Tags: 0.10.25-1
* New upstream release, 'Standard disclaimers apply':
  + debian/libgstreamer-plugins-base.symbols:
    - Updated for the new version.

Show diffs side-by-side

added added

removed removed

Lines of Context:
60
60
#include <gst/tag/tag.h>
61
61
 
62
62
const <a
63
 
href="../glib/glib-Basic-Types.html#gchar"
 
63
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
64
64
>gchar</a> *       <a class="link" href="gst-plugins-base-libs-gsttagvorbis.html#gst-tag-from-vorbis-tag" title="gst_tag_from_vorbis_tag ()">gst_tag_from_vorbis_tag</a>             (const <a
65
 
href="../glib/glib-Basic-Types.html#gchar"
 
65
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
66
66
>gchar</a> *vorbis_tag);
67
67
const <a
68
 
href="../glib/glib-Basic-Types.html#gchar"
 
68
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
69
69
>gchar</a> *       <a class="link" href="gst-plugins-base-libs-gsttagvorbis.html#gst-tag-to-vorbis-tag" title="gst_tag_to_vorbis_tag ()">gst_tag_to_vorbis_tag</a>               (const <a
70
 
href="../glib/glib-Basic-Types.html#gchar"
 
70
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
71
71
>gchar</a> *gst_tag);
72
72
void                <a class="link" href="gst-plugins-base-libs-gsttagvorbis.html#gst-vorbis-tag-add" title="gst_vorbis_tag_add ()">gst_vorbis_tag_add</a>                  (<a
73
 
href="../gstreamer-0.10/gstreamer-GstTagList.html#GstTagList"
 
73
href="/usr/share/gtk-doc/html/gstreamer-0.10/gstreamer-GstTagList.html#GstTagList"
74
74
>GstTagList</a> *list,
75
75
                                                         const <a
76
 
href="../glib/glib-Basic-Types.html#gchar"
 
76
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
77
77
>gchar</a> *tag,
78
78
                                                         const <a
79
 
href="../glib/glib-Basic-Types.html#gchar"
 
79
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
80
80
>gchar</a> *value);
81
81
<a
82
 
href="../glib/glib-Doubly-Linked-Lists.html#GList"
 
82
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
83
83
>GList</a> *             <a class="link" href="gst-plugins-base-libs-gsttagvorbis.html#gst-tag-to-vorbis-comments" title="gst_tag_to_vorbis_comments ()">gst_tag_to_vorbis_comments</a>          (const <a
84
 
href="../gstreamer-0.10/gstreamer-GstTagList.html#GstTagList"
 
84
href="/usr/share/gtk-doc/html/gstreamer-0.10/gstreamer-GstTagList.html#GstTagList"
85
85
>GstTagList</a> *list,
86
86
                                                         const <a
87
 
href="../glib/glib-Basic-Types.html#gchar"
 
87
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
88
88
>gchar</a> *tag);
89
89
 
90
90
<a
91
 
href="../gstreamer-0.10/gstreamer-GstTagList.html#GstTagList"
 
91
href="/usr/share/gtk-doc/html/gstreamer-0.10/gstreamer-GstTagList.html#GstTagList"
92
92
>GstTagList</a> *        <a class="link" href="gst-plugins-base-libs-gsttagvorbis.html#gst-tag-list-from-vorbiscomment-buffer" title="gst_tag_list_from_vorbiscomment_buffer ()">gst_tag_list_from_vorbiscomment_buffer</a>
93
93
                                                        (const <a
94
 
href="../gstreamer-0.10/gstreamer-GstBuffer.html#GstBuffer"
 
94
href="/usr/share/gtk-doc/html/gstreamer-0.10/gstreamer-GstBuffer.html#GstBuffer"
95
95
>GstBuffer</a> *buffer,
96
96
                                                         const <a
97
 
href="../glib/glib-Basic-Types.html#guint8"
 
97
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint8"
98
98
>guint8</a> *id_data,
99
99
                                                         const <a
100
 
href="../glib/glib-Basic-Types.html#guint"
 
100
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
101
101
>guint</a> id_data_length,
102
102
                                                         <a
103
 
href="../glib/glib-Basic-Types.html#gchar"
 
103
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
104
104
>gchar</a> **vendor_string);
105
105
<a
106
 
href="../gstreamer-0.10/gstreamer-GstBuffer.html#GstBuffer"
 
106
href="/usr/share/gtk-doc/html/gstreamer-0.10/gstreamer-GstBuffer.html#GstBuffer"
107
107
>GstBuffer</a> *         <a class="link" href="gst-plugins-base-libs-gsttagvorbis.html#gst-tag-list-to-vorbiscomment-buffer" title="gst_tag_list_to_vorbiscomment_buffer ()">gst_tag_list_to_vorbiscomment_buffer</a>
108
108
                                                        (const <a
109
 
href="../gstreamer-0.10/gstreamer-GstTagList.html#GstTagList"
 
109
href="/usr/share/gtk-doc/html/gstreamer-0.10/gstreamer-GstTagList.html#GstTagList"
110
110
>GstTagList</a> *list,
111
111
                                                         const <a
112
 
href="../glib/glib-Basic-Types.html#guint8"
 
112
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint8"
113
113
>guint8</a> *id_data,
114
114
                                                         const <a
115
 
href="../glib/glib-Basic-Types.html#guint"
 
115
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
116
116
>guint</a> id_data_length,
117
117
                                                         const <a
118
 
href="../glib/glib-Basic-Types.html#gchar"
 
118
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
119
119
>gchar</a> *vendor_string);
120
120
</pre>
121
121
</div>
127
127
<a name="id2924060"></a><p>
128
128
Contains various utility functions for plugins to parse or create
129
129
vorbiscomments and map them to and from <a
130
 
href="../gstreamer-0.10/gstreamer-GstTagList.html#GstTagList"
 
130
href="/usr/share/gtk-doc/html/gstreamer-0.10/gstreamer-GstTagList.html#GstTagList"
131
131
><span class="type">GstTagList</span></a>s.
132
132
</p>
133
133
</div>
139
139
<div class="refsect2" lang="en">
140
140
<a name="gst-tag-from-vorbis-tag"></a><h3>gst_tag_from_vorbis_tag ()</h3>
141
141
<pre class="programlisting">const <a
142
 
href="../glib/glib-Basic-Types.html#gchar"
 
142
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
143
143
>gchar</a> *       gst_tag_from_vorbis_tag             (const <a
144
 
href="../glib/glib-Basic-Types.html#gchar"
 
144
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
145
145
>gchar</a> *vorbis_tag);</pre>
146
146
<p>
147
147
Looks up the GStreamer tag for a vorbiscomment tag.</p>
167
167
<div class="refsect2" lang="en">
168
168
<a name="gst-tag-to-vorbis-tag"></a><h3>gst_tag_to_vorbis_tag ()</h3>
169
169
<pre class="programlisting">const <a
170
 
href="../glib/glib-Basic-Types.html#gchar"
 
170
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
171
171
>gchar</a> *       gst_tag_to_vorbis_tag               (const <a
172
 
href="../glib/glib-Basic-Types.html#gchar"
 
172
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
173
173
>gchar</a> *gst_tag);</pre>
174
174
<p>
175
175
Looks up the vorbiscomment tag for a GStreamer tag.</p>
195
195
<div class="refsect2" lang="en">
196
196
<a name="gst-vorbis-tag-add"></a><h3>gst_vorbis_tag_add ()</h3>
197
197
<pre class="programlisting">void                gst_vorbis_tag_add                  (<a
198
 
href="../gstreamer-0.10/gstreamer-GstTagList.html#GstTagList"
 
198
href="/usr/share/gtk-doc/html/gstreamer-0.10/gstreamer-GstTagList.html#GstTagList"
199
199
>GstTagList</a> *list,
200
200
                                                         const <a
201
 
href="../glib/glib-Basic-Types.html#gchar"
 
201
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
202
202
>gchar</a> *tag,
203
203
                                                         const <a
204
 
href="../glib/glib-Basic-Types.html#gchar"
 
204
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
205
205
>gchar</a> *value);</pre>
206
206
<p>
207
207
Convenience function using <a class="link" href="gst-plugins-base-libs-gsttagvorbis.html#gst-tag-from-vorbis-tag" title="gst_tag_from_vorbis_tag ()"><code class="function">gst_tag_from_vorbis_tag()</code></a>, parsing
211
211
<p>
212
212
Unknown vorbiscomment tags will be added to the tag list in form
213
213
of a <a
214
 
href="../gstreamer-0.10/gstreamer-GstTagList.html#GST-TAG-EXTENDED-COMMENT--CAPS"
 
214
href="/usr/share/gtk-doc/html/gstreamer-0.10/gstreamer-GstTagList.html#GST-TAG-EXTENDED-COMMENT--CAPS"
215
215
><span class="type">GST_TAG_EXTENDED_COMMENT</span></a> (since 0.10.10 at least).</p>
216
216
<p>
217
217
</p>
221
221
<tr>
222
222
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
223
223
<td> a <a
224
 
href="../gstreamer-0.10/gstreamer-GstTagList.html#GstTagList"
 
224
href="/usr/share/gtk-doc/html/gstreamer-0.10/gstreamer-GstTagList.html#GstTagList"
225
225
><span class="type">GstTagList</span></a>
226
226
</td>
227
227
</tr>
242
242
<div class="refsect2" lang="en">
243
243
<a name="gst-tag-to-vorbis-comments"></a><h3>gst_tag_to_vorbis_comments ()</h3>
244
244
<pre class="programlisting"><a
245
 
href="../glib/glib-Doubly-Linked-Lists.html#GList"
 
245
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
246
246
>GList</a> *             gst_tag_to_vorbis_comments          (const <a
247
 
href="../gstreamer-0.10/gstreamer-GstTagList.html#GstTagList"
 
247
href="/usr/share/gtk-doc/html/gstreamer-0.10/gstreamer-GstTagList.html#GstTagList"
248
248
>GstTagList</a> *list,
249
249
                                                         const <a
250
 
href="../glib/glib-Basic-Types.html#gchar"
 
250
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
251
251
>gchar</a> *tag);</pre>
252
252
<p>
253
253
Creates a new tag list that contains the information parsed out of a
260
260
<tr>
261
261
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
262
262
<td> a <a
263
 
href="../gstreamer-0.10/gstreamer-GstTagList.html#GstTagList"
 
263
href="/usr/share/gtk-doc/html/gstreamer-0.10/gstreamer-GstTagList.html#GstTagList"
264
264
><span class="type">GstTagList</span></a>
265
265
</td>
266
266
</tr>
267
267
<tr>
268
268
<td><p><span class="term"><em class="parameter"><code>tag</code></em> :</span></p></td>
269
269
<td> a GStreamer tag identifier, such as <a
270
 
href="../gstreamer-0.10/gstreamer-GstTagList.html#GST-TAG-ARTIST--CAPS"
 
270
href="/usr/share/gtk-doc/html/gstreamer-0.10/gstreamer-GstTagList.html#GST-TAG-ARTIST--CAPS"
271
271
><span class="type">GST_TAG_ARTIST</span></a>
272
272
</td>
273
273
</tr>
274
274
<tr>
275
275
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
276
276
<td> A <a
277
 
href="../glib/glib-Doubly-Linked-Lists.html#GList"
 
277
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
278
278
><span class="type">GList</span></a> of newly-allowcated key=value strings. Free with
279
279
         g_list_foreach (list, (GFunc) g_free, NULL) plus g_list_free (list)
280
280
</td>
286
286
<div class="refsect2" lang="en">
287
287
<a name="gst-tag-list-from-vorbiscomment-buffer"></a><h3>gst_tag_list_from_vorbiscomment_buffer ()</h3>
288
288
<pre class="programlisting"><a
289
 
href="../gstreamer-0.10/gstreamer-GstTagList.html#GstTagList"
 
289
href="/usr/share/gtk-doc/html/gstreamer-0.10/gstreamer-GstTagList.html#GstTagList"
290
290
>GstTagList</a> *        gst_tag_list_from_vorbiscomment_buffer
291
291
                                                        (const <a
292
 
href="../gstreamer-0.10/gstreamer-GstBuffer.html#GstBuffer"
 
292
href="/usr/share/gtk-doc/html/gstreamer-0.10/gstreamer-GstBuffer.html#GstBuffer"
293
293
>GstBuffer</a> *buffer,
294
294
                                                         const <a
295
 
href="../glib/glib-Basic-Types.html#guint8"
 
295
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint8"
296
296
>guint8</a> *id_data,
297
297
                                                         const <a
298
 
href="../glib/glib-Basic-Types.html#guint"
 
298
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
299
299
>guint</a> id_data_length,
300
300
                                                         <a
301
 
href="../glib/glib-Basic-Types.html#gchar"
 
301
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
302
302
>gchar</a> **vendor_string);</pre>
303
303
<p>
304
304
Creates a new tag list that contains the information parsed out of a
332
332
<tr>
333
333
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
334
334
<td> A new <a
335
 
href="../gstreamer-0.10/gstreamer-GstTagList.html#GstTagList"
 
335
href="/usr/share/gtk-doc/html/gstreamer-0.10/gstreamer-GstTagList.html#GstTagList"
336
336
><span class="type">GstTagList</span></a> with all tags that could be extracted from the
337
337
         given vorbiscomment buffer or NULL on error.
338
338
</td>
344
344
<div class="refsect2" lang="en">
345
345
<a name="gst-tag-list-to-vorbiscomment-buffer"></a><h3>gst_tag_list_to_vorbiscomment_buffer ()</h3>
346
346
<pre class="programlisting"><a
347
 
href="../gstreamer-0.10/gstreamer-GstBuffer.html#GstBuffer"
 
347
href="/usr/share/gtk-doc/html/gstreamer-0.10/gstreamer-GstBuffer.html#GstBuffer"
348
348
>GstBuffer</a> *         gst_tag_list_to_vorbiscomment_buffer
349
349
                                                        (const <a
350
 
href="../gstreamer-0.10/gstreamer-GstTagList.html#GstTagList"
 
350
href="/usr/share/gtk-doc/html/gstreamer-0.10/gstreamer-GstTagList.html#GstTagList"
351
351
>GstTagList</a> *list,
352
352
                                                         const <a
353
 
href="../glib/glib-Basic-Types.html#guint8"
 
353
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint8"
354
354
>guint8</a> *id_data,
355
355
                                                         const <a
356
 
href="../glib/glib-Basic-Types.html#guint"
 
356
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
357
357
>guint</a> id_data_length,
358
358
                                                         const <a
359
 
href="../glib/glib-Basic-Types.html#gchar"
 
359
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
360
360
>gchar</a> *vendor_string);</pre>
361
361
<p>
362
362
Creates a new vorbiscomment buffer from a tag list.</p>
388
388
<tr>
389
389
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
390
390
<td> A new <a
391
 
href="../gstreamer-0.10/gstreamer-GstBuffer.html#GstBuffer"
 
391
href="/usr/share/gtk-doc/html/gstreamer-0.10/gstreamer-GstBuffer.html#GstBuffer"
392
392
><span class="type">GstBuffer</span></a> containing a vorbiscomment buffer with all tags
393
393
         that could be converted from the given tag list.
394
394
</td>