Debian Codegraph @

doc/templates/__intro__

raw
1 <h2><a href="namespaces.html">Namespaces</a></h2>
2
3 <p>The <a href="index.html">Exiv2 library</a> is made up of all
4 elements defined in the <a href="namespaceExiv2.html">Exiv2
5 namespace</a>.</p>
6
7 <h2><a href="classes.html">Classes</a></h2>
8
9 <p>The top-level class of the Exiv2 library is <a class="el"
10 href="classExiv2_1_1Image.html">Exiv2::Image</a>. Exiv2::Image
11 defines the interface to access image metadata. Derived from
12 Exiv2::Image are implementations for different image formats. Most
13 importantly, they contain the logic to read metadata from the image
14 into Exiv2 metadata containers and write it back to the image.
15 Most applications will use
16 <a class="el" href="classExiv2_1_1ImageFactory.html">Exiv2::ImageFactory</a>
17 to access images in files or memory, in which case the image format
18 is transparent to them. The factory determines the image format from the
19 data (not the file extension) and creates an object of the corresponding
20 Image subclass.</p>
21
22 <p>Exif and IPTC metadata is manipulated through the classes
23 <a class="el" href="classExiv2_1_1ExifData.html">Exiv2::ExifData</a>
24 and <a class="el" href="classExiv2_1_1IptcData.html">Exiv2::IptcData</a>.
25 They hold a container of Exif and IPTC metadata, respectively, and define
26 related methods to access and manipulate the metadata.
27 <br>
28 Exif tag and IPTC dataset reference information for the standard tags
29 and datasets is available in the two static classes
30 <a class="el" href="classExiv2_1_1ExifTags.html">Exiv2::ExifTags</a> and
31 <a class="el" href="classExiv2_1_1IptcDataSets.html">Exiv2::IptcDataSets</a>.
32 <br>
33 The metadata containers hold objects derived from
34 <a class="el" href="classExiv2_1_1Metadatum.html">Exiv2::Metadatum</a>.
35 Interface class Exiv2::Metadatum defines methods to access the
36 information of one metadatum. It models the tag data as a key and
37 value pair.
38 The abstract base class
39 <a class="el" href="classExiv2_1_1Key.html">Exiv2::Key</a> defines the
40 interface for a key. Concrete keys implement Exif and IPTC keys.
41 The abstract base class
42 <a class="el" href="classExiv2_1_1Value.html">Exiv2::Value</a> defines
43 the interface to access tag information, from which concrete values are
44 derived. The actual value used in a metadatum depends on the type of
45 the Exif tag or IPTC dataset. It is usually determined when the Exif or
46 IPTC metadata is read from an image. It is also possible to manually create
47 a Value and together with a key add it to an ExifData or IptcData
48 container.</p>
49
50 The classes to access XMP metadata are
51 <a class="el" href="classExiv2_1_1XmpData.html">Exiv2::XmpData</a>,
52 <a class="el" href="classExiv2_1_1Xmpdatum.html">Exiv2::Xmpdatum</a>
53 and <a class="el" href="classExiv2_1_1XmpKey.html">Exiv2::XmpKey</a>.
54 They work similar to the corresponding Exif and IPTC classes.
55 The property reference information is in
56 <a class="el" href="classExiv2_1_1XmpProperties.html">Exiv2::XmpProperties</a>.
57 In addition to the expected new members, class
58 <a class="el" href="classExiv2_1_1Image.html">Exiv2::Image</a>
59 now also has an interface to access the raw XMP packet.
60 <br>
61 All XMP value types are supported: Simple types, structures,
62 arrays, property qualifiers and language alternatives.
63 <br>
64 XMP properties are accessed through keys of the form
65 "Xmp.&lt;Prefix&gt;.&lt;PropertyPath&gt;", where &lt;Prefix&gt; is the preferred
66 (or rather, registered) prefix for a schema namespace and
67 &lt;PropertyPath&gt; is the path of the XMP node. In its most basic
68 form, to address simple properties, &lt;PropertyPath&gt; is the name
69 of the property. In general, &lt;PropertyPath&gt; can be used to
70 address any XMP node, including array items, structure fields
71 qualifiers and deeply nested properties.
72 <br>
73 Any properties in known namespaces are supported and additional
74 namespaces can be registered.
75 <br>
76 The specialized Exiv2 values
77 <a class="el" href="classExiv2_1_1XmpTextValue.html">Exiv2::XmpTextValue</a>,
78 <a class="el" href="classExiv2_1_1XmpArrayValue.html">Exiv2::XmpArrayValue</a>
79 and <a class="el" href="classExiv2_1_1LangAltValue.html">Exiv2::LangAltValue</a> are
80 provided to simplify the use of XMP properties.
81 <br>
82 Note: Unlike Exif and IPTC tags, XMP properties do not have
83 a tag number.
84
85 <h2><a href="examples.html">Examples</a></h2>
86
87 <p>There are several simple examples that demonstrate the basic use of Exiv2
88 functionality: <a href="exifprint_8cpp-example.html">Exifprint</a>
89 shows how the Exif data of an image can be read and written to the screen.
90 <a href="iptcprint_8cpp-example.html">Iptcprint</a> is a similar
91 example to print IPTC data.
92 <a href="addmoddel_8cpp-example.html">Addmoddel</a> shows how to
93 add, modify and delete Exif metadata.
94 <a href="exifcomment_8cpp-example.html">Exifcomment</a> shows how to
95 set the exif comment of an image.
96 <a href="xmpsample_8cpp-example.html">Xmpsample.cpp</a> contains examples
97 of how to set various types of XMP properties.
98 <br>
99 For more real-world code have a look at the implementation of the
100 different actions of the Exiv2 utility (actions.cpp).</p>
101
102 <h2><a href="makernote.html">Makernotes</a></h2>
103
104 <p>Exif Makernote data can be accessed through ExifData in the same
105 way as the standard Exif tags. In other words, for each entry of a
106 known Makernote, there is a corresponding Metadatum in the ExifData
107 container. Makernote taglists are internally kept in classes
108 Exiv2::Internal::&lt;Make&gt;MakerNote (e.g.,
109 <a class="el" href="classExiv2_1_1Internal_1_1CanonMakerNote.html">
110 Exiv2::Internal::CanonMakerNote</a>.)