mobile/docs/libs/html/gst-plugins-base-libs-gsttaglanguagecodes.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>gsttaglanguagecodes</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-gsttagmux.html" title="gsttagmux">
  10 <link rel="next" href="gst-plugins-base-libs-gsttaglicenses.html" title="gsttaglicenses">
  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-gsttagmux.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-gsttaglicenses.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-gsttaglanguagecodes.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-base-libs-gsttaglanguagecodes.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="gst-plugins-base-libs-gsttaglanguagecodes"></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-gsttaglanguagecodes.top_of_page"></a>gsttaglanguagecodes</span></h2>
  34 <p>gsttaglanguagecodes — mappings for ISO-639 language codes and names</p>
  35 </td>
  36 <td valign="top" align="right"></td>
  37 </tr></table></div>
  38 <div class="refsynopsisdiv">
  39 <a name="gst-plugins-base-libs-gsttaglanguagecodes.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis">
  41 #include &lt;gst/tag/tag.h&gt;
  42
  43 <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-gsttaglanguagecodes.html#gst-tag-get-language-codes" title="gst_tag_get_language_codes ()">gst_tag_get_language_codes</a>          (<em class="parameter"><code><span class="type">void</span></code></em>);
  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-gsttaglanguagecodes.html#gst-tag-get-language-name" title="gst_tag_get_language_name ()">gst_tag_get_language_name</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> *language_code</code></em>);
  45 #define             <a class="link" href="gst-plugins-base-libs-gsttaglanguagecodes.html#gst-tag-get-language-code" title="gst_tag_get_language_code()">gst_tag_get_language_code</a>           (lang_code)
  46 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-gsttaglanguagecodes.html#gst-tag-get-language-code-iso-639-1" title="gst_tag_get_language_code_iso_639_1 ()">gst_tag_get_language_code_iso_639_1</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> *lang_code</code></em>);
  47 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-gsttaglanguagecodes.html#gst-tag-get-language-code-iso-639-2B" title="gst_tag_get_language_code_iso_639_2B ()">gst_tag_get_language_code_iso_639_2B</a>
  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> *lang_code</code></em>);
  49 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-gsttaglanguagecodes.html#gst-tag-get-language-code-iso-639-2T" title="gst_tag_get_language_code_iso_639_2T ()">gst_tag_get_language_code_iso_639_2T</a>
  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> *lang_code</code></em>);
  51 </pre>
  52 </div>
  53 <div class="refsect1">
  54 <a name="gst-plugins-base-libs-gsttaglanguagecodes.description"></a><h2>Description</h2>
  55 <p>
  56 </p>
  57 <div class="refsect2">
  58 <a name="idp25117840"></a><p>
  59 Provides helper functions to convert between the various ISO-639 language
  60 codes, and to map language codes to language names.
  61 </p>
  62 </div>
  63 <p>
  64 </p>
  65 </div>
  66 <div class="refsect1">
  67 <a name="gst-plugins-base-libs-gsttaglanguagecodes.details"></a><h2>Details</h2>
  68 <div class="refsect2">
  69 <a name="gst-tag-get-language-codes"></a><h3>gst_tag_get_language_codes ()</h3>
  70 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> **            gst_tag_get_language_codes          (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
  71 <p>
  72 Returns a list of known language codes (in form of two-letter ISO-639-1
  73 codes). This is useful for UIs to build a list of available languages for
  74 tagging purposes (e.g. to tag an audio track appropriately in a video or
  75 audio editor).
  76 </p>
  77 <div class="variablelist"><table border="0">
  78 <col align="left" valign="top">
  79 <tbody><tr>
  80 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
  81 <td>NULL-terminated string array with two-letter language codes. Free
  82 with <a href="http://library.gnome.org/devel/glib/unstable/glib-String-Utility-Functions.html#g-strfreev"><code class="function">g_strfreev()</code></a> when no longer needed.</td>
  83 </tr></tbody>
  84 </table></div>
  85 <p class="since">Since 0.10.26</p>
  86 </div>
  87 <hr>
  88 <div class="refsect2">
  89 <a name="gst-tag-get-language-name"></a><h3>gst_tag_get_language_name ()</h3>
  90 <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_get_language_name           (<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> *language_code</code></em>);</pre>
  91 <p>
  92 Returns the name of the language given an ISO-639 language code, such
  93 as often found in a GST_TAG_LANGUAGE tag. The name will be translated
  94 according to the current locale (if the library was built against the
  95 iso-codes package, otherwise the English name will be returned).
  96 </p>
  97 <p>
  98 Language codes are case-sensitive and expected to be lower case.
  99 </p>
 100 <div class="variablelist"><table border="0">
 101 <col align="left" valign="top">
 102 <tbody>
 103 <tr>
 104 <td><p><span class="term"><em class="parameter"><code>language_code</code></em> :</span></p></td>
 105 <td>two or three-letter ISO-639 language code</td>
 106 </tr>
 107 <tr>
 108 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 109 <td>language name in UTF-8 format, or NULL if <em class="parameter"><code>language_code</code></em> could
 110 not be mapped to a language name. The returned string must not be
 111 modified and does not need to freed; it will stay valid until the
 112 application is terminated.</td>
 113 </tr>
 114 </tbody>
 115 </table></div>
 116 <p class="since">Since 0.10.26</p>
 117 </div>
 118 <hr>
 119 <div class="refsect2">
 120 <a name="gst-tag-get-language-code"></a><h3>gst_tag_get_language_code()</h3>
 121 <pre class="programlisting">#define             gst_tag_get_language_code(lang_code)</pre>
 122 <p>
 123 Convenience macro wrapping <a class="link" href="gst-plugins-base-libs-gsttaglanguagecodes.html#gst-tag-get-language-code-iso-639-1" title="gst_tag_get_language_code_iso_639_1 ()"><code class="function">gst_tag_get_language_code_iso_639_1()</code></a>.
 124 </p>
 125 <div class="variablelist"><table border="0">
 126 <col align="left" valign="top">
 127 <tbody><tr>
 128 <td><p><span class="term"><em class="parameter"><code>lang_code</code></em> :</span></p></td>
 129 <td>ISO-639 language code (e.g. "deu" or "ger" or "de")</td>
 130 </tr></tbody>
 131 </table></div>
 132 <p class="since">Since 0.10.26</p>
 133 </div>
 134 <hr>
 135 <div class="refsect2">
 136 <a name="gst-tag-get-language-code-iso-639-1"></a><h3>gst_tag_get_language_code_iso_639_1 ()</h3>
 137 <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_get_language_code_iso_639_1 (<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> *lang_code</code></em>);</pre>
 138 <p>
 139 Returns two-letter ISO-639-1 language code given a three-letter ISO-639-2
 140 language code or two-letter ISO-639-1 language code (both are accepted for
 141 convenience).
 142 </p>
 143 <p>
 144 Language codes are case-sensitive and expected to be lower case.
 145 </p>
 146 <div class="variablelist"><table border="0">
 147 <col align="left" valign="top">
 148 <tbody>
 149 <tr>
 150 <td><p><span class="term"><em class="parameter"><code>lang_code</code></em> :</span></p></td>
 151 <td>ISO-639 language code (e.g. "deu" or "ger" or "de")</td>
 152 </tr>
 153 <tr>
 154 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 155 <td>two-letter ISO-639-1 language code string that maps to <em class="parameter"><code>lang_code</code></em>,
 156 or NULL if no mapping is known. The returned string must not be
 157 modified or freed.</td>
 158 </tr>
 159 </tbody>
 160 </table></div>
 161 <p class="since">Since 0.10.26</p>
 162 </div>
 163 <hr>
 164 <div class="refsect2">
 165 <a name="gst-tag-get-language-code-iso-639-2B"></a><h3>gst_tag_get_language_code_iso_639_2B ()</h3>
 166 <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_get_language_code_iso_639_2B
 167                                                         (<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> *lang_code</code></em>);</pre>
 168 <p>
 169 Returns three-letter ISO-639-2 "bibliographic" language code given a
 170 two-letter ISO-639-1 language code or a three-letter ISO-639-2 language
 171 code (both are accepted for convenience).
 172 </p>
 173 <p>
 174 The "bibliographic" code is derived from the English name of the language
 175 (e.g. "ger" for German instead of "de" or "deu"). In most scenarios, the
 176 "terminological" codes are prefered.
 177 </p>
 178 <p>
 179 Language codes are case-sensitive and expected to be lower case.
 180 </p>
 181 <div class="variablelist"><table border="0">
 182 <col align="left" valign="top">
 183 <tbody>
 184 <tr>
 185 <td><p><span class="term"><em class="parameter"><code>lang_code</code></em> :</span></p></td>
 186 <td>ISO-639 language code (e.g. "deu" or "ger" or "de")</td>
 187 </tr>
 188 <tr>
 189 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 190 <td>three-letter ISO-639-2 language code string that maps to <em class="parameter"><code>lang_code</code></em>,
 191 or NULL if no mapping is known. The returned string must not be
 192 modified or freed.</td>
 193 </tr>
 194 </tbody>
 195 </table></div>
 196 <p class="since">Since 0.10.26</p>
 197 </div>
 198 <hr>
 199 <div class="refsect2">
 200 <a name="gst-tag-get-language-code-iso-639-2T"></a><h3>gst_tag_get_language_code_iso_639_2T ()</h3>
 201 <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_get_language_code_iso_639_2T
 202                                                         (<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> *lang_code</code></em>);</pre>
 203 <p>
 204 Returns three-letter ISO-639-2 "terminological" language code given a
 205 two-letter ISO-639-1 language code or a three-letter ISO-639-2 language
 206 code (both are accepted for convenience).
 207 </p>
 208 <p>
 209 The "terminological" code is derived from the local name of the language
 210 (e.g. "deu" for German instead of "ger"). In most scenarios, the
 211 "terminological" codes are prefered over the "bibliographic" ones.
 212 </p>
 213 <p>
 214 Language codes are case-sensitive and expected to be lower case.
 215 </p>
 216 <div class="variablelist"><table border="0">
 217 <col align="left" valign="top">
 218 <tbody>
 219 <tr>
 220 <td><p><span class="term"><em class="parameter"><code>lang_code</code></em> :</span></p></td>
 221 <td>ISO-639 language code (e.g. "deu" or "ger" or "de")</td>
 222 </tr>
 223 <tr>
 224 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 225 <td>three-letter ISO-639-2 language code string that maps to <em class="parameter"><code>lang_code</code></em>,
 226 or NULL if no mapping is known. The returned string must not be
 227 modified or freed.</td>
 228 </tr>
 229 </tbody>
 230 </table></div>
 231 <p class="since">Since 0.10.26</p>
 232 </div>
 233 </div>
 234 <div class="refsect1">
 235 <a name="gst-plugins-base-libs-gsttaglanguagecodes.see-also"></a><h2>See Also</h2>
 236 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="type">GstTagList</span></a>
 237 </div>
 238 </div>
 239 <div class="footer">
 240 <hr>
 241           Generated by GTK-Doc V1.18</div>
 242 </body>
 243 </html>