| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>gsttaglanguagecodes: GStreamer Base Plugins 1.0 Library Reference Manual</title> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> |
| <link rel="home" href="index.html" title="GStreamer Base Plugins 1.0 Library Reference Manual"> |
| <link rel="up" href="gstreamer-tag.html" title="Tag Support Library"> |
| <link rel="prev" href="gst-plugins-base-libs-gsttagmux.html" title="gsttagmux"> |
| <link rel="next" href="gst-plugins-base-libs-gsttaglicenses.html" title="gsttaglicenses"> |
| <meta name="generator" content="GTK-Doc V1.25 (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="5"><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="#gst-plugins-base-libs-gsttaglanguagecodes.description" class="shortcut">Description</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="gstreamer-tag.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> |
| <td><a accesskey="p" href="gst-plugins-base-libs-gsttagmux.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> |
| <td><a accesskey="n" href="gst-plugins-base-libs-gsttaglicenses.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> |
| </tr></table> |
| <div class="refentry"> |
| <a name="gst-plugins-base-libs-gsttaglanguagecodes"></a><div class="titlepage"></div> |
| <div class="refnamediv"><table width="100%"><tr> |
| <td valign="top"> |
| <h2><span class="refentrytitle"><a name="gst-plugins-base-libs-gsttaglanguagecodes.top_of_page"></a>gsttaglanguagecodes</span></h2> |
| <p>gsttaglanguagecodes — mappings for ISO-639 language codes and names</p> |
| </td> |
| <td class="gallery_image" valign="top" align="right"></td> |
| </tr></table></div> |
| <div class="refsect1"> |
| <a name="gst-plugins-base-libs-gsttaglanguagecodes.functions"></a><h2>Functions</h2> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="functions_return"> |
| <col class="functions_name"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="function_type"> |
| <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> ** |
| </td> |
| <td class="function_name"> |
| <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> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type">const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * |
| </td> |
| <td class="function_name"> |
| <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> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="define_keyword">#define</td> |
| <td class="function_name"> |
| <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><span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type">const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * |
| </td> |
| <td class="function_name"> |
| <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> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type">const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * |
| </td> |
| <td class="function_name"> |
| <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> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type">const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * |
| </td> |
| <td class="function_name"> |
| <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> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> |
| </td> |
| <td class="function_name"> |
| <a class="link" href="gst-plugins-base-libs-gsttaglanguagecodes.html#gst-tag-check-language-code" title="gst_tag_check_language_code ()">gst_tag_check_language_code</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect1"> |
| <a name="gst-plugins-base-libs-gsttaglanguagecodes.includes"></a><h2>Includes</h2> |
| <pre class="synopsis">#include <gst/tag/tag.h> |
| </pre> |
| </div> |
| <div class="refsect1"> |
| <a name="gst-plugins-base-libs-gsttaglanguagecodes.description"></a><h2>Description</h2> |
| <div class="refsect2"> |
| <a name="id-1.2.13.11.5.2"></a><p> |
| Provides helper functions to convert between the various ISO-639 language |
| codes, and to map language codes to language names. |
| </p> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a name="gst-plugins-base-libs-gsttaglanguagecodes.functions_details"></a><h2>Functions</h2> |
| <div class="refsect2"> |
| <a name="gst-tag-get-language-codes"></a><h3>gst_tag_get_language_codes ()</h3> |
| <pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-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> |
| <p>Returns a list of known language codes (in form of two-letter ISO-639-1 |
| codes). This is useful for UIs to build a list of available languages for |
| tagging purposes (e.g. to tag an audio track appropriately in a video or |
| audio editor).</p> |
| <div class="refsect3"> |
| <a name="gst-tag-get-language-codes.returns"></a><h4>Returns</h4> |
| <p> NULL-terminated string array with two-letter |
| language codes. Free with <a href="/usr/share/gtk-doc/html/glibglib-String-Utility-Functions.html#g-strfreev"><code class="function">g_strfreev()</code></a> when no longer needed. </p> |
| <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| </div> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="gst-tag-get-language-name"></a><h3>gst_tag_get_language_name ()</h3> |
| <pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * |
| gst_tag_get_language_name (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *language_code</code></em>);</pre> |
| <p>Returns the name of the language given an ISO-639 language code as |
| found in a GST_TAG_LANGUAGE_CODE tag. The name will be translated |
| according to the current locale (if the library was built against the |
| iso-codes package, otherwise the English name will be returned).</p> |
| <p>Language codes are case-sensitive and expected to be lower case.</p> |
| <div class="refsect3"> |
| <a name="gst-tag-get-language-name.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" 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>language_code</p></td> |
| <td class="parameter_description"><p>two or three-letter ISO-639 language code</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="gst-tag-get-language-name.returns"></a><h4>Returns</h4> |
| <p> language name in UTF-8 format, or NULL if <em class="parameter"><code>language_code</code></em> |
| could |
| not be mapped to a language name. The returned string must not be |
| modified and does not need to freed; it will stay valid until the |
| application is terminated.</p> |
| </div> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="gst-tag-get-language-code"></a><h3>gst_tag_get_language_code()</h3> |
| <pre class="programlisting">#define gst_tag_get_language_code(lang_code)</pre> |
| <p>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>.</p> |
| <div class="refsect3"> |
| <a name="gst-tag-get-language-code.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" 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>lang_code</p></td> |
| <td class="parameter_description"><p>ISO-639 language code (e.g. "deu" or "ger" or "de")</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="gst-tag-get-language-code-iso-639-1"></a><h3>gst_tag_get_language_code_iso_639_1 ()</h3> |
| <pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glibglib-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="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *lang_code</code></em>);</pre> |
| <p>Returns two-letter ISO-639-1 language code given a three-letter ISO-639-2 |
| language code or two-letter ISO-639-1 language code (both are accepted for |
| convenience).</p> |
| <p>Language codes are case-sensitive and expected to be lower case.</p> |
| <div class="refsect3"> |
| <a name="gst-tag-get-language-code-iso-639-1.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" 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>lang_code</p></td> |
| <td class="parameter_description"><p>ISO-639 language code (e.g. "deu" or "ger" or "de")</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="gst-tag-get-language-code-iso-639-1.returns"></a><h4>Returns</h4> |
| <p> two-letter ISO-639-1 language code string that maps to <em class="parameter"><code>lang_code</code></em> |
| , |
| or NULL if no mapping is known. The returned string must not be |
| modified or freed.</p> |
| </div> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="gst-tag-get-language-code-iso-639-2B"></a><h3>gst_tag_get_language_code_iso_639_2B ()</h3> |
| <pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * |
| gst_tag_get_language_code_iso_639_2B (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *lang_code</code></em>);</pre> |
| <p>Returns three-letter ISO-639-2 "bibliographic" language code given a |
| two-letter ISO-639-1 language code or a three-letter ISO-639-2 language |
| code (both are accepted for convenience).</p> |
| <p>The "bibliographic" code is derived from the English name of the language |
| (e.g. "ger" for German instead of "de" or "deu"). In most scenarios, the |
| "terminological" codes are prefered.</p> |
| <p>Language codes are case-sensitive and expected to be lower case.</p> |
| <div class="refsect3"> |
| <a name="gst-tag-get-language-code-iso-639-2B.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" 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>lang_code</p></td> |
| <td class="parameter_description"><p>ISO-639 language code (e.g. "deu" or "ger" or "de")</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="gst-tag-get-language-code-iso-639-2B.returns"></a><h4>Returns</h4> |
| <p> three-letter ISO-639-2 language code string that maps to <em class="parameter"><code>lang_code</code></em> |
| , |
| or NULL if no mapping is known. The returned string must not be |
| modified or freed.</p> |
| </div> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="gst-tag-get-language-code-iso-639-2T"></a><h3>gst_tag_get_language_code_iso_639_2T ()</h3> |
| <pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * |
| gst_tag_get_language_code_iso_639_2T (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *lang_code</code></em>);</pre> |
| <p>Returns three-letter ISO-639-2 "terminological" language code given a |
| two-letter ISO-639-1 language code or a three-letter ISO-639-2 language |
| code (both are accepted for convenience).</p> |
| <p>The "terminological" code is derived from the local name of the language |
| (e.g. "deu" for German instead of "ger"). In most scenarios, the |
| "terminological" codes are prefered over the "bibliographic" ones.</p> |
| <p>Language codes are case-sensitive and expected to be lower case.</p> |
| <div class="refsect3"> |
| <a name="gst-tag-get-language-code-iso-639-2T.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" 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>lang_code</p></td> |
| <td class="parameter_description"><p>ISO-639 language code (e.g. "deu" or "ger" or "de")</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="gst-tag-get-language-code-iso-639-2T.returns"></a><h4>Returns</h4> |
| <p> three-letter ISO-639-2 language code string that maps to <em class="parameter"><code>lang_code</code></em> |
| , |
| or NULL if no mapping is known. The returned string must not be |
| modified or freed.</p> |
| </div> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="gst-tag-check-language-code"></a><h3>gst_tag_check_language_code ()</h3> |
| <pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> |
| gst_tag_check_language_code (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *lang_code</code></em>);</pre> |
| <p>Check if a given string contains a known ISO 639 language code.</p> |
| <p>This is useful in situations where it's not clear whether a given |
| string is a language code (which should be put into a <a href="/usr/share/gtk-doc/html/gstreamer-1.0GstTagList.html#GST-TAG-LANGUAGE-CODE:CAPS"><span class="type">GST_TAG_LANGUAGE_CODE</span></a> |
| tag) or a free-form language name descriptor (which should be put into a |
| <a href="/usr/share/gtk-doc/html/gstreamer-1.0GstTagList.html#GST-TAG-LANGUAGE-NAME:CAPS"><span class="type">GST_TAG_LANGUAGE_NAME</span></a> tag instead).</p> |
| <div class="refsect3"> |
| <a name="gst-tag-check-language-code.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" 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>lang_code</p></td> |
| <td class="parameter_description"><p>ISO-639 language code (e.g. "deu" or "ger" or "de")</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="gst-tag-check-language-code.returns"></a><h4>Returns</h4> |
| <p> TRUE if the two- or three-letter language code in <em class="parameter"><code>lang_code</code></em> |
| is a valid ISO-639 language code.</p> |
| </div> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a name="gst-plugins-base-libs-gsttaglanguagecodes.other_details"></a><h2>Types and Values</h2> |
| </div> |
| <div class="refsect1"> |
| <a name="gst-plugins-base-libs-gsttaglanguagecodes.see-also"></a><h2>See Also</h2> |
| <p><a href="/usr/share/gtk-doc/html/gstreamer-1.0GstTagList.html#GstTagList-struct"><span class="type">GstTagList</span></a></p> |
| </div> |
| </div> |
| <div class="footer"> |
| <hr>Generated by GTK-Doc V1.25</div> |
| </body> |
| </html> |