/usr/share/gtk-doc/html/libtracker-extract/libtracker-extract-IPTC.html is in libtracker-extract-doc 0.14.0-2ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IPTC</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Tracker Extract Library Reference Manual">
<link rel="up" href="ch03.html" title="Common Embedded Support API">
<link rel="prev" href="libtracker-extract-XMP.html" title="XMP">
<link rel="next" href="libtracker-extract-Exif.html" title="Exif">
<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="libtracker-extract-XMP.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch03.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">Tracker Extract Library Reference Manual</th>
<td><a accesskey="n" href="libtracker-extract-Exif.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libtracker-extract-IPTC.synopsis" class="shortcut">Top</a>
|
<a href="#libtracker-extract-IPTC.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libtracker-extract-IPTC"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libtracker-extract-IPTC.top_of_page"></a>IPTC</span></h2>
<p>IPTC — Information Interchange Model (IIM) /
International Press Telecommunications Council (IPTC)</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libtracker-extract-IPTC.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv">
<a name="libtracker-extract-IPTC.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libtracker-extract/tracker-extract.h>
<a class="link" href="libtracker-extract-IPTC.html#TrackerIptcData" title="TrackerIptcData">TrackerIptcData</a>;
<a class="link" href="libtracker-extract-IPTC.html#TrackerIptcData" title="TrackerIptcData"><span class="returnvalue">TrackerIptcData</span></a> * <a class="link" href="libtracker-extract-IPTC.html#tracker-iptc-new" title="tracker_iptc_new ()">tracker_iptc_new</a> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> *buffer</code></em>,
<em class="parameter"><code><span class="type">gsize</span> len</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libtracker-extract-IPTC.html#tracker-iptc-free" title="tracker_iptc_free ()">tracker_iptc_free</a> (<em class="parameter"><code><a class="link" href="libtracker-extract-IPTC.html#TrackerIptcData" title="TrackerIptcData"><span class="type">TrackerIptcData</span></a> *data</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libtracker-extract-IPTC.html#tracker-iptc-read" title="tracker_iptc_read ()">tracker_iptc_read</a> (<em class="parameter"><code>const unsigned <span class="type">char</span> *buffer</code></em>,
<em class="parameter"><code><span class="type">size_t</span> len</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri</code></em>,
<em class="parameter"><code><a class="link" href="libtracker-extract-IPTC.html#TrackerIptcData" title="TrackerIptcData"><span class="type">TrackerIptcData</span></a> *data</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libtracker-extract-IPTC.description"></a><h2>Description</h2>
<p>
The Information Interchange Model (IIM) is a file structure and set
of metadata attributes that can be applied to text, images and
other media types. It was developed in the early 1990s by the
International Press Telecommunications Council (IPTC) to expedite
the international exchange of news among newspapers and news
agencies.
</p>
<p>
The full IIM specification includes a complex data structure and a
set of metadata definitions.
</p>
<p>
Although IIM was intended for use with all types of news items —
including simple text articles — a subset found broad worldwide
acceptance as the standard embedded metadata used by news and
commercial photographers. Information such as the name of the
photographer, copyright information and the caption or other
description can be embedded either manually or automatically.
</p>
<p>
IIM metadata embedded in images are often referred to as "IPTC
headers," and can be easily encoded and decoded by most popular
photo editing software.
</p>
<p>
The Extensible Metadata Platform (XMP) has largely superseded IIM's
file structure, but the IIM image attributes are defined in the
IPTC Core schema for XMP and most image manipulation programs keep
the XMP and non-XMP IPTC attributes synchronized.
</p>
<p>
This API is provided to remove code duplication between extractors
using these standards.
</p>
</div>
<div class="refsect1">
<a name="libtracker-extract-IPTC.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="TrackerIptcData"></a><h3>TrackerIptcData</h3>
<pre class="programlisting">typedef struct {
gchar *keywords;
gchar *date_created;
gchar *byline;
gchar *credit;
gchar *copyright_notice;
gchar *image_orientation;
gchar *byline_title;
gchar *city;
gchar *state;
gchar *sublocation;
gchar *country_name;
gchar *contact;
} TrackerIptcData;
</pre>
<p>
Structure defining IPTC data.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="TrackerIptcData.keywords"></a>keywords</code></em>;</span></p></td>
<td>Keywords.</td>
</tr>
<tr>
<td><p><span class="term"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="TrackerIptcData.date-created"></a>date_created</code></em>;</span></p></td>
<td>Date created.</td>
</tr>
<tr>
<td><p><span class="term"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="TrackerIptcData.byline"></a>byline</code></em>;</span></p></td>
<td>Byline.</td>
</tr>
<tr>
<td><p><span class="term"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="TrackerIptcData.credit"></a>credit</code></em>;</span></p></td>
<td>Credits.</td>
</tr>
<tr>
<td><p><span class="term"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="TrackerIptcData.copyright-notice"></a>copyright_notice</code></em>;</span></p></td>
<td>Copyright.</td>
</tr>
<tr>
<td><p><span class="term"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="TrackerIptcData.image-orientation"></a>image_orientation</code></em>;</span></p></td>
<td>Image orientation.</td>
</tr>
<tr>
<td><p><span class="term"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="TrackerIptcData.byline-title"></a>byline_title</code></em>;</span></p></td>
<td>Byline title.</td>
</tr>
<tr>
<td><p><span class="term"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="TrackerIptcData.city"></a>city</code></em>;</span></p></td>
<td>City.</td>
</tr>
<tr>
<td><p><span class="term"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="TrackerIptcData.state"></a>state</code></em>;</span></p></td>
<td>State.</td>
</tr>
<tr>
<td><p><span class="term"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="TrackerIptcData.sublocation"></a>sublocation</code></em>;</span></p></td>
<td>Sublocation.</td>
</tr>
<tr>
<td><p><span class="term"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="TrackerIptcData.country-name"></a>country_name</code></em>;</span></p></td>
<td>Country.</td>
</tr>
<tr>
<td><p><span class="term"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="TrackerIptcData.contact"></a>contact</code></em>;</span></p></td>
<td>Contact info.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="tracker-iptc-new"></a><h3>tracker_iptc_new ()</h3>
<pre class="programlisting"><a class="link" href="libtracker-extract-IPTC.html#TrackerIptcData" title="TrackerIptcData"><span class="returnvalue">TrackerIptcData</span></a> * tracker_iptc_new (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> *buffer</code></em>,
<em class="parameter"><code><span class="type">gsize</span> len</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri</code></em>);</pre>
<p>
This function takes <em class="parameter"><code>len</code></em> bytes of <em class="parameter"><code>buffer</code></em> and runs it through the
IPTC library.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>a chunk of data with iptc data in it.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>len</code></em> :</span></p></td>
<td>the size of <em class="parameter"><code>buffer</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>the URI this is related to.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a newly allocated <a class="link" href="libtracker-extract-IPTC.html#TrackerIptcData" title="TrackerIptcData"><span class="type">TrackerIptcData</span></a> struct if IPTC data was
found, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> otherwise. Free the returned struct with
<a class="link" href="libtracker-extract-IPTC.html#tracker-iptc-free" title="tracker_iptc_free ()"><code class="function">tracker_iptc_free()</code></a>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.10</p>
</div>
<hr>
<div class="refsect2">
<a name="tracker-iptc-free"></a><h3>tracker_iptc_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> tracker_iptc_free (<em class="parameter"><code><a class="link" href="libtracker-extract-IPTC.html#TrackerIptcData" title="TrackerIptcData"><span class="type">TrackerIptcData</span></a> *data</code></em>);</pre>
<p>
Frees <em class="parameter"><code>data</code></em> and all <a class="link" href="libtracker-extract-IPTC.html#TrackerIptcData" title="TrackerIptcData"><span class="type">TrackerIptcData</span></a> members. <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> will produce a
a warning.
</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>a <a class="link" href="libtracker-extract-IPTC.html#TrackerIptcData" title="TrackerIptcData"><span class="type">TrackerIptcData</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 0.10</p>
</div>
<hr>
<div class="refsect2">
<a name="tracker-iptc-read"></a><h3>tracker_iptc_read ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> tracker_iptc_read (<em class="parameter"><code>const unsigned <span class="type">char</span> *buffer</code></em>,
<em class="parameter"><code><span class="type">size_t</span> len</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri</code></em>,
<em class="parameter"><code><a class="link" href="libtracker-extract-IPTC.html#TrackerIptcData" title="TrackerIptcData"><span class="type">TrackerIptcData</span></a> *data</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">tracker_iptc_read</code> is deprecated and should not be used in newly-written code. 0.9. Use <a class="link" href="libtracker-extract-IPTC.html#tracker-iptc-new" title="tracker_iptc_new ()"><code class="function">tracker_iptc_new()</code></a> instead.</p>
</div>
<p>
This function takes <em class="parameter"><code>len</code></em> bytes of <em class="parameter"><code>buffer</code></em> and runs it through the
IPTC library. The result is that <em class="parameter"><code>data</code></em> is populated with the IPTC
data found in <em class="parameter"><code>uri</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>a chunk of data with iptc data in it.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>len</code></em> :</span></p></td>
<td>the size of <em class="parameter"><code>buffer</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>the URI this is related to.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>a pointer to a TrackerIptcData struture to populate.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the <em class="parameter"><code>data</code></em> was populated successfully, otherwise
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.8</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|