1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>gsttaglicenses</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-gsttaglanguagecodes.html" title="gsttaglanguagecodes">
10 <link rel="next" href="gstreamer-base-utils.html" title="Base Utils Library">
11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
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">
17 <td><a accesskey="p" href="gst-plugins-base-libs-gsttaglanguagecodes.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="gstreamer-base-utils.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#gst-plugins-base-libs-gsttaglicenses.synopsis" class="shortcut">Top</a>
26 <a href="#gst-plugins-base-libs-gsttaglicenses.description" class="shortcut">Description</a>
29 <div class="refentry">
30 <a name="gst-plugins-base-libs-gsttaglicenses"></a><div class="titlepage"></div>
31 <div class="refnamediv"><table width="100%"><tr>
33 <h2><span class="refentrytitle"><a name="gst-plugins-base-libs-gsttaglicenses.top_of_page"></a>gsttaglicenses</span></h2>
34 <p>gsttaglicenses — utility functions for Creative Commons licenses</p>
36 <td valign="top" align="right"></td>
38 <div class="refsynopsisdiv">
39 <a name="gst-plugins-base-libs-gsttaglicenses.synopsis"></a><h2>Synopsis</h2>
40 <pre class="synopsis">
41 #include <gst/tag/tag.h>
43 enum <a class="link" href="gst-plugins-base-libs-gsttaglicenses.html#GstTagLicenseFlags" title="enum GstTagLicenseFlags">GstTagLicenseFlags</a>;
44 <a class="link" href="gst-plugins-base-libs-gsttaglicenses.html#GstTagLicenseFlags" title="enum GstTagLicenseFlags"><span class="returnvalue">GstTagLicenseFlags</span></a> <a class="link" href="gst-plugins-base-libs-gsttaglicenses.html#gst-tag-get-license-flags" title="gst_tag_get_license_flags ()">gst_tag_get_license_flags</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> *license_ref</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-gsttaglicenses.html#gst-tag-get-license-nick" title="gst_tag_get_license_nick ()">gst_tag_get_license_nick</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> *license_ref</code></em>);
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-gsttaglicenses.html#gst-tag-get-license-title" title="gst_tag_get_license_title ()">gst_tag_get_license_title</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> *license_ref</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-gsttaglicenses.html#gst-tag-get-license-description" title="gst_tag_get_license_description ()">gst_tag_get_license_description</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> *license_ref</code></em>);
48 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-gsttaglicenses.html#gst-tag-get-license-jurisdiction" title="gst_tag_get_license_jurisdiction ()">gst_tag_get_license_jurisdiction</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> *license_ref</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-gsttaglicenses.html#gst-tag-get-license-version" title="gst_tag_get_license_version ()">gst_tag_get_license_version</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> *license_ref</code></em>);
50 <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-gsttaglicenses.html#gst-tag-get-licenses" title="gst_tag_get_licenses ()">gst_tag_get_licenses</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
53 <div class="refsect1">
54 <a name="gst-plugins-base-libs-gsttaglicenses.description"></a><h2>Description</h2>
56 Provides information about Creative Commons media licenses, which are
57 often expressed in media files as a license URI in tags. Also useful
58 for applications creating media files, in case the user wants to license
59 the content under a Creative Commons license.
62 <div class="refsect1">
63 <a name="gst-plugins-base-libs-gsttaglicenses.details"></a><h2>Details</h2>
64 <div class="refsect2">
65 <a name="GstTagLicenseFlags"></a><h3>enum GstTagLicenseFlags</h3>
66 <pre class="programlisting">typedef enum {
67 GST_TAG_LICENSE_PERMITS_REPRODUCTION = (1 << 0),
68 GST_TAG_LICENSE_PERMITS_DISTRIBUTION = (1 << 1),
69 GST_TAG_LICENSE_PERMITS_DERIVATIVE_WORKS = (1 << 2),
70 GST_TAG_LICENSE_PERMITS_SHARING = (1 << 3),
72 GST_TAG_LICENSE_REQUIRES_NOTICE = (1 << 8),
73 GST_TAG_LICENSE_REQUIRES_ATTRIBUTION = (1 << 9),
74 GST_TAG_LICENSE_REQUIRES_SHARE_ALIKE = (1 << 10),
75 GST_TAG_LICENSE_REQUIRES_SOURCE_CODE = (1 << 11),
76 GST_TAG_LICENSE_REQUIRES_COPYLEFT = (1 << 12),
77 GST_TAG_LICENSE_REQUIRES_LESSER_COPYLEFT = (1 << 13),
79 GST_TAG_LICENSE_PROHIBITS_COMMERCIAL_USE = (1 << 16),
80 GST_TAG_LICENSE_PROHIBITS_HIGH_INCOME_NATION_USE = (1 << 17),
82 GST_TAG_LICENSE_CREATIVE_COMMONS_LICENSE = (1 << 24),
83 GST_TAG_LICENSE_FREE_SOFTWARE_FOUNDATION_LICENSE = (1 << 25)
87 See http://creativecommons.org/ns for more information.
89 <div class="variablelist"><table border="0">
90 <col align="left" valign="top">
93 <td><p><a name="GST-TAG-LICENSE-PERMITS-REPRODUCTION:CAPS"></a><span class="term"><code class="literal">GST_TAG_LICENSE_PERMITS_REPRODUCTION</code></span></p></td>
94 <td>making multiple copies
99 <td><p><a name="GST-TAG-LICENSE-PERMITS-DISTRIBUTION:CAPS"></a><span class="term"><code class="literal">GST_TAG_LICENSE_PERMITS_DISTRIBUTION</code></span></p></td>
100 <td>distribution, public display
101 and public performance are allowed
105 <td><p><a name="GST-TAG-LICENSE-PERMITS-DERIVATIVE-WORKS:CAPS"></a><span class="term"><code class="literal">GST_TAG_LICENSE_PERMITS_DERIVATIVE_WORKS</code></span></p></td>
106 <td>distribution of derivative
111 <td><p><a name="GST-TAG-LICENSE-PERMITS-SHARING:CAPS"></a><span class="term"><code class="literal">GST_TAG_LICENSE_PERMITS_SHARING</code></span></p></td>
112 <td>commercial derivatives are allowed,
113 but only non-commercial distribution is allowed
117 <td><p><a name="GST-TAG-LICENSE-REQUIRES-NOTICE:CAPS"></a><span class="term"><code class="literal">GST_TAG_LICENSE_REQUIRES_NOTICE</code></span></p></td>
118 <td>copyright and license notices
123 <td><p><a name="GST-TAG-LICENSE-REQUIRES-ATTRIBUTION:CAPS"></a><span class="term"><code class="literal">GST_TAG_LICENSE_REQUIRES_ATTRIBUTION</code></span></p></td>
124 <td>credit must be given to
125 copyright holder and/or author
129 <td><p><a name="GST-TAG-LICENSE-REQUIRES-SHARE-ALIKE:CAPS"></a><span class="term"><code class="literal">GST_TAG_LICENSE_REQUIRES_SHARE_ALIKE</code></span></p></td>
130 <td>derivative works must be
131 licensed under the same terms or compatible terms as the original work
135 <td><p><a name="GST-TAG-LICENSE-REQUIRES-SOURCE-CODE:CAPS"></a><span class="term"><code class="literal">GST_TAG_LICENSE_REQUIRES_SOURCE_CODE</code></span></p></td>
136 <td>source code (the preferred
137 form for making modifications) must be provided when exercising some
138 rights granted by the license
142 <td><p><a name="GST-TAG-LICENSE-REQUIRES-COPYLEFT:CAPS"></a><span class="term"><code class="literal">GST_TAG_LICENSE_REQUIRES_COPYLEFT</code></span></p></td>
143 <td>derivative and combined works
144 must be licensed under specified terms, similar to those of the original
149 <td><p><a name="GST-TAG-LICENSE-REQUIRES-LESSER-COPYLEFT:CAPS"></a><span class="term"><code class="literal">GST_TAG_LICENSE_REQUIRES_LESSER_COPYLEFT</code></span></p></td>
150 <td>derivative works must be
151 licensed under specified terms, with at least the same conditions as
152 the original work; combinations with the work may be licensed under
157 <td><p><a name="GST-TAG-LICENSE-PROHIBITS-COMMERCIAL-USE:CAPS"></a><span class="term"><code class="literal">GST_TAG_LICENSE_PROHIBITS_COMMERCIAL_USE</code></span></p></td>
158 <td>exercising rights for
159 commercial purposes is prohibited
163 <td><p><a name="GST-TAG-LICENSE-PROHIBITS-HIGH-INCOME-NATION-USE:CAPS"></a><span class="term"><code class="literal">GST_TAG_LICENSE_PROHIBITS_HIGH_INCOME_NATION_USE</code></span></p></td>
165 non-developing country is prohibited
169 <td><p><a name="GST-TAG-LICENSE-CREATIVE-COMMONS-LICENSE:CAPS"></a><span class="term"><code class="literal">GST_TAG_LICENSE_CREATIVE_COMMONS_LICENSE</code></span></p></td>
170 <td>this license was created
171 by the Creative Commons project
175 <td><p><a name="GST-TAG-LICENSE-FREE-SOFTWARE-FOUNDATION-LICENSE:CAPS"></a><span class="term"><code class="literal">GST_TAG_LICENSE_FREE_SOFTWARE_FOUNDATION_LICENSE</code></span></p></td>
177 created by the Free Software Foundation (FSF)
182 <p class="since">Since 0.10.36</p>
185 <div class="refsect2">
186 <a name="gst-tag-get-license-flags"></a><h3>gst_tag_get_license_flags ()</h3>
187 <pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gsttaglicenses.html#GstTagLicenseFlags" title="enum GstTagLicenseFlags"><span class="returnvalue">GstTagLicenseFlags</span></a> gst_tag_get_license_flags (<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> *license_ref</code></em>);</pre>
189 Get the flags of a license, which describe most of the features of
190 a license in their most general form.
192 <div class="variablelist"><table border="0">
193 <col align="left" valign="top">
196 <td><p><span class="term"><em class="parameter"><code>license_ref</code></em> :</span></p></td>
197 <td>a license reference string in form of a URI,
198 e.g. "http://creativecommons.org/licenses/by-nc-nd/2.0/"</td>
201 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
202 <td>the flags of the license, or 0 if the license is unknown</td>
206 <p class="since">Since 0.10.36</p>
209 <div class="refsect2">
210 <a name="gst-tag-get-license-nick"></a><h3>gst_tag_get_license_nick ()</h3>
211 <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_license_nick (<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> *license_ref</code></em>);</pre>
213 Get the nick name of a license, which is a short (untranslated) string
214 such as e.g. "CC BY-NC-ND 2.0 UK".
216 <div class="variablelist"><table border="0">
217 <col align="left" valign="top">
220 <td><p><span class="term"><em class="parameter"><code>license_ref</code></em> :</span></p></td>
221 <td>a license reference string in form of a URI,
222 e.g. "http://creativecommons.org/licenses/by-nc-nd/2.0/"</td>
225 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
226 <td>the nick name of the license, or NULL if the license is unknown</td>
230 <p class="since">Since 0.10.36</p>
233 <div class="refsect2">
234 <a name="gst-tag-get-license-title"></a><h3>gst_tag_get_license_title ()</h3>
235 <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_license_title (<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> *license_ref</code></em>);</pre>
237 Get the title of a license, which is a short translated description
238 of the license's features (generally not very pretty though).
240 <div class="variablelist"><table border="0">
241 <col align="left" valign="top">
244 <td><p><span class="term"><em class="parameter"><code>license_ref</code></em> :</span></p></td>
245 <td>a license reference string in form of a URI,
246 e.g. "http://creativecommons.org/licenses/by-nc-nd/2.0/"</td>
249 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
250 <td>the title of the license, or NULL if the license is unknown or
251 no title is available.</td>
255 <p class="since">Since 0.10.36</p>
258 <div class="refsect2">
259 <a name="gst-tag-get-license-description"></a><h3>gst_tag_get_license_description ()</h3>
260 <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_license_description (<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> *license_ref</code></em>);</pre>
262 Get the description of a license, which is a translated description
263 of the license's main features.
265 <div class="variablelist"><table border="0">
266 <col align="left" valign="top">
269 <td><p><span class="term"><em class="parameter"><code>license_ref</code></em> :</span></p></td>
270 <td>a license reference string in form of a URI,
271 e.g. "http://creativecommons.org/licenses/by-nc-nd/2.0/"</td>
274 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
275 <td>the description of the license, or NULL if the license is unknown
276 or a description is not available.</td>
280 <p class="since">Since 0.10.36</p>
283 <div class="refsect2">
284 <a name="gst-tag-get-license-jurisdiction"></a><h3>gst_tag_get_license_jurisdiction ()</h3>
285 <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_license_jurisdiction (<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> *license_ref</code></em>);</pre>
287 Get the jurisdiction code of a license. This is usually a two-letter
288 ISO 3166-1 alpha-2 code, but there is also the special case of Scotland,
289 for which no code exists and which is thus represented as "scotland".
292 Known jurisdictions: ar, at, au, be, bg, br, ca, ch, cl, cn, co, de,
293 dk, es, fi, fr, hr, hu, il, in, it, jp, kr, mk, mt, mx, my, nl, pe, pl,
294 pt, scotland, se, si, tw, uk, us, za.
296 <div class="variablelist"><table border="0">
297 <col align="left" valign="top">
300 <td><p><span class="term"><em class="parameter"><code>license_ref</code></em> :</span></p></td>
301 <td>a license reference string in form of a URI,
302 e.g. "http://creativecommons.org/licenses/by-nc-nd/2.0/"</td>
305 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
306 <td>the jurisdiction code of the license, or NULL if the license is
307 unknown or is not specific to a particular jurisdiction.</td>
311 <p class="since">Since 0.10.36</p>
314 <div class="refsect2">
315 <a name="gst-tag-get-license-version"></a><h3>gst_tag_get_license_version ()</h3>
316 <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_license_version (<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> *license_ref</code></em>);</pre>
318 Get the version of a license.
320 <div class="variablelist"><table border="0">
321 <col align="left" valign="top">
324 <td><p><span class="term"><em class="parameter"><code>license_ref</code></em> :</span></p></td>
325 <td>a license reference string in form of a URI,
326 e.g. "http://creativecommons.org/licenses/by-nc-nd/2.0/"</td>
329 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
330 <td>the version of the license, or NULL if the license is not known or
335 <p class="since">Since 0.10.36</p>
338 <div class="refsect2">
339 <a name="gst-tag-get-licenses"></a><h3>gst_tag_get_licenses ()</h3>
340 <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_licenses (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
342 Returns a list of known license references (in form of URIs). This is
343 useful for UIs to build a list of available licenses for tagging purposes
344 (e.g. to tag an audio track appropriately in a video or audio editor, or
345 an image in a camera application).
347 <div class="variablelist"><table border="0">
348 <col align="left" valign="top">
350 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
351 <td>NULL-terminated array of license strings. Free with <a href="http://library.gnome.org/devel/glib/unstable/glib-String-Utility-Functions.html#g-strfreev"><code class="function">g_strfreev()</code></a>
352 when no longer needed.</td>
355 <p class="since">Since 0.10.36</p>
358 <div class="refsect1">
359 <a name="gst-plugins-base-libs-gsttaglicenses.see-also"></a><h2>See Also</h2>
360 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="type">GstTagList</span></a>
365 Generated by GTK-Doc V1.18</div>