mobile/docs/libs/html/gst-plugins-base-libs-gsttagvorbis.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>gsttagvorbis</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GStreamer Base Plugins 0.10 Library Reference Manual">
   8 <link rel="up" href="gstreamer-tag.html" title="Tag Support Library">
   9 <link rel="prev" href="gst-plugins-base-libs-gsttag.html" title="gsttag">
  10 <link rel="next" href="gst-plugins-base-libs-gsttagid3.html" title="gsttagid3">
  11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="gst-plugins-base-libs-gsttag.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="gstreamer-tag.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GStreamer Base Plugins 0.10 Library Reference Manual</th>
  21 <td><a accesskey="n" href="gst-plugins-base-libs-gsttagid3.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#gst-plugins-base-libs-gsttagvorbis.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-base-libs-gsttagvorbis.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="gst-plugins-base-libs-gsttagvorbis"></a><div class="titlepage"></div>
  31 <div class="refnamediv"><table width="100%"><tr>
  32 <td valign="top">
  33 <h2><span class="refentrytitle"><a name="gst-plugins-base-libs-gsttagvorbis.top_of_page"></a>gsttagvorbis</span></h2>
  34 <p>gsttagvorbis — tag mappings and support functions for plugins
  35                     dealing with vorbiscomments</p>
  36 </td>
  37 <td valign="top" align="right"></td>
  38 </tr></table></div>
  39 <div class="refsynopsisdiv">
  40 <a name="gst-plugins-base-libs-gsttagvorbis.synopsis"></a><h2>Synopsis</h2>
  41 <pre class="synopsis">
  42 #include &lt;gst/tag/tag.h&gt;
  43
  44 const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></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>             (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *vorbis_tag</code></em>);
  45 const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></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>               (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *gst_tag</code></em>);
  46 <span class="returnvalue">void</span>                <a class="link" href="gst-plugins-base-libs-gsttagvorbis.html#gst-vorbis-tag-add" title="gst_vorbis_tag_add ()">gst_vorbis_tag_add</a>                  (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="type">GstTagList</span></a> *list</code></em>,
  47                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tag</code></em>,
  48                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *value</code></em>);
  49 <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></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>          (<em class="parameter"><code>const <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="type">GstTagList</span></a> *list</code></em>,
  50                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tag</code></em>);
  51
  52 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="returnvalue">GstTagList</span></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>
  53                                                         (<em class="parameter"><code>const <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buffer</code></em>,
  54                                                          <em class="parameter"><code>const <span class="type">guint8</span> *id_data</code></em>,
  55                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> id_data_length</code></em>,
  56                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **vendor_string</code></em>);
  57 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></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>
  58                                                         (<em class="parameter"><code>const <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="type">GstTagList</span></a> *list</code></em>,
  59                                                          <em class="parameter"><code>const <span class="type">guint8</span> *id_data</code></em>,
  60                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> id_data_length</code></em>,
  61                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *vendor_string</code></em>);
  62 </pre>
  63 </div>
  64 <div class="refsect1">
  65 <a name="gst-plugins-base-libs-gsttagvorbis.description"></a><h2>Description</h2>
  66 <p>
  67 </p>
  68 <div class="refsect2">
  69 <a name="idp24787424"></a><p>
  70 Contains various utility functions for plugins to parse or create
  71 vorbiscomments and map them to and from <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="type">GstTagList</span></a>s.
  72 </p>
  73 </div>
  74 <p>
  75 </p>
  76 </div>
  77 <div class="refsect1">
  78 <a name="gst-plugins-base-libs-gsttagvorbis.details"></a><h2>Details</h2>
  79 <div class="refsect2">
  80 <a name="gst-tag-from-vorbis-tag"></a><h3>gst_tag_from_vorbis_tag ()</h3>
  81 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       gst_tag_from_vorbis_tag             (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *vorbis_tag</code></em>);</pre>
  82 <p>
  83 Looks up the GStreamer tag for a vorbiscomment tag.
  84 </p>
  85 <div class="variablelist"><table border="0">
  86 <col align="left" valign="top">
  87 <tbody>
  88 <tr>
  89 <td><p><span class="term"><em class="parameter"><code>vorbis_tag</code></em> :</span></p></td>
  90 <td>vorbiscomment tag to convert to GStreamer tag</td>
  91 </tr>
  92 <tr>
  93 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
  94 <td>The corresponding GStreamer tag or NULL if none exists.</td>
  95 </tr>
  96 </tbody>
  97 </table></div>
  98 </div>
  99 <hr>
 100 <div class="refsect2">
 101 <a name="gst-tag-to-vorbis-tag"></a><h3>gst_tag_to_vorbis_tag ()</h3>
 102 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       gst_tag_to_vorbis_tag               (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *gst_tag</code></em>);</pre>
 103 <p>
 104 Looks up the vorbiscomment tag for a GStreamer tag.
 105 </p>
 106 <div class="variablelist"><table border="0">
 107 <col align="left" valign="top">
 108 <tbody>
 109 <tr>
 110 <td><p><span class="term"><em class="parameter"><code>gst_tag</code></em> :</span></p></td>
 111 <td>GStreamer tag to convert to vorbiscomment tag</td>
 112 </tr>
 113 <tr>
 114 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 115 <td>The corresponding vorbiscomment tag or NULL if none exists.</td>
 116 </tr>
 117 </tbody>
 118 </table></div>
 119 </div>
 120 <hr>
 121 <div class="refsect2">
 122 <a name="gst-vorbis-tag-add"></a><h3>gst_vorbis_tag_add ()</h3>
 123 <pre class="programlisting"><span class="returnvalue">void</span>                gst_vorbis_tag_add                  (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="type">GstTagList</span></a> *list</code></em>,
 124                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tag</code></em>,
 125                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *value</code></em>);</pre>
 126 <p>
 127 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
 128 a vorbis comment string into the right type and adding it to the
 129 given taglist <em class="parameter"><code>list</code></em>.
 130 </p>
 131 <p>
 132 Unknown vorbiscomment tags will be added to the tag list in form
 133 of a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GST-TAG-EXTENDED-COMMENT:CAPS"><span class="type">GST_TAG_EXTENDED_COMMENT</span></a> (since 0.10.10 at least).
 134 </p>
 135 <div class="variablelist"><table border="0">
 136 <col align="left" valign="top">
 137 <tbody>
 138 <tr>
 139 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
 140 <td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="type">GstTagList</span></a>
 141 </td>
 142 </tr>
 143 <tr>
 144 <td><p><span class="term"><em class="parameter"><code>tag</code></em> :</span></p></td>
 145 <td>a vorbiscomment tag string (key in key=value), must be valid UTF-8</td>
 146 </tr>
 147 <tr>
 148 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 149 <td>a vorbiscomment value string (value in key=value), must be valid UTF-8</td>
 150 </tr>
 151 </tbody>
 152 </table></div>
 153 </div>
 154 <hr>
 155 <div class="refsect2">
 156 <a name="gst-tag-to-vorbis-comments"></a><h3>gst_tag_to_vorbis_comments ()</h3>
 157 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *             gst_tag_to_vorbis_comments          (<em class="parameter"><code>const <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="type">GstTagList</span></a> *list</code></em>,
 158                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tag</code></em>);</pre>
 159 <p>
 160 Creates a new tag list that contains the information parsed out of a
 161 vorbiscomment packet.
 162 </p>
 163 <div class="variablelist"><table border="0">
 164 <col align="left" valign="top">
 165 <tbody>
 166 <tr>
 167 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
 168 <td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="type">GstTagList</span></a>
 169 </td>
 170 </tr>
 171 <tr>
 172 <td><p><span class="term"><em class="parameter"><code>tag</code></em> :</span></p></td>
 173 <td>a GStreamer tag identifier, such as <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GST-TAG-ARTIST:CAPS"><span class="type">GST_TAG_ARTIST</span></a>
 174 </td>
 175 </tr>
 176 <tr>
 177 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 178 <td>A <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of newly-allocated key=value strings. Free with
 179 g_list_foreach (list, (GFunc) g_free, NULL) plus g_list_free (list)</td>
 180 </tr>
 181 </tbody>
 182 </table></div>
 183 </div>
 184 <hr>
 185 <div class="refsect2">
 186 <a name="gst-tag-list-from-vorbiscomment-buffer"></a><h3>gst_tag_list_from_vorbiscomment_buffer ()</h3>
 187 <pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="returnvalue">GstTagList</span></a> *        gst_tag_list_from_vorbiscomment_buffer
 188                                                         (<em class="parameter"><code>const <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buffer</code></em>,
 189                                                          <em class="parameter"><code>const <span class="type">guint8</span> *id_data</code></em>,
 190                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> id_data_length</code></em>,
 191                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **vendor_string</code></em>);</pre>
 192 <p>
 193 Creates a new tag list that contains the information parsed out of a
 194 vorbiscomment packet.
 195 </p>
 196 <div class="variablelist"><table border="0">
 197 <col align="left" valign="top">
 198 <tbody>
 199 <tr>
 200 <td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
 201 <td>buffer to convert</td>
 202 </tr>
 203 <tr>
 204 <td><p><span class="term"><em class="parameter"><code>id_data</code></em> :</span></p></td>
 205 <td>identification data at start of stream</td>
 206 </tr>
 207 <tr>
 208 <td><p><span class="term"><em class="parameter"><code>id_data_length</code></em> :</span></p></td>
 209 <td>length of identification data</td>
 210 </tr>
 211 <tr>
 212 <td><p><span class="term"><em class="parameter"><code>vendor_string</code></em> :</span></p></td>
 213 <td>pointer to a string that should take the vendor string
 214 of this vorbis comment or NULL if you don't need it.</td>
 215 </tr>
 216 <tr>
 217 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 218 <td>A new <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="type">GstTagList</span></a> with all tags that could be extracted from the
 219 given vorbiscomment buffer or NULL on error.</td>
 220 </tr>
 221 </tbody>
 222 </table></div>
 223 </div>
 224 <hr>
 225 <div class="refsect2">
 226 <a name="gst-tag-list-to-vorbiscomment-buffer"></a><h3>gst_tag_list_to_vorbiscomment_buffer ()</h3>
 227 <pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></a> *         gst_tag_list_to_vorbiscomment_buffer
 228                                                         (<em class="parameter"><code>const <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="type">GstTagList</span></a> *list</code></em>,
 229                                                          <em class="parameter"><code>const <span class="type">guint8</span> *id_data</code></em>,
 230                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> id_data_length</code></em>,
 231                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *vendor_string</code></em>);</pre>
 232 <p>
 233 Creates a new vorbiscomment buffer from a tag list.
 234 </p>
 235 <div class="variablelist"><table border="0">
 236 <col align="left" valign="top">
 237 <tbody>
 238 <tr>
 239 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
 240 <td>tag list to convert</td>
 241 </tr>
 242 <tr>
 243 <td><p><span class="term"><em class="parameter"><code>id_data</code></em> :</span></p></td>
 244 <td>identification data at start of stream</td>
 245 </tr>
 246 <tr>
 247 <td><p><span class="term"><em class="parameter"><code>id_data_length</code></em> :</span></p></td>
 248 <td>length of identification data, may be 0 if <em class="parameter"><code>id_data</code></em> is NULL</td>
 249 </tr>
 250 <tr>
 251 <td><p><span class="term"><em class="parameter"><code>vendor_string</code></em> :</span></p></td>
 252 <td>string that describes the vendor string or NULL</td>
 253 </tr>
 254 <tr>
 255 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 256 <td>A new <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> containing a vorbiscomment buffer with all tags
 257 that could be converted from the given tag list.</td>
 258 </tr>
 259 </tbody>
 260 </table></div>
 261 </div>
 262 </div>
 263 <div class="refsect1">
 264 <a name="gst-plugins-base-libs-gsttagvorbis.see-also"></a><h2>See Also</h2>
 265 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="type">GstTagList</span></a>
 266 </div>
 267 </div>
 268 <div class="footer">
 269 <hr>
 270           Generated by GTK-Doc V1.18</div>
 271 </body>
 272 </html>