blob: 9a6df40070f4b638b32be4215e4c52d65d0ff965 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gsttag</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.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="gstreamer-tag.html" title="Tag Support Library">
<link rel="next" href="gst-plugins-base-libs-gsttagvorbis.html" title="gsttagvorbis">
<meta name="generator" content="GTK-Doc V1.18 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="gstreamer-tag.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="gstreamer-tag.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GStreamer Base Plugins 1.0 Library Reference Manual</th>
<td><a accesskey="n" href="gst-plugins-base-libs-gsttagvorbis.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#gst-plugins-base-libs-gsttag.synopsis" class="shortcut">Top</a>
 | 
<a href="#gst-plugins-base-libs-gsttag.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="gst-plugins-base-libs-gsttag"></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-gsttag.top_of_page"></a>gsttag</span></h2>
<p>gsttag — additional tag definitions for plugins and applications</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="gst-plugins-base-libs-gsttag.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;gst/tag/tag.h&gt;
#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>
#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>
#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>
#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>
#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>
#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>
#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>
#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>
#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>
#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>
#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>
#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>
#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>
#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>
#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>
#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>
#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>
#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>
#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>
#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>
#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>
#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>
#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>
#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>
#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>
#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>
#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>
#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>
#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>
#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>
#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>
#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>
#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>
<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>);
<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>,
<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>,
<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>);
<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>,
<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>,
<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>,
<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>,
<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>);
enum <a class="link" href="gst-plugins-base-libs-gsttag.html#GstTagImageType" title="enum GstTagImageType">GstTagImageType</a>;
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-base-libs-gsttag.description"></a><h2>Description</h2>
<p>
</p>
<div class="refsect2">
<a name="idp19371888"></a><p>
Contains additional standardized GStreamer tag definitions for plugins
and applications, and functions to register them with the GStreamer
tag system.
</p>
</div>
<p>
</p>
</div>
<div class="refsect1">
<a name="gst-plugins-base-libs-gsttag.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GST-TAG-MUSICBRAINZ-TRACKID:CAPS"></a><h3>GST_TAG_MUSICBRAINZ_TRACKID</h3>
<pre class="programlisting">#define GST_TAG_MUSICBRAINZ_TRACKID "musicbrainz-trackid"
</pre>
<p>
MusicBrainz track ID
</p>
</div>
<hr>
<div class="refsect2">
<a name="GST-TAG-MUSICBRAINZ-ARTISTID:CAPS"></a><h3>GST_TAG_MUSICBRAINZ_ARTISTID</h3>
<pre class="programlisting">#define GST_TAG_MUSICBRAINZ_ARTISTID "musicbrainz-artistid"
</pre>
<p>
MusicBrainz artist ID
</p>
</div>
<hr>
<div class="refsect2">
<a name="GST-TAG-MUSICBRAINZ-ALBUMID:CAPS"></a><h3>GST_TAG_MUSICBRAINZ_ALBUMID</h3>
<pre class="programlisting">#define GST_TAG_MUSICBRAINZ_ALBUMID "musicbrainz-albumid"
</pre>
<p>
MusicBrainz album ID
</p>
</div>
<hr>
<div class="refsect2">
<a name="GST-TAG-MUSICBRAINZ-ALBUMARTISTID:CAPS"></a><h3>GST_TAG_MUSICBRAINZ_ALBUMARTISTID</h3>
<pre class="programlisting">#define GST_TAG_MUSICBRAINZ_ALBUMARTISTID "musicbrainz-albumartistid"
</pre>
<p>
MusicBrainz album artist ID
</p>
</div>
<hr>
<div class="refsect2">
<a name="GST-TAG-MUSICBRAINZ-TRMID:CAPS"></a><h3>GST_TAG_MUSICBRAINZ_TRMID</h3>
<pre class="programlisting">#define GST_TAG_MUSICBRAINZ_TRMID "musicbrainz-trmid"
</pre>
<p>
MusicBrainz track TRM ID
</p>
</div>
<hr>
<div class="refsect2">
<a name="GST-TAG-CDDA-CDDB-DISCID:CAPS"></a><h3>GST_TAG_CDDA_CDDB_DISCID</h3>
<pre class="programlisting">#define GST_TAG_CDDA_CDDB_DISCID "discid"
</pre>
<p>
CDDB disc id in its short form (e.g. 'aa063d0f')
</p>
</div>
<hr>
<div class="refsect2">
<a name="GST-TAG-CDDA-CDDB-DISCID-FULL:CAPS"></a><h3>GST_TAG_CDDA_CDDB_DISCID_FULL</h3>
<pre class="programlisting">#define GST_TAG_CDDA_CDDB_DISCID_FULL "discid-full"
</pre>
<p>
CDDB disc id including all details
</p>
</div>
<hr>
<div class="refsect2">
<a name="GST-TAG-CDDA-MUSICBRAINZ-DISCID:CAPS"></a><h3>GST_TAG_CDDA_MUSICBRAINZ_DISCID</h3>
<pre class="programlisting">#define GST_TAG_CDDA_MUSICBRAINZ_DISCID "musicbrainz-discid"
</pre>
<p>
Musicbrainz disc id (e.g. 'ahg7JUcfR3vCYBphSDIogOOWrr0-')
</p>
</div>
<hr>
<div class="refsect2">
<a name="GST-TAG-CDDA-MUSICBRAINZ-DISCID-FULL:CAPS"></a><h3>GST_TAG_CDDA_MUSICBRAINZ_DISCID_FULL</h3>
<pre class="programlisting">#define GST_TAG_CDDA_MUSICBRAINZ_DISCID_FULL "musicbrainz-discid-full"
</pre>
<p>
Musicbrainz disc id details
</p>
</div>
<hr>
<div class="refsect2">
<a name="GST-TAG-CMML-CLIP:CAPS"></a><h3>GST_TAG_CMML_CLIP</h3>
<pre class="programlisting">#define GST_TAG_CMML_CLIP "cmml-clip"
</pre>
<p>
Annodex CMML clip element tag
</p>
</div>
<hr>
<div class="refsect2">
<a name="GST-TAG-CMML-HEAD:CAPS"></a><h3>GST_TAG_CMML_HEAD</h3>
<pre class="programlisting">#define GST_TAG_CMML_HEAD "cmml-head"
</pre>
<p>
Annodex CMML head element tag
</p>
</div>
<hr>
<div class="refsect2">
<a name="GST-TAG-CMML-STREAM:CAPS"></a><h3>GST_TAG_CMML_STREAM</h3>
<pre class="programlisting">#define GST_TAG_CMML_STREAM "cmml-stream"
</pre>
<p>
Annodex CMML stream element tag
</p>
</div>
<hr>
<div class="refsect2">
<a name="GST-TAG-CAPTURING-SHUTTER-SPEED:CAPS"></a><h3>GST_TAG_CAPTURING_SHUTTER_SPEED</h3>
<pre class="programlisting">#define GST_TAG_CAPTURING_SHUTTER_SPEED "capturing-shutter-speed"
</pre>
<p>
Shutter speed used when capturing an image, in seconds. (fraction)
</p>
</div>
<hr>
<div class="refsect2">
<a name="GST-TAG-CAPTURING-FOCAL-RATIO:CAPS"></a><h3>GST_TAG_CAPTURING_FOCAL_RATIO</h3>
<pre class="programlisting">#define GST_TAG_CAPTURING_FOCAL_RATIO "capturing-focal-ratio"
</pre>
<p>
Focal ratio (f-number) used when capturing an image. (double)
</p>
<p>
The value stored is the denominator of the focal ratio (f-number).
For example, if this tag value is 2, the focal ratio is f/2.
</p>
</div>
<hr>
<div class="refsect2">
<a name="GST-TAG-CAPTURING-FOCAL-LENGTH:CAPS"></a><h3>GST_TAG_CAPTURING_FOCAL_LENGTH</h3>
<pre class="programlisting">#define GST_TAG_CAPTURING_FOCAL_LENGTH "capturing-focal-length"
</pre>
<p>
Focal length used when capturing an image, in mm. (double)
</p>
</div>
<hr>
<div class="refsect2">
<a name="GST-TAG-CAPTURING-DIGITAL-ZOOM-RATIO:CAPS"></a><h3>GST_TAG_CAPTURING_DIGITAL_ZOOM_RATIO</h3>
<pre class="programlisting">#define GST_TAG_CAPTURING_DIGITAL_ZOOM_RATIO "capturing-digital-zoom-ratio"
</pre>
<p>
Digital zoom ratio used when capturing an image. (double)
</p>
</div>
<hr>
<div class="refsect2">
<a name="GST-TAG-CAPTURING-ISO-SPEED:CAPS"></a><h3>GST_TAG_CAPTURING_ISO_SPEED</h3>
<pre class="programlisting">#define GST_TAG_CAPTURING_ISO_SPEED "capturing-iso-speed"
</pre>
<p>
ISO speed used when capturing an image. (integer)
</p>
</div>
<hr>
<div class="refsect2">
<a name="GST-TAG-CAPTURING-EXPOSURE-PROGRAM:CAPS"></a><h3>GST_TAG_CAPTURING_EXPOSURE_PROGRAM</h3>
<pre class="programlisting">#define GST_TAG_CAPTURING_EXPOSURE_PROGRAM "capturing-exposure-program"
</pre>
<p>
Type of exposure control used when capturing an image. (string)
</p>
<p>
The allowed values are:
"undefined"
"manual"
"normal" - automatically controlled
"aperture-priority" - user selects aperture value
"shutter-priority" - user selects shutter speed
"creative" - biased towards depth of field
"action" - biased towards fast shutter speed
"portrait" - closeup, leaving background out of focus
"landscape" - landscape photos, background in focus
</p>
</div>
<hr>
<div class="refsect2">
<a name="GST-TAG-CAPTURING-EXPOSURE-MODE:CAPS"></a><h3>GST_TAG_CAPTURING_EXPOSURE_MODE</h3>
<pre class="programlisting">#define GST_TAG_CAPTURING_EXPOSURE_MODE "capturing-exposure-mode"
</pre>
<p>
Exposure mode used when capturing an image. (string)
</p>
<p>
The allowed values are:
"auto-exposure"
"manual-exposure"
"auto-bracket"
</p>
</div>
<hr>
<div class="refsect2">
<a name="GST-TAG-CAPTURING-SCENE-CAPTURE-TYPE:CAPS"></a><h3>GST_TAG_CAPTURING_SCENE_CAPTURE_TYPE</h3>
<pre class="programlisting">#define GST_TAG_CAPTURING_SCENE_CAPTURE_TYPE "capturing-scene-capture-type"
</pre>
<p>
Scene mode used when capturing an image. (string)
</p>
<p>
The allowed values are:
"standard"
"landscape"
"portrait"
"night-scene"
</p>
</div>
<hr>
<div class="refsect2">
<a name="GST-TAG-CAPTURING-GAIN-ADJUSTMENT:CAPS"></a><h3>GST_TAG_CAPTURING_GAIN_ADJUSTMENT</h3>
<pre class="programlisting">#define GST_TAG_CAPTURING_GAIN_ADJUSTMENT "capturing-gain-adjustment"
</pre>
<p>
Gain adjustment applied to an image. (string)
</p>
<p>
The allowed values are:
"none"
"low-gain-up"
"high-gain-up"
"low-gain-down"
"high-gain-down"
</p>
</div>
<hr>
<div class="refsect2">
<a name="GST-TAG-CAPTURING-WHITE-BALANCE:CAPS"></a><h3>GST_TAG_CAPTURING_WHITE_BALANCE</h3>
<pre class="programlisting">#define GST_TAG_CAPTURING_WHITE_BALANCE "capturing-white-balance"
</pre>
<p>
White balance mode used when capturing an image. (string)
</p>
<p>
The allowed values are:
"auto"
"manual"
"daylight"
"cloudy"
"tungsten"
"fluorescent"
"fluorescent h" (newer daylight-calibrated fluorescents)
"flash"
</p>
</div>
<hr>
<div class="refsect2">
<a name="GST-TAG-CAPTURING-CONTRAST:CAPS"></a><h3>GST_TAG_CAPTURING_CONTRAST</h3>
<pre class="programlisting">#define GST_TAG_CAPTURING_CONTRAST "capturing-contrast"
</pre>
<p>
Direction of contrast processing applied when capturing an image. (string)
</p>
<p>
The allowed values are:
"normal"
"soft"
"hard"
</p>
</div>
<hr>
<div class="refsect2">
<a name="GST-TAG-CAPTURING-SATURATION:CAPS"></a><h3>GST_TAG_CAPTURING_SATURATION</h3>
<pre class="programlisting">#define GST_TAG_CAPTURING_SATURATION "capturing-saturation"
</pre>
<p>
Direction of saturation processing applied when capturing an image. (string)
</p>
<p>
The allowed values are:
"normal"
"low-saturation"
"high-saturation"
</p>
</div>
<hr>
<div class="refsect2">
<a name="GST-TAG-CAPTURING-SHARPNESS:CAPS"></a><h3>GST_TAG_CAPTURING_SHARPNESS</h3>
<pre class="programlisting">#define GST_TAG_CAPTURING_SHARPNESS "capturing-sharpness"
</pre>
<p>
Direction of sharpness processing applied when capturing an image. (string)
</p>
<p>
The allowed values are:
"normal"
"soft"
"hard"
</p>
</div>
<hr>
<div class="refsect2">
<a name="GST-TAG-CAPTURING-FLASH-FIRED:CAPS"></a><h3>GST_TAG_CAPTURING_FLASH_FIRED</h3>
<pre class="programlisting">#define GST_TAG_CAPTURING_FLASH_FIRED "capturing-flash-fired"
</pre>
<p>
If flash was fired during the capture of an image. (boolean)
</p>
<p>
Note that if this tag isn't present, it should not be assumed that
the flash did not fire. It should be treated as unknown.
</p>
</div>
<hr>
<div class="refsect2">
<a name="GST-TAG-CAPTURING-FLASH-MODE:CAPS"></a><h3>GST_TAG_CAPTURING_FLASH_MODE</h3>
<pre class="programlisting">#define GST_TAG_CAPTURING_FLASH_MODE "capturing-flash-mode"
</pre>
<p>
The flash mode selected during the capture of an image. (string)
</p>
<p>
The allowed values are:
"auto"
"always"
"never"
</p>
</div>
<hr>
<div class="refsect2">
<a name="GST-TAG-CAPTURING-METERING-MODE:CAPS"></a><h3>GST_TAG_CAPTURING_METERING_MODE</h3>
<pre class="programlisting">#define GST_TAG_CAPTURING_METERING_MODE "capturing-metering-mode"
</pre>
<p>
Defines the way a camera determines the exposure. (string)
</p>
<p>
The allowed values are:
"unknown"
"average"
"center-weighted-average"
"spot"
"multi-spot"
"pattern"
"partial"
"other"
</p>
</div>
<hr>
<div class="refsect2">
<a name="GST-TAG-CAPTURING-SOURCE:CAPS"></a><h3>GST_TAG_CAPTURING_SOURCE</h3>
<pre class="programlisting">#define GST_TAG_CAPTURING_SOURCE "capturing-source"
</pre>
<p>
Indicates the source of capture. The device/medium used to do the
capture. (string)
</p>
<p>
Allowed values are:
"dsc" (= digital still camera)
"transparent-scanner"
"reflex-scanner"
"other"
</p>
</div>
<hr>
<div class="refsect2">
<a name="GST-TAG-CAPTURING-EXPOSURE-COMPENSATION:CAPS"></a><h3>GST_TAG_CAPTURING_EXPOSURE_COMPENSATION</h3>
<pre class="programlisting">#define GST_TAG_CAPTURING_EXPOSURE_COMPENSATION "capturing-exposure-compensation"
</pre>
<p>
Exposure compensation using when capturing an image in EV. (double)
</p>
</div>
<hr>
<div class="refsect2">
<a name="GST-TAG-IMAGE-HORIZONTAL-PPI:CAPS"></a><h3>GST_TAG_IMAGE_HORIZONTAL_PPI</h3>
<pre class="programlisting">#define GST_TAG_IMAGE_HORIZONTAL_PPI "image-horizontal-ppi"
</pre>
<p>
Media (image/video) intended horizontal pixel density in ppi. (double)
</p>
</div>
<hr>
<div class="refsect2">
<a name="GST-TAG-IMAGE-VERTICAL-PPI:CAPS"></a><h3>GST_TAG_IMAGE_VERTICAL_PPI</h3>
<pre class="programlisting">#define GST_TAG_IMAGE_VERTICAL_PPI "image-vertical-ppi"
</pre>
<p>
Media (image/video) intended vertical pixel density in ppi. (double)
</p>
</div>
<hr>
<div class="refsect2">
<a name="GST-TAG-ID3V2-HEADER-SIZE:CAPS"></a><h3>GST_TAG_ID3V2_HEADER_SIZE</h3>
<pre class="programlisting">#define GST_TAG_ID3V2_HEADER_SIZE 10
</pre>
<p>
ID3V2 header size considered minimum input for some functions such as
<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>
</div>
<hr>
<div class="refsect2">
<a name="gst-tag-register-musicbrainz-tags"></a><h3>gst_tag_register_musicbrainz_tags ()</h3>
<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>
<p>
Registers additional musicbrainz-specific tags with the GStreamer tag
system. Plugins and applications that use these tags should call this
function before using them. Can be called multiple times.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gst-tag-freeform-string-to-utf8"></a><h3>gst_tag_freeform_string_to_utf8 ()</h3>
<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>,
<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>,
<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>
<p>
Convenience function to read a string with unknown character encoding. If
the string is already in UTF-8 encoding, it will be returned right away.
If not it tries to detect byte-order-mark for UTF-16/32 cases and use that.
Otherwise, the environment will be searched for a number of environment
variables (whose names are specified in the NULL-terminated string array
<em class="parameter"><code>env_vars</code></em>) containing a list of character encodings to try/use. If none
are specified, the current locale will be tried. If that also doesn't work,
WINDOWS-1252/ISO-8859-1 is assumed (which will almost always succeed).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>string data</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
<td>length of string data, or -1 if the string is NUL-terminated</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>env_vars</code></em> :</span></p></td>
<td>a NULL-terminated string array of environment variable names,
or NULL</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a newly-allocated string in UTF-8 encoding, or NULL</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gst-tag-parse-extended-comment"></a><h3>gst_tag_parse_extended_comment ()</h3>
<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>,
<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>,
<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>,
<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>,
<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>
<p>
Convenience function to parse a GST_TAG_EXTENDED_COMMENT string and
separate it into its components.
</p>
<p>
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
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>
may also be set to NULL by this function if there is no key or no language
code in the extended comment string.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ext_comment</code></em> :</span></p></td>
<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>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>return location for the comment description key, or NULL</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>lang</code></em> :</span></p></td>
<td>return location for the comment ISO-639 language code, or NULL</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>return location for the actual comment string, or NULL</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>fail_if_no_key</code></em> :</span></p></td>
<td>whether to fail if strings are not in key=value form</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if the string could be parsed, otherwise FALSE</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GstTagImageType"></a><h3>enum GstTagImageType</h3>
<pre class="programlisting">typedef enum {
GST_TAG_IMAGE_TYPE_NONE = -1,
GST_TAG_IMAGE_TYPE_UNDEFINED = 0,
GST_TAG_IMAGE_TYPE_FRONT_COVER,
GST_TAG_IMAGE_TYPE_BACK_COVER,
GST_TAG_IMAGE_TYPE_LEAFLET_PAGE,
GST_TAG_IMAGE_TYPE_MEDIUM,
GST_TAG_IMAGE_TYPE_LEAD_ARTIST,
GST_TAG_IMAGE_TYPE_ARTIST,
GST_TAG_IMAGE_TYPE_CONDUCTOR,
GST_TAG_IMAGE_TYPE_BAND_ORCHESTRA,
GST_TAG_IMAGE_TYPE_COMPOSER,
GST_TAG_IMAGE_TYPE_LYRICIST,
GST_TAG_IMAGE_TYPE_RECORDING_LOCATION,
GST_TAG_IMAGE_TYPE_DURING_RECORDING,
GST_TAG_IMAGE_TYPE_DURING_PERFORMANCE,
GST_TAG_IMAGE_TYPE_VIDEO_CAPTURE,
GST_TAG_IMAGE_TYPE_FISH,
GST_TAG_IMAGE_TYPE_ILLUSTRATION,
GST_TAG_IMAGE_TYPE_BAND_ARTIST_LOGO,
GST_TAG_IMAGE_TYPE_PUBLISHER_STUDIO_LOGO
} GstTagImageType;
</pre>
<p>
Type of image contained in an image tag (specified as field in
the image buffer's caps structure)
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<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>
<td>No image type. Can be used to
tell functions such as <code class="function">gst_tag_image_data_to_image_sample()</code> that no
image type should be set.
</td>
</tr>
<tr>
<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>
<td>Undefined/other image type
</td>
</tr>
<tr>
<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>
<td>Cover (front)
</td>
</tr>
<tr>
<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>
<td>Cover (back)
</td>
</tr>
<tr>
<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>
<td>Leaflet page
</td>
</tr>
<tr>
<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>
<td>Medium (e.g. label side of CD)
</td>
</tr>
<tr>
<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>
<td>Lead artist/lead performer/soloist
</td>
</tr>
<tr>
<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>
<td>Artist/performer
</td>
</tr>
<tr>
<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>
<td>Conductor
</td>
</tr>
<tr>
<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>
<td>Band/orchestra
</td>
</tr>
<tr>
<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>
<td>Composer
</td>
</tr>
<tr>
<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>
<td>Lyricist/text writer
</td>
</tr>
<tr>
<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>
<td>Recording location
</td>
</tr>
<tr>
<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>
<td>During recording
</td>
</tr>
<tr>
<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>
<td>During performance
</td>
</tr>
<tr>
<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>
<td>Movie/video screen capture
</td>
</tr>
<tr>
<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>
<td>A fish as funny as the ID3v2 spec
</td>
</tr>
<tr>
<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>
<td>Illustration
</td>
</tr>
<tr>
<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>
<td>Band/artist logotype
</td>
</tr>
<tr>
<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>
<td>Publisher/studio logotype
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-base-libs-gsttag.see-also"></a><h2>See Also</h2>
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstTagList.html#GstTagList"><span class="type">GstTagList</span></a>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>