Reads simple text comment metadata from image files. More...

#include <gin_commentmetadata.h>

Inheritance diagram for CommentMetadata:

Public Member Functions
	CommentMetadata ()
virtual	~CommentMetadata ()
juce::StringPairArray	getAllMetadata () const
Public Member Functions inherited from ImageMetadata
	ImageMetadata (const juce::String &type)
virtual	~ImageMetadata ()
juce::String	getType () const

Static Public Member Functions
static CommentMetadata *	create (const juce::uint8 *data, int sz)
Static Public Member Functions inherited from ImageMetadata
static bool	getFromImage (juce::InputStream &is, juce::OwnedArray< ImageMetadata > &metadata)

Additional Inherited Members
Protected Attributes inherited from ImageMetadata
juce::String	type

Detailed Description

Reads simple text comment metadata from image files.

CommentMetadata extracts basic comment fields that some image formats support. This is the simplest form of metadata, typically just a single text string describing or annotating the image.

JPEG comment segments and similar simple metadata formats are handled by this class. Unlike EXIF, XMP, or IPTC, comments don't have structured fields.

Usage:

FileInputStream stream(imageFile);
OwnedArray<ImageMetadata> metadata;
ImageMetadata::getFromImage(stream, metadata);
 
for (auto* meta : metadata)
{
    if (auto* comment = dynamic_cast<CommentMetadata*>(meta))
    {
        StringPairArray data = comment->getAllMetadata();
        String commentText = data["Comment"];
    }
}

See also: ImageMetadata, ExifMetadata

Constructor & Destructor Documentation

◆ CommentMetadata()

CommentMetadata::CommentMetadata ( )

Referenced by create().

◆ ~CommentMetadata()

virtual CommentMetadata::~CommentMetadata ( )

virtual

Member Function Documentation

◆ create()

CommentMetadata * CommentMetadata::create	(	const juce::uint8 *	data,
		int	sz )

static

References CommentMetadata().

◆ getAllMetadata()

juce::StringPairArray CommentMetadata::getAllMetadata ( ) const

virtual

Implements ImageMetadata.

The documentation for this class was generated from the following file:

gin_commentmetadata.h

Public Member Functions

Static Public Member Functions