33
30
<h2><span class="refentrytitle"><a name="gst-plugins-base-libs-gsttag.top_of_page"></a>gsttag</span></h2>
34
31
<p>gsttag — additional tag definitions for plugins and applications</p>
36
<td valign="top" align="right"></td>
33
<td class="gallery_image" valign="top" align="right"></td>
37
34
</tr></table></div>
38
<div class="refsynopsisdiv">
39
<a name="gst-plugins-base-libs-gsttag.synopsis"></a><h2>Synopsis</h2>
40
<pre class="synopsis">
41
#include <gst/tag/tag.h>
43
#define <a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-MUSICBRAINZ-TRACKID:CAPS" title="GST_TAG_MUSICBRAINZ_TRACKID">GST_TAG_MUSICBRAINZ_TRACKID</a>
44
#define <a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-MUSICBRAINZ-ARTISTID:CAPS" title="GST_TAG_MUSICBRAINZ_ARTISTID">GST_TAG_MUSICBRAINZ_ARTISTID</a>
45
#define <a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-MUSICBRAINZ-ALBUMID:CAPS" title="GST_TAG_MUSICBRAINZ_ALBUMID">GST_TAG_MUSICBRAINZ_ALBUMID</a>
46
#define <a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-MUSICBRAINZ-ALBUMARTISTID:CAPS" title="GST_TAG_MUSICBRAINZ_ALBUMARTISTID">GST_TAG_MUSICBRAINZ_ALBUMARTISTID</a>
47
#define <a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-MUSICBRAINZ-TRMID:CAPS" title="GST_TAG_MUSICBRAINZ_TRMID">GST_TAG_MUSICBRAINZ_TRMID</a>
48
#define <a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CDDA-CDDB-DISCID:CAPS" title="GST_TAG_CDDA_CDDB_DISCID">GST_TAG_CDDA_CDDB_DISCID</a>
49
#define <a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CDDA-CDDB-DISCID-FULL:CAPS" title="GST_TAG_CDDA_CDDB_DISCID_FULL">GST_TAG_CDDA_CDDB_DISCID_FULL</a>
50
#define <a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CDDA-MUSICBRAINZ-DISCID:CAPS" title="GST_TAG_CDDA_MUSICBRAINZ_DISCID">GST_TAG_CDDA_MUSICBRAINZ_DISCID</a>
51
#define <a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CDDA-MUSICBRAINZ-DISCID-FULL:CAPS" title="GST_TAG_CDDA_MUSICBRAINZ_DISCID_FULL">GST_TAG_CDDA_MUSICBRAINZ_DISCID_FULL</a>
52
#define <a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CMML-CLIP:CAPS" title="GST_TAG_CMML_CLIP">GST_TAG_CMML_CLIP</a>
53
#define <a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CMML-HEAD:CAPS" title="GST_TAG_CMML_HEAD">GST_TAG_CMML_HEAD</a>
54
#define <a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CMML-STREAM:CAPS" title="GST_TAG_CMML_STREAM">GST_TAG_CMML_STREAM</a>
55
#define <a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CAPTURING-SHUTTER-SPEED:CAPS" title="GST_TAG_CAPTURING_SHUTTER_SPEED">GST_TAG_CAPTURING_SHUTTER_SPEED</a>
56
#define <a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CAPTURING-FOCAL-RATIO:CAPS" title="GST_TAG_CAPTURING_FOCAL_RATIO">GST_TAG_CAPTURING_FOCAL_RATIO</a>
57
#define <a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CAPTURING-FOCAL-LENGTH:CAPS" title="GST_TAG_CAPTURING_FOCAL_LENGTH">GST_TAG_CAPTURING_FOCAL_LENGTH</a>
58
#define <a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CAPTURING-DIGITAL-ZOOM-RATIO:CAPS" title="GST_TAG_CAPTURING_DIGITAL_ZOOM_RATIO">GST_TAG_CAPTURING_DIGITAL_ZOOM_RATIO</a>
59
#define <a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CAPTURING-ISO-SPEED:CAPS" title="GST_TAG_CAPTURING_ISO_SPEED">GST_TAG_CAPTURING_ISO_SPEED</a>
60
#define <a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CAPTURING-EXPOSURE-PROGRAM:CAPS" title="GST_TAG_CAPTURING_EXPOSURE_PROGRAM">GST_TAG_CAPTURING_EXPOSURE_PROGRAM</a>
61
#define <a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CAPTURING-EXPOSURE-MODE:CAPS" title="GST_TAG_CAPTURING_EXPOSURE_MODE">GST_TAG_CAPTURING_EXPOSURE_MODE</a>
62
#define <a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CAPTURING-SCENE-CAPTURE-TYPE:CAPS" title="GST_TAG_CAPTURING_SCENE_CAPTURE_TYPE">GST_TAG_CAPTURING_SCENE_CAPTURE_TYPE</a>
63
#define <a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CAPTURING-GAIN-ADJUSTMENT:CAPS" title="GST_TAG_CAPTURING_GAIN_ADJUSTMENT">GST_TAG_CAPTURING_GAIN_ADJUSTMENT</a>
64
#define <a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CAPTURING-WHITE-BALANCE:CAPS" title="GST_TAG_CAPTURING_WHITE_BALANCE">GST_TAG_CAPTURING_WHITE_BALANCE</a>
65
#define <a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CAPTURING-CONTRAST:CAPS" title="GST_TAG_CAPTURING_CONTRAST">GST_TAG_CAPTURING_CONTRAST</a>
66
#define <a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CAPTURING-SATURATION:CAPS" title="GST_TAG_CAPTURING_SATURATION">GST_TAG_CAPTURING_SATURATION</a>
67
#define <a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CAPTURING-SHARPNESS:CAPS" title="GST_TAG_CAPTURING_SHARPNESS">GST_TAG_CAPTURING_SHARPNESS</a>
68
#define <a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CAPTURING-FLASH-FIRED:CAPS" title="GST_TAG_CAPTURING_FLASH_FIRED">GST_TAG_CAPTURING_FLASH_FIRED</a>
69
#define <a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CAPTURING-FLASH-MODE:CAPS" title="GST_TAG_CAPTURING_FLASH_MODE">GST_TAG_CAPTURING_FLASH_MODE</a>
70
#define <a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CAPTURING-METERING-MODE:CAPS" title="GST_TAG_CAPTURING_METERING_MODE">GST_TAG_CAPTURING_METERING_MODE</a>
71
#define <a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CAPTURING-SOURCE:CAPS" title="GST_TAG_CAPTURING_SOURCE">GST_TAG_CAPTURING_SOURCE</a>
72
#define <a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CAPTURING-EXPOSURE-COMPENSATION:CAPS" title="GST_TAG_CAPTURING_EXPOSURE_COMPENSATION">GST_TAG_CAPTURING_EXPOSURE_COMPENSATION</a>
73
#define <a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-IMAGE-HORIZONTAL-PPI:CAPS" title="GST_TAG_IMAGE_HORIZONTAL_PPI">GST_TAG_IMAGE_HORIZONTAL_PPI</a>
74
#define <a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-IMAGE-VERTICAL-PPI:CAPS" title="GST_TAG_IMAGE_VERTICAL_PPI">GST_TAG_IMAGE_VERTICAL_PPI</a>
75
#define <a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-ID3V2-HEADER-SIZE:CAPS" title="GST_TAG_ID3V2_HEADER_SIZE">GST_TAG_ID3V2_HEADER_SIZE</a>
76
<span class="returnvalue">void</span> <a class="link" href="gst-plugins-base-libs-gsttag.html#gst-tag-register-musicbrainz-tags" title="gst_tag_register_musicbrainz_tags ()">gst_tag_register_musicbrainz_tags</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
77
<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-gsttag.html#gst-tag-freeform-string-to-utf8" title="gst_tag_freeform_string_to_utf8 ()">gst_tag_freeform_string_to_utf8</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> *data</code></em>,
78
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> size</code></em>,
79
<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> **env_vars</code></em>);
80
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gst-plugins-base-libs-gsttag.html#gst-tag-parse-extended-comment" title="gst_tag_parse_extended_comment ()">gst_tag_parse_extended_comment</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> *ext_comment</code></em>,
81
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **key</code></em>,
82
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **lang</code></em>,
83
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **value</code></em>,
84
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> fail_if_no_key</code></em>);
85
enum <a class="link" href="gst-plugins-base-libs-gsttag.html#GstTagImageType" title="enum GstTagImageType">GstTagImageType</a>;
35
<div class="refsect1">
36
<a name="gst-plugins-base-libs-gsttag.functions"></a><h2>Functions</h2>
37
<div class="informaltable"><table width="100%" border="0">
39
<col width="150px" class="functions_return">
40
<col class="functions_name">
44
<td class="function_type">
45
<span class="returnvalue">void</span>
47
<td class="function_name">
48
<a class="link" href="gst-plugins-base-libs-gsttag.html#gst-tag-register-musicbrainz-tags" title="gst_tag_register_musicbrainz_tags ()">gst_tag_register_musicbrainz_tags</a> <span class="c_punctuation">()</span>
52
<td class="function_type">
53
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
55
<td class="function_name">
56
<a class="link" href="gst-plugins-base-libs-gsttag.html#gst-tag-freeform-string-to-utf8" title="gst_tag_freeform_string_to_utf8 ()">gst_tag_freeform_string_to_utf8</a> <span class="c_punctuation">()</span>
60
<td class="function_type">
61
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
63
<td class="function_name">
64
<a class="link" href="gst-plugins-base-libs-gsttag.html#gst-tag-parse-extended-comment" title="gst_tag_parse_extended_comment ()">gst_tag_parse_extended_comment</a> <span class="c_punctuation">()</span>
70
<div class="refsect1">
71
<a name="gst-plugins-base-libs-gsttag.other"></a><h2>Types and Values</h2>
72
<div class="informaltable"><table width="100%" border="0">
74
<col width="150px" class="name">
75
<col class="description">
79
<td class="define_keyword">#define</td>
80
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-MUSICBRAINZ-TRACKID:CAPS" title="GST_TAG_MUSICBRAINZ_TRACKID">GST_TAG_MUSICBRAINZ_TRACKID</a></td>
83
<td class="define_keyword">#define</td>
84
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-MUSICBRAINZ-ARTISTID:CAPS" title="GST_TAG_MUSICBRAINZ_ARTISTID">GST_TAG_MUSICBRAINZ_ARTISTID</a></td>
87
<td class="define_keyword">#define</td>
88
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-MUSICBRAINZ-ALBUMID:CAPS" title="GST_TAG_MUSICBRAINZ_ALBUMID">GST_TAG_MUSICBRAINZ_ALBUMID</a></td>
91
<td class="define_keyword">#define</td>
92
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-MUSICBRAINZ-ALBUMARTISTID:CAPS" title="GST_TAG_MUSICBRAINZ_ALBUMARTISTID">GST_TAG_MUSICBRAINZ_ALBUMARTISTID</a></td>
95
<td class="define_keyword">#define</td>
96
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-MUSICBRAINZ-TRMID:CAPS" title="GST_TAG_MUSICBRAINZ_TRMID">GST_TAG_MUSICBRAINZ_TRMID</a></td>
99
<td class="define_keyword">#define</td>
100
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CDDA-CDDB-DISCID:CAPS" title="GST_TAG_CDDA_CDDB_DISCID">GST_TAG_CDDA_CDDB_DISCID</a></td>
103
<td class="define_keyword">#define</td>
104
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CDDA-CDDB-DISCID-FULL:CAPS" title="GST_TAG_CDDA_CDDB_DISCID_FULL">GST_TAG_CDDA_CDDB_DISCID_FULL</a></td>
107
<td class="define_keyword">#define</td>
108
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CDDA-MUSICBRAINZ-DISCID:CAPS" title="GST_TAG_CDDA_MUSICBRAINZ_DISCID">GST_TAG_CDDA_MUSICBRAINZ_DISCID</a></td>
111
<td class="define_keyword">#define</td>
112
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CDDA-MUSICBRAINZ-DISCID-FULL:CAPS" title="GST_TAG_CDDA_MUSICBRAINZ_DISCID_FULL">GST_TAG_CDDA_MUSICBRAINZ_DISCID_FULL</a></td>
115
<td class="define_keyword">#define</td>
116
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CMML-CLIP:CAPS" title="GST_TAG_CMML_CLIP">GST_TAG_CMML_CLIP</a></td>
119
<td class="define_keyword">#define</td>
120
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CMML-HEAD:CAPS" title="GST_TAG_CMML_HEAD">GST_TAG_CMML_HEAD</a></td>
123
<td class="define_keyword">#define</td>
124
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CMML-STREAM:CAPS" title="GST_TAG_CMML_STREAM">GST_TAG_CMML_STREAM</a></td>
127
<td class="define_keyword">#define</td>
128
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CAPTURING-SHUTTER-SPEED:CAPS" title="GST_TAG_CAPTURING_SHUTTER_SPEED">GST_TAG_CAPTURING_SHUTTER_SPEED</a></td>
131
<td class="define_keyword">#define</td>
132
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CAPTURING-FOCAL-RATIO:CAPS" title="GST_TAG_CAPTURING_FOCAL_RATIO">GST_TAG_CAPTURING_FOCAL_RATIO</a></td>
135
<td class="define_keyword">#define</td>
136
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CAPTURING-FOCAL-LENGTH:CAPS" title="GST_TAG_CAPTURING_FOCAL_LENGTH">GST_TAG_CAPTURING_FOCAL_LENGTH</a></td>
139
<td class="define_keyword">#define</td>
140
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CAPTURING-DIGITAL-ZOOM-RATIO:CAPS" title="GST_TAG_CAPTURING_DIGITAL_ZOOM_RATIO">GST_TAG_CAPTURING_DIGITAL_ZOOM_RATIO</a></td>
143
<td class="define_keyword">#define</td>
144
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CAPTURING-ISO-SPEED:CAPS" title="GST_TAG_CAPTURING_ISO_SPEED">GST_TAG_CAPTURING_ISO_SPEED</a></td>
147
<td class="define_keyword">#define</td>
148
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CAPTURING-EXPOSURE-PROGRAM:CAPS" title="GST_TAG_CAPTURING_EXPOSURE_PROGRAM">GST_TAG_CAPTURING_EXPOSURE_PROGRAM</a></td>
151
<td class="define_keyword">#define</td>
152
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CAPTURING-EXPOSURE-MODE:CAPS" title="GST_TAG_CAPTURING_EXPOSURE_MODE">GST_TAG_CAPTURING_EXPOSURE_MODE</a></td>
155
<td class="define_keyword">#define</td>
156
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CAPTURING-SCENE-CAPTURE-TYPE:CAPS" title="GST_TAG_CAPTURING_SCENE_CAPTURE_TYPE">GST_TAG_CAPTURING_SCENE_CAPTURE_TYPE</a></td>
159
<td class="define_keyword">#define</td>
160
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CAPTURING-GAIN-ADJUSTMENT:CAPS" title="GST_TAG_CAPTURING_GAIN_ADJUSTMENT">GST_TAG_CAPTURING_GAIN_ADJUSTMENT</a></td>
163
<td class="define_keyword">#define</td>
164
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CAPTURING-WHITE-BALANCE:CAPS" title="GST_TAG_CAPTURING_WHITE_BALANCE">GST_TAG_CAPTURING_WHITE_BALANCE</a></td>
167
<td class="define_keyword">#define</td>
168
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CAPTURING-CONTRAST:CAPS" title="GST_TAG_CAPTURING_CONTRAST">GST_TAG_CAPTURING_CONTRAST</a></td>
171
<td class="define_keyword">#define</td>
172
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CAPTURING-SATURATION:CAPS" title="GST_TAG_CAPTURING_SATURATION">GST_TAG_CAPTURING_SATURATION</a></td>
175
<td class="define_keyword">#define</td>
176
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CAPTURING-SHARPNESS:CAPS" title="GST_TAG_CAPTURING_SHARPNESS">GST_TAG_CAPTURING_SHARPNESS</a></td>
179
<td class="define_keyword">#define</td>
180
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CAPTURING-FLASH-FIRED:CAPS" title="GST_TAG_CAPTURING_FLASH_FIRED">GST_TAG_CAPTURING_FLASH_FIRED</a></td>
183
<td class="define_keyword">#define</td>
184
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CAPTURING-FLASH-MODE:CAPS" title="GST_TAG_CAPTURING_FLASH_MODE">GST_TAG_CAPTURING_FLASH_MODE</a></td>
187
<td class="define_keyword">#define</td>
188
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CAPTURING-METERING-MODE:CAPS" title="GST_TAG_CAPTURING_METERING_MODE">GST_TAG_CAPTURING_METERING_MODE</a></td>
191
<td class="define_keyword">#define</td>
192
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CAPTURING-SOURCE:CAPS" title="GST_TAG_CAPTURING_SOURCE">GST_TAG_CAPTURING_SOURCE</a></td>
195
<td class="define_keyword">#define</td>
196
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-CAPTURING-EXPOSURE-COMPENSATION:CAPS" title="GST_TAG_CAPTURING_EXPOSURE_COMPENSATION">GST_TAG_CAPTURING_EXPOSURE_COMPENSATION</a></td>
199
<td class="define_keyword">#define</td>
200
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-IMAGE-HORIZONTAL-PPI:CAPS" title="GST_TAG_IMAGE_HORIZONTAL_PPI">GST_TAG_IMAGE_HORIZONTAL_PPI</a></td>
203
<td class="define_keyword">#define</td>
204
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-IMAGE-VERTICAL-PPI:CAPS" title="GST_TAG_IMAGE_VERTICAL_PPI">GST_TAG_IMAGE_VERTICAL_PPI</a></td>
207
<td class="define_keyword">#define</td>
208
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gsttag.html#GST-TAG-ID3V2-HEADER-SIZE:CAPS" title="GST_TAG_ID3V2_HEADER_SIZE">GST_TAG_ID3V2_HEADER_SIZE</a></td>
211
<td class="datatype_keyword">enum</td>
212
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gsttag.html#GstTagImageType" title="enum GstTagImageType">GstTagImageType</a></td>
217
<div class="refsect1">
218
<a name="gst-plugins-base-libs-gsttag.object-hierarchy"></a><h2>Object Hierarchy</h2>
222
<div class="refsect1">
223
<a name="gst-plugins-base-libs-gsttag.includes"></a><h2>Includes</h2>
224
<pre class="synopsis">#include <gst/tag/tag.h>
88
227
<div class="refsect1">
89
228
<a name="gst-plugins-base-libs-gsttag.description"></a><h2>Description</h2>
92
229
<div class="refsect2">
93
<a name="id-1.2.12.3.4.2.1"></a><p>
230
<a name="id-1.2.12.3.7.2"></a><p>
94
231
Contains additional standardized GStreamer tag definitions for plugins
95
232
and applications, and functions to register them with the GStreamer
102
<div class="refsect1">
103
<a name="gst-plugins-base-libs-gsttag.details"></a><h2>Details</h2>
237
<div class="refsect1">
238
<a name="gst-plugins-base-libs-gsttag.functions_details"></a><h2>Functions</h2>
239
<div class="refsect2">
240
<a name="gst-tag-register-musicbrainz-tags"></a><h3>gst_tag_register_musicbrainz_tags ()</h3>
241
<pre class="programlisting"><span class="returnvalue">void</span>
242
gst_tag_register_musicbrainz_tags (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
243
<p>Registers additional musicbrainz-specific tags with the GStreamer tag
244
system. Plugins and applications that use these tags should call this
245
function before using them. Can be called multiple times.</p>
248
<div class="refsect2">
249
<a name="gst-tag-freeform-string-to-utf8"></a><h3>gst_tag_freeform_string_to_utf8 ()</h3>
250
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
251
gst_tag_freeform_string_to_utf8 (<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> *data</code></em>,
252
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> size</code></em>,
253
<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> **env_vars</code></em>);</pre>
254
<p>Convenience function to read a string with unknown character encoding. If
255
the string is already in UTF-8 encoding, it will be returned right away.
256
If not it tries to detect byte-order-mark for UTF-16/32 cases and use that.
257
Otherwise, the environment will be searched for a number of environment
258
variables (whose names are specified in the NULL-terminated string array
259
<em class="parameter"><code>env_vars</code></em>
260
) containing a list of character encodings to try/use. If none
261
are specified, the current locale will be tried. If that also doesn't work,
262
WINDOWS-1252/ISO-8859-1 is assumed (which will almost always succeed).</p>
263
<div class="refsect3">
264
<a name="id-1.2.12.3.8.3.5"></a><h4>Parameters</h4>
265
<div class="informaltable"><table width="100%" border="0">
267
<col width="150px" class="parameters_name">
268
<col class="parameters_description">
269
<col width="200px" class="parameters_annotations">
273
<td class="parameter_name"><p>data</p></td>
274
<td class="parameter_description"><p>string data</p></td>
275
<td class="parameter_annotations"> </td>
278
<td class="parameter_name"><p>size</p></td>
279
<td class="parameter_description"><p>length of string data, or -1 if the string is NUL-terminated</p></td>
280
<td class="parameter_annotations"> </td>
283
<td class="parameter_name"><p>env_vars</p></td>
284
<td class="parameter_description"><p>a NULL-terminated string array of environment variable names,
286
<td class="parameter_annotations"> </td>
291
<div class="refsect3">
292
<a name="id-1.2.12.3.8.3.6"></a><h4>Returns</h4>
293
<p> a newly-allocated string in UTF-8 encoding, or NULL</p>
298
<div class="refsect2">
299
<a name="gst-tag-parse-extended-comment"></a><h3>gst_tag_parse_extended_comment ()</h3>
300
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
301
gst_tag_parse_extended_comment (<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> *ext_comment</code></em>,
302
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **key</code></em>,
303
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **lang</code></em>,
304
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **value</code></em>,
305
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> fail_if_no_key</code></em>);</pre>
306
<p>Convenience function to parse a GST_TAG_EXTENDED_COMMENT string and
307
separate it into its components.</p>
308
<p>If successful, <em class="parameter"><code>key</code></em>
309
, <em class="parameter"><code>lang</code></em>
310
and/or <em class="parameter"><code>value</code></em>
311
will be set to newly allocated
312
strings that you need to free with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when done. <em class="parameter"><code>key</code></em>
313
and <em class="parameter"><code>lang</code></em>
315
may also be set to NULL by this function if there is no key or no language
316
code in the extended comment string.</p>
317
<div class="refsect3">
318
<a name="id-1.2.12.3.8.4.6"></a><h4>Parameters</h4>
319
<div class="informaltable"><table width="100%" border="0">
321
<col width="150px" class="parameters_name">
322
<col class="parameters_description">
323
<col width="200px" class="parameters_annotations">
327
<td class="parameter_name"><p>ext_comment</p></td>
328
<td class="parameter_description"><p>an extended comment string, see <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></p></td>
329
<td class="parameter_annotations"> </td>
332
<td class="parameter_name"><p>key</p></td>
333
<td class="parameter_description"><p>return location for the comment description key, or NULL</p></td>
334
<td class="parameter_annotations"> </td>
337
<td class="parameter_name"><p>lang</p></td>
338
<td class="parameter_description"><p>return location for the comment ISO-639 language code, or NULL</p></td>
339
<td class="parameter_annotations"> </td>
342
<td class="parameter_name"><p>value</p></td>
343
<td class="parameter_description"><p>return location for the actual comment string, or NULL</p></td>
344
<td class="parameter_annotations"> </td>
347
<td class="parameter_name"><p>fail_if_no_key</p></td>
348
<td class="parameter_description"><p>whether to fail if strings are not in key=value form</p></td>
349
<td class="parameter_annotations"> </td>
354
<div class="refsect3">
355
<a name="id-1.2.12.3.8.4.7"></a><h4>Returns</h4>
356
<p> TRUE if the string could be parsed, otherwise FALSE</p>
361
<div class="refsect1">
362
<a name="gst-plugins-base-libs-gsttag.other_details"></a><h2>Types and Values</h2>
104
363
<div class="refsect2">
105
364
<a name="GST-TAG-MUSICBRAINZ-TRACKID:CAPS"></a><h3>GST_TAG_MUSICBRAINZ_TRACKID</h3>
106
365
<pre class="programlisting">#define GST_TAG_MUSICBRAINZ_TRACKID "musicbrainz-trackid"
367
<p>MusicBrainz track ID</p>
113
370
<div class="refsect2">
114
371
<a name="GST-TAG-MUSICBRAINZ-ARTISTID:CAPS"></a><h3>GST_TAG_MUSICBRAINZ_ARTISTID</h3>
115
372
<pre class="programlisting">#define GST_TAG_MUSICBRAINZ_ARTISTID "musicbrainz-artistid"
118
MusicBrainz artist ID
374
<p>MusicBrainz artist ID</p>
122
377
<div class="refsect2">
123
378
<a name="GST-TAG-MUSICBRAINZ-ALBUMID:CAPS"></a><h3>GST_TAG_MUSICBRAINZ_ALBUMID</h3>
124
379
<pre class="programlisting">#define GST_TAG_MUSICBRAINZ_ALBUMID "musicbrainz-albumid"
381
<p>MusicBrainz album ID</p>
131
384
<div class="refsect2">
132
385
<a name="GST-TAG-MUSICBRAINZ-ALBUMARTISTID:CAPS"></a><h3>GST_TAG_MUSICBRAINZ_ALBUMARTISTID</h3>
133
386
<pre class="programlisting">#define GST_TAG_MUSICBRAINZ_ALBUMARTISTID "musicbrainz-albumartistid"
136
MusicBrainz album artist ID
388
<p>MusicBrainz album artist ID</p>
140
391
<div class="refsect2">
141
392
<a name="GST-TAG-MUSICBRAINZ-TRMID:CAPS"></a><h3>GST_TAG_MUSICBRAINZ_TRMID</h3>
142
393
<pre class="programlisting">#define GST_TAG_MUSICBRAINZ_TRMID "musicbrainz-trmid"
145
MusicBrainz track TRM ID
395
<p>MusicBrainz track TRM ID</p>
149
398
<div class="refsect2">
150
399
<a name="GST-TAG-CDDA-CDDB-DISCID:CAPS"></a><h3>GST_TAG_CDDA_CDDB_DISCID</h3>
151
400
<pre class="programlisting">#define GST_TAG_CDDA_CDDB_DISCID "discid"
154
CDDB disc id in its short form (e.g. 'aa063d0f')
402
<p>CDDB disc id in its short form (e.g. 'aa063d0f')</p>
158
405
<div class="refsect2">
159
406
<a name="GST-TAG-CDDA-CDDB-DISCID-FULL:CAPS"></a><h3>GST_TAG_CDDA_CDDB_DISCID_FULL</h3>
160
407
<pre class="programlisting">#define GST_TAG_CDDA_CDDB_DISCID_FULL "discid-full"
163
CDDB disc id including all details
409
<p>CDDB disc id including all details</p>
167
412
<div class="refsect2">
168
413
<a name="GST-TAG-CDDA-MUSICBRAINZ-DISCID:CAPS"></a><h3>GST_TAG_CDDA_MUSICBRAINZ_DISCID</h3>
169
414
<pre class="programlisting">#define GST_TAG_CDDA_MUSICBRAINZ_DISCID "musicbrainz-discid"
172
Musicbrainz disc id (e.g. 'ahg7JUcfR3vCYBphSDIogOOWrr0-')
416
<p>Musicbrainz disc id (e.g. 'ahg7JUcfR3vCYBphSDIogOOWrr0-')</p>
176
419
<div class="refsect2">
177
420
<a name="GST-TAG-CDDA-MUSICBRAINZ-DISCID-FULL:CAPS"></a><h3>GST_TAG_CDDA_MUSICBRAINZ_DISCID_FULL</h3>
178
421
<pre class="programlisting">#define GST_TAG_CDDA_MUSICBRAINZ_DISCID_FULL "musicbrainz-discid-full"
181
Musicbrainz disc id details
423
<p>Musicbrainz disc id details</p>
185
426
<div class="refsect2">
186
427
<a name="GST-TAG-CMML-CLIP:CAPS"></a><h3>GST_TAG_CMML_CLIP</h3>
187
428
<pre class="programlisting">#define GST_TAG_CMML_CLIP "cmml-clip"
190
Annodex CMML clip element tag
430
<p>Annodex CMML clip element tag</p>
194
433
<div class="refsect2">
195
434
<a name="GST-TAG-CMML-HEAD:CAPS"></a><h3>GST_TAG_CMML_HEAD</h3>
196
435
<pre class="programlisting">#define GST_TAG_CMML_HEAD "cmml-head"
199
Annodex CMML head element tag
437
<p>Annodex CMML head element tag</p>
203
440
<div class="refsect2">
204
441
<a name="GST-TAG-CMML-STREAM:CAPS"></a><h3>GST_TAG_CMML_STREAM</h3>
205
442
<pre class="programlisting">#define GST_TAG_CMML_STREAM "cmml-stream"
208
Annodex CMML stream element tag
444
<p>Annodex CMML stream element tag</p>
212
447
<div class="refsect2">
213
448
<a name="GST-TAG-CAPTURING-SHUTTER-SPEED:CAPS"></a><h3>GST_TAG_CAPTURING_SHUTTER_SPEED</h3>
214
449
<pre class="programlisting">#define GST_TAG_CAPTURING_SHUTTER_SPEED "capturing-shutter-speed"
217
Shutter speed used when capturing an image, in seconds. (fraction)
451
<p>Shutter speed used when capturing an image, in seconds. (fraction)</p>
221
454
<div class="refsect2">
222
455
<a name="GST-TAG-CAPTURING-FOCAL-RATIO:CAPS"></a><h3>GST_TAG_CAPTURING_FOCAL_RATIO</h3>
223
456
<pre class="programlisting">#define GST_TAG_CAPTURING_FOCAL_RATIO "capturing-focal-ratio"
226
Focal ratio (f-number) used when capturing an image. (double)
229
The value stored is the denominator of the focal ratio (f-number).
230
For example, if this tag value is 2, the focal ratio is f/2.
458
<p>Focal ratio (f-number) used when capturing an image. (double)</p>
459
<p>The value stored is the denominator of the focal ratio (f-number).
460
For example, if this tag value is 2, the focal ratio is f/2.</p>
234
463
<div class="refsect2">
235
464
<a name="GST-TAG-CAPTURING-FOCAL-LENGTH:CAPS"></a><h3>GST_TAG_CAPTURING_FOCAL_LENGTH</h3>
236
465
<pre class="programlisting">#define GST_TAG_CAPTURING_FOCAL_LENGTH "capturing-focal-length"
239
Focal length used when capturing an image, in mm. (double)
467
<p>Focal length used when capturing an image, in mm. (double)</p>
243
470
<div class="refsect2">
244
471
<a name="GST-TAG-CAPTURING-DIGITAL-ZOOM-RATIO:CAPS"></a><h3>GST_TAG_CAPTURING_DIGITAL_ZOOM_RATIO</h3>
245
472
<pre class="programlisting">#define GST_TAG_CAPTURING_DIGITAL_ZOOM_RATIO "capturing-digital-zoom-ratio"
248
Digital zoom ratio used when capturing an image. (double)
474
<p>Digital zoom ratio used when capturing an image. (double)</p>
252
477
<div class="refsect2">
253
478
<a name="GST-TAG-CAPTURING-ISO-SPEED:CAPS"></a><h3>GST_TAG_CAPTURING_ISO_SPEED</h3>
254
479
<pre class="programlisting">#define GST_TAG_CAPTURING_ISO_SPEED "capturing-iso-speed"
257
ISO speed used when capturing an image. (integer)
481
<p>ISO speed used when capturing an image. (integer)</p>
261
484
<div class="refsect2">
262
485
<a name="GST-TAG-CAPTURING-EXPOSURE-PROGRAM:CAPS"></a><h3>GST_TAG_CAPTURING_EXPOSURE_PROGRAM</h3>
263
486
<pre class="programlisting">#define GST_TAG_CAPTURING_EXPOSURE_PROGRAM "capturing-exposure-program"
266
Type of exposure control used when capturing an image. (string)
269
The allowed values are:
488
<p>Type of exposure control used when capturing an image. (string)</p>
489
<p>The allowed values are:
272
492
"normal" - automatically controlled
443
622
<div class="refsect2">
444
623
<a name="GST-TAG-CAPTURING-SOURCE:CAPS"></a><h3>GST_TAG_CAPTURING_SOURCE</h3>
445
624
<pre class="programlisting">#define GST_TAG_CAPTURING_SOURCE "capturing-source"
448
Indicates the source of capture. The device/medium used to do the
626
<p>Indicates the source of capture. The device/medium used to do the
627
capture. (string)</p>
628
<p>Allowed values are:
453
629
"dsc" (= digital still camera)
454
630
"transparent-scanner"
460
635
<div class="refsect2">
461
636
<a name="GST-TAG-CAPTURING-EXPOSURE-COMPENSATION:CAPS"></a><h3>GST_TAG_CAPTURING_EXPOSURE_COMPENSATION</h3>
462
637
<pre class="programlisting">#define GST_TAG_CAPTURING_EXPOSURE_COMPENSATION "capturing-exposure-compensation"
465
Exposure compensation using when capturing an image in EV. (double)
639
<p>Exposure compensation using when capturing an image in EV. (double)</p>
469
642
<div class="refsect2">
470
643
<a name="GST-TAG-IMAGE-HORIZONTAL-PPI:CAPS"></a><h3>GST_TAG_IMAGE_HORIZONTAL_PPI</h3>
471
644
<pre class="programlisting">#define GST_TAG_IMAGE_HORIZONTAL_PPI "image-horizontal-ppi"
474
Media (image/video) intended horizontal pixel density in ppi. (double)
646
<p>Media (image/video) intended horizontal pixel density in ppi. (double)</p>
478
649
<div class="refsect2">
479
650
<a name="GST-TAG-IMAGE-VERTICAL-PPI:CAPS"></a><h3>GST_TAG_IMAGE_VERTICAL_PPI</h3>
480
651
<pre class="programlisting">#define GST_TAG_IMAGE_VERTICAL_PPI "image-vertical-ppi"
483
Media (image/video) intended vertical pixel density in ppi. (double)
653
<p>Media (image/video) intended vertical pixel density in ppi. (double)</p>
487
656
<div class="refsect2">
488
657
<a name="GST-TAG-ID3V2-HEADER-SIZE:CAPS"></a><h3>GST_TAG_ID3V2_HEADER_SIZE</h3>
489
658
<pre class="programlisting">#define GST_TAG_ID3V2_HEADER_SIZE 10
492
ID3V2 header size considered minimum input for some functions such as
493
<a class="link" href="gst-plugins-base-libs-gsttagid3.html#gst-tag-list-from-id3v2-tag" title="gst_tag_list_from_id3v2_tag ()"><code class="function">gst_tag_list_from_id3v2_tag()</code></a> and <a class="link" href="gst-plugins-base-libs-gsttagid3.html#gst-tag-get-id3v2-tag-size" title="gst_tag_get_id3v2_tag_size ()"><code class="function">gst_tag_get_id3v2_tag_size()</code></a> for example.
497
<div class="refsect2">
498
<a name="gst-tag-register-musicbrainz-tags"></a><h3>gst_tag_register_musicbrainz_tags ()</h3>
499
<pre class="programlisting"><span class="returnvalue">void</span> gst_tag_register_musicbrainz_tags (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
501
Registers additional musicbrainz-specific tags with the GStreamer tag
502
system. Plugins and applications that use these tags should call this
503
function before using them. Can be called multiple times.
507
<div class="refsect2">
508
<a name="gst-tag-freeform-string-to-utf8"></a><h3>gst_tag_freeform_string_to_utf8 ()</h3>
509
<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_freeform_string_to_utf8 (<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> *data</code></em>,
510
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> size</code></em>,
511
<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> **env_vars</code></em>);</pre>
513
Convenience function to read a string with unknown character encoding. If
514
the string is already in UTF-8 encoding, it will be returned right away.
515
If not it tries to detect byte-order-mark for UTF-16/32 cases and use that.
516
Otherwise, the environment will be searched for a number of environment
517
variables (whose names are specified in the NULL-terminated string array
518
<em class="parameter"><code>env_vars</code></em>) containing a list of character encodings to try/use. If none
519
are specified, the current locale will be tried. If that also doesn't work,
520
WINDOWS-1252/ISO-8859-1 is assumed (which will almost always succeed).
522
<div class="variablelist"><table border="0" class="variablelist">
524
<col align="left" valign="top">
529
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
533
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
534
<td>length of string data, or -1 if the string is NUL-terminated</td>
537
<td><p><span class="term"><em class="parameter"><code>env_vars</code></em> :</span></p></td>
538
<td>a NULL-terminated string array of environment variable names,
542
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
543
<td>a newly-allocated string in UTF-8 encoding, or NULL</td>
549
<div class="refsect2">
550
<a name="gst-tag-parse-extended-comment"></a><h3>gst_tag_parse_extended_comment ()</h3>
551
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gst_tag_parse_extended_comment (<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> *ext_comment</code></em>,
552
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **key</code></em>,
553
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **lang</code></em>,
554
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **value</code></em>,
555
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> fail_if_no_key</code></em>);</pre>
557
Convenience function to parse a GST_TAG_EXTENDED_COMMENT string and
558
separate it into its components.
561
If successful, <em class="parameter"><code>key</code></em>, <em class="parameter"><code>lang</code></em> and/or <em class="parameter"><code>value</code></em> will be set to newly allocated
562
strings that you need to free with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when done. <em class="parameter"><code>key</code></em> and <em class="parameter"><code>lang</code></em>
563
may also be set to NULL by this function if there is no key or no language
564
code in the extended comment string.
566
<div class="variablelist"><table border="0" class="variablelist">
568
<col align="left" valign="top">
573
<td><p><span class="term"><em class="parameter"><code>ext_comment</code></em> :</span></p></td>
574
<td>an extended comment string, see <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>
578
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
579
<td>return location for the comment description key, or NULL</td>
582
<td><p><span class="term"><em class="parameter"><code>lang</code></em> :</span></p></td>
583
<td>return location for the comment ISO-639 language code, or NULL</td>
586
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
587
<td>return location for the actual comment string, or NULL</td>
590
<td><p><span class="term"><em class="parameter"><code>fail_if_no_key</code></em> :</span></p></td>
591
<td>whether to fail if strings are not in key=value form</td>
594
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
595
<td>TRUE if the string could be parsed, otherwise FALSE</td>
660
<p>ID3V2 header size considered minimum input for some functions such as
661
<a class="link" href="gst-plugins-base-libs-gsttagid3.html#gst-tag-list-from-id3v2-tag" title="gst_tag_list_from_id3v2_tag ()"><code class="function">gst_tag_list_from_id3v2_tag()</code></a> and <a class="link" href="gst-plugins-base-libs-gsttagid3.html#gst-tag-get-id3v2-tag-size" title="gst_tag_get_id3v2_tag_size ()"><code class="function">gst_tag_get_id3v2_tag_size()</code></a> for example.</p>
601
664
<div class="refsect2">
602
665
<a name="GstTagImageType"></a><h3>enum GstTagImageType</h3>
603
<pre class="programlisting">typedef enum {
604
GST_TAG_IMAGE_TYPE_NONE = -1,
605
GST_TAG_IMAGE_TYPE_UNDEFINED = 0,
606
GST_TAG_IMAGE_TYPE_FRONT_COVER,
607
GST_TAG_IMAGE_TYPE_BACK_COVER,
608
GST_TAG_IMAGE_TYPE_LEAFLET_PAGE,
609
GST_TAG_IMAGE_TYPE_MEDIUM,
610
GST_TAG_IMAGE_TYPE_LEAD_ARTIST,
611
GST_TAG_IMAGE_TYPE_ARTIST,
612
GST_TAG_IMAGE_TYPE_CONDUCTOR,
613
GST_TAG_IMAGE_TYPE_BAND_ORCHESTRA,
614
GST_TAG_IMAGE_TYPE_COMPOSER,
615
GST_TAG_IMAGE_TYPE_LYRICIST,
616
GST_TAG_IMAGE_TYPE_RECORDING_LOCATION,
617
GST_TAG_IMAGE_TYPE_DURING_RECORDING,
618
GST_TAG_IMAGE_TYPE_DURING_PERFORMANCE,
619
GST_TAG_IMAGE_TYPE_VIDEO_CAPTURE,
620
GST_TAG_IMAGE_TYPE_FISH,
621
GST_TAG_IMAGE_TYPE_ILLUSTRATION,
622
GST_TAG_IMAGE_TYPE_BAND_ARTIST_LOGO,
623
GST_TAG_IMAGE_TYPE_PUBLISHER_STUDIO_LOGO
627
Type of image contained in an image tag (specified as "image-type" field in
628
the info structure in the image's <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstSample.html#GstSample"><span class="type">GstSample</span></a>)
630
<div class="variablelist"><table border="0" class="variablelist">
666
<p>Type of image contained in an image tag (specified as "image-type" field in
667
the info structure in the image's <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstSample.html#GstSample"><span class="type">GstSample</span></a>)</p>
668
<div class="refsect3">
669
<a name="id-1.2.12.3.9.35.4"></a><h4>Members</h4>
670
<div class="informaltable"><table width="100%" border="0">
632
<col align="left" valign="top">
672
<col width="300px" class="enum_members_name">
673
<col class="enum_members_description">
674
<col width="200px" class="enum_members_annotations">
637
<td><p><a name="GST-TAG-IMAGE-TYPE-NONE:CAPS"></a><span class="term"><code class="literal">GST_TAG_IMAGE_TYPE_NONE</code></span></p></td>
638
<td>No image type. Can be used to
678
<td class="enum_member_name"><p><a name="GST-TAG-IMAGE-TYPE-NONE:CAPS"></a>GST_TAG_IMAGE_TYPE_NONE</p></td>
679
<td class="enum_member_description">
680
<p>No image type. Can be used to
639
681
tell functions such as <code class="function">gst_tag_image_data_to_image_sample()</code> that no
640
image type should be set.
644
<td><p><a name="GST-TAG-IMAGE-TYPE-UNDEFINED:CAPS"></a><span class="term"><code class="literal">GST_TAG_IMAGE_TYPE_UNDEFINED</code></span></p></td>
645
<td>Undefined/other image type
649
<td><p><a name="GST-TAG-IMAGE-TYPE-FRONT-COVER:CAPS"></a><span class="term"><code class="literal">GST_TAG_IMAGE_TYPE_FRONT_COVER</code></span></p></td>
654
<td><p><a name="GST-TAG-IMAGE-TYPE-BACK-COVER:CAPS"></a><span class="term"><code class="literal">GST_TAG_IMAGE_TYPE_BACK_COVER</code></span></p></td>
659
<td><p><a name="GST-TAG-IMAGE-TYPE-LEAFLET-PAGE:CAPS"></a><span class="term"><code class="literal">GST_TAG_IMAGE_TYPE_LEAFLET_PAGE</code></span></p></td>
664
<td><p><a name="GST-TAG-IMAGE-TYPE-MEDIUM:CAPS"></a><span class="term"><code class="literal">GST_TAG_IMAGE_TYPE_MEDIUM</code></span></p></td>
665
<td>Medium (e.g. label side of CD)
669
<td><p><a name="GST-TAG-IMAGE-TYPE-LEAD-ARTIST:CAPS"></a><span class="term"><code class="literal">GST_TAG_IMAGE_TYPE_LEAD_ARTIST</code></span></p></td>
670
<td>Lead artist/lead performer/soloist
674
<td><p><a name="GST-TAG-IMAGE-TYPE-ARTIST:CAPS"></a><span class="term"><code class="literal">GST_TAG_IMAGE_TYPE_ARTIST</code></span></p></td>
679
<td><p><a name="GST-TAG-IMAGE-TYPE-CONDUCTOR:CAPS"></a><span class="term"><code class="literal">GST_TAG_IMAGE_TYPE_CONDUCTOR</code></span></p></td>
684
<td><p><a name="GST-TAG-IMAGE-TYPE-BAND-ORCHESTRA:CAPS"></a><span class="term"><code class="literal">GST_TAG_IMAGE_TYPE_BAND_ORCHESTRA</code></span></p></td>
689
<td><p><a name="GST-TAG-IMAGE-TYPE-COMPOSER:CAPS"></a><span class="term"><code class="literal">GST_TAG_IMAGE_TYPE_COMPOSER</code></span></p></td>
694
<td><p><a name="GST-TAG-IMAGE-TYPE-LYRICIST:CAPS"></a><span class="term"><code class="literal">GST_TAG_IMAGE_TYPE_LYRICIST</code></span></p></td>
695
<td>Lyricist/text writer
699
<td><p><a name="GST-TAG-IMAGE-TYPE-RECORDING-LOCATION:CAPS"></a><span class="term"><code class="literal">GST_TAG_IMAGE_TYPE_RECORDING_LOCATION</code></span></p></td>
700
<td>Recording location
704
<td><p><a name="GST-TAG-IMAGE-TYPE-DURING-RECORDING:CAPS"></a><span class="term"><code class="literal">GST_TAG_IMAGE_TYPE_DURING_RECORDING</code></span></p></td>
709
<td><p><a name="GST-TAG-IMAGE-TYPE-DURING-PERFORMANCE:CAPS"></a><span class="term"><code class="literal">GST_TAG_IMAGE_TYPE_DURING_PERFORMANCE</code></span></p></td>
710
<td>During performance
714
<td><p><a name="GST-TAG-IMAGE-TYPE-VIDEO-CAPTURE:CAPS"></a><span class="term"><code class="literal">GST_TAG_IMAGE_TYPE_VIDEO_CAPTURE</code></span></p></td>
715
<td>Movie/video screen capture
719
<td><p><a name="GST-TAG-IMAGE-TYPE-FISH:CAPS"></a><span class="term"><code class="literal">GST_TAG_IMAGE_TYPE_FISH</code></span></p></td>
720
<td>A fish as funny as the ID3v2 spec
724
<td><p><a name="GST-TAG-IMAGE-TYPE-ILLUSTRATION:CAPS"></a><span class="term"><code class="literal">GST_TAG_IMAGE_TYPE_ILLUSTRATION</code></span></p></td>
729
<td><p><a name="GST-TAG-IMAGE-TYPE-BAND-ARTIST-LOGO:CAPS"></a><span class="term"><code class="literal">GST_TAG_IMAGE_TYPE_BAND_ARTIST_LOGO</code></span></p></td>
730
<td>Band/artist logotype
734
<td><p><a name="GST-TAG-IMAGE-TYPE-PUBLISHER-STUDIO-LOGO:CAPS"></a><span class="term"><code class="literal">GST_TAG_IMAGE_TYPE_PUBLISHER_STUDIO_LOGO</code></span></p></td>
735
<td>Publisher/studio logotype
682
image type should be set.</p>
684
<td class="enum_member_annotations"> </td>
687
<td class="enum_member_name"><p><a name="GST-TAG-IMAGE-TYPE-UNDEFINED:CAPS"></a>GST_TAG_IMAGE_TYPE_UNDEFINED</p></td>
688
<td class="enum_member_description">
689
<p>Undefined/other image type</p>
691
<td class="enum_member_annotations"> </td>
694
<td class="enum_member_name"><p><a name="GST-TAG-IMAGE-TYPE-FRONT-COVER:CAPS"></a>GST_TAG_IMAGE_TYPE_FRONT_COVER</p></td>
695
<td class="enum_member_description">
698
<td class="enum_member_annotations"> </td>
701
<td class="enum_member_name"><p><a name="GST-TAG-IMAGE-TYPE-BACK-COVER:CAPS"></a>GST_TAG_IMAGE_TYPE_BACK_COVER</p></td>
702
<td class="enum_member_description">
705
<td class="enum_member_annotations"> </td>
708
<td class="enum_member_name"><p><a name="GST-TAG-IMAGE-TYPE-LEAFLET-PAGE:CAPS"></a>GST_TAG_IMAGE_TYPE_LEAFLET_PAGE</p></td>
709
<td class="enum_member_description">
712
<td class="enum_member_annotations"> </td>
715
<td class="enum_member_name"><p><a name="GST-TAG-IMAGE-TYPE-MEDIUM:CAPS"></a>GST_TAG_IMAGE_TYPE_MEDIUM</p></td>
716
<td class="enum_member_description">
717
<p>Medium (e.g. label side of CD)</p>
719
<td class="enum_member_annotations"> </td>
722
<td class="enum_member_name"><p><a name="GST-TAG-IMAGE-TYPE-LEAD-ARTIST:CAPS"></a>GST_TAG_IMAGE_TYPE_LEAD_ARTIST</p></td>
723
<td class="enum_member_description">
724
<p>Lead artist/lead performer/soloist</p>
726
<td class="enum_member_annotations"> </td>
729
<td class="enum_member_name"><p><a name="GST-TAG-IMAGE-TYPE-ARTIST:CAPS"></a>GST_TAG_IMAGE_TYPE_ARTIST</p></td>
730
<td class="enum_member_description">
731
<p>Artist/performer</p>
733
<td class="enum_member_annotations"> </td>
736
<td class="enum_member_name"><p><a name="GST-TAG-IMAGE-TYPE-CONDUCTOR:CAPS"></a>GST_TAG_IMAGE_TYPE_CONDUCTOR</p></td>
737
<td class="enum_member_description">
740
<td class="enum_member_annotations"> </td>
743
<td class="enum_member_name"><p><a name="GST-TAG-IMAGE-TYPE-BAND-ORCHESTRA:CAPS"></a>GST_TAG_IMAGE_TYPE_BAND_ORCHESTRA</p></td>
744
<td class="enum_member_description">
745
<p>Band/orchestra</p>
747
<td class="enum_member_annotations"> </td>
750
<td class="enum_member_name"><p><a name="GST-TAG-IMAGE-TYPE-COMPOSER:CAPS"></a>GST_TAG_IMAGE_TYPE_COMPOSER</p></td>
751
<td class="enum_member_description">
754
<td class="enum_member_annotations"> </td>
757
<td class="enum_member_name"><p><a name="GST-TAG-IMAGE-TYPE-LYRICIST:CAPS"></a>GST_TAG_IMAGE_TYPE_LYRICIST</p></td>
758
<td class="enum_member_description">
759
<p>Lyricist/text writer</p>
761
<td class="enum_member_annotations"> </td>
764
<td class="enum_member_name"><p><a name="GST-TAG-IMAGE-TYPE-RECORDING-LOCATION:CAPS"></a>GST_TAG_IMAGE_TYPE_RECORDING_LOCATION</p></td>
765
<td class="enum_member_description">
766
<p>Recording location</p>
768
<td class="enum_member_annotations"> </td>
771
<td class="enum_member_name"><p><a name="GST-TAG-IMAGE-TYPE-DURING-RECORDING:CAPS"></a>GST_TAG_IMAGE_TYPE_DURING_RECORDING</p></td>
772
<td class="enum_member_description">
773
<p>During recording</p>
775
<td class="enum_member_annotations"> </td>
778
<td class="enum_member_name"><p><a name="GST-TAG-IMAGE-TYPE-DURING-PERFORMANCE:CAPS"></a>GST_TAG_IMAGE_TYPE_DURING_PERFORMANCE</p></td>
779
<td class="enum_member_description">
780
<p>During performance</p>
782
<td class="enum_member_annotations"> </td>
785
<td class="enum_member_name"><p><a name="GST-TAG-IMAGE-TYPE-VIDEO-CAPTURE:CAPS"></a>GST_TAG_IMAGE_TYPE_VIDEO_CAPTURE</p></td>
786
<td class="enum_member_description">
787
<p>Movie/video screen capture</p>
789
<td class="enum_member_annotations"> </td>
792
<td class="enum_member_name"><p><a name="GST-TAG-IMAGE-TYPE-FISH:CAPS"></a>GST_TAG_IMAGE_TYPE_FISH</p></td>
793
<td class="enum_member_description">
794
<p>A fish as funny as the ID3v2 spec</p>
796
<td class="enum_member_annotations"> </td>
799
<td class="enum_member_name"><p><a name="GST-TAG-IMAGE-TYPE-ILLUSTRATION:CAPS"></a>GST_TAG_IMAGE_TYPE_ILLUSTRATION</p></td>
800
<td class="enum_member_description">
803
<td class="enum_member_annotations"> </td>
806
<td class="enum_member_name"><p><a name="GST-TAG-IMAGE-TYPE-BAND-ARTIST-LOGO:CAPS"></a>GST_TAG_IMAGE_TYPE_BAND_ARTIST_LOGO</p></td>
807
<td class="enum_member_description">
808
<p>Band/artist logotype</p>
810
<td class="enum_member_annotations"> </td>
813
<td class="enum_member_name"><p><a name="GST-TAG-IMAGE-TYPE-PUBLISHER-STUDIO-LOGO:CAPS"></a>GST_TAG_IMAGE_TYPE_PUBLISHER_STUDIO_LOGO</p></td>
814
<td class="enum_member_description">
815
<p>Publisher/studio logotype</p>
817
<td class="enum_member_annotations"> </td>
742
824
<div class="refsect1">
743
825
<a name="gst-plugins-base-libs-gsttag.see-also"></a><h2>See Also</h2>
744
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="type">GstTagList</span></a>
826
<p><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="type">GstTagList</span></a></p>
747
829
<div class="footer">
749
Generated by GTK-Doc V1.19</div>
831
Generated by GTK-Doc V1.20</div>
b'\\ No newline at end of file'