MetaPicture Class Reference

MetaPicture describes a meta image that is part of an audio or video file. More...

Inherits Reference.

List of all members.

Public Member Functions
virtual const char *	mimeType () const =0
	Returns the picture MIME type.
virtual void	setMimeType (const char *mimeType)=0
	Sets the picture MIME type.
virtual MetaPictureType::Enum	pictureType () const =0
	Returns the meta picture type (front cover, back cover, artist, etc.)
virtual void	setPictureType (MetaPictureType::Enum picType)=0
	Sets the picture type (front cover, back cover, artist, etc.)
virtual const char_t *	description () const =0
	Returns a picture description as a free text.
virtual void	setDescription (const char_t *description)=0
	Sets picture description.
virtual const uint8_t *	data () const =0
	Returns the start of the image data.
virtual int32_t	dataSize () const =0
	Returns the number of image bytes.
virtual bool_t	setData (const void *data, int32_t dataSize)=0
	Sets image data.
Protected Member Functions
virtual	~MetaPicture ()
	This object can be destroyed only by the library that has created it.

---

Detailed Description

MetaPicture describes a meta image that is part of an audio or video file.

See also:

Library::createMetaPicture

Metadata

---

Constructor & Destructor Documentation

virtual ~MetaPicture

(

)

[protected, virtual]

This object can be destroyed only by the library that has created it.

See also:

primo::Reference::release

---

Member Function Documentation

virtual const uint8_t* data

(

)

const [pure virtual]

Returns the start of the image data.

The image is a jpeg, png or another image type.

Returns:

A pointer to the start of the image data. The number of image bytes is given by the MetaPicture::dataSize property. The image type (jpeg, png, etc.) is given by the MetaPicture::mimeType property.

See also:

MetaPicture::mimeType

MetaPicture::dataSize

virtual int32_t dataSize

(

)

const [pure virtual]

Returns the number of image bytes.

Returns:

The number of image bytes that are returned by the MetaPicture::data property.

virtual const char_t* description

(

)

const [pure virtual]

Returns a picture description as a free text.

Returns:

Unicode string. Can be NULL if the picture has no description.

virtual const char* mimeType

(

)

const [pure virtual]

Returns the picture MIME type.

Returns:

The MIME type is an ANSI string.

See also:

primo::codecs::MimeType

virtual MetaPictureType::Enum pictureType

(

)

const [pure virtual]

Returns the meta picture type (front cover, back cover, artist, etc.)

Returns:

A picture type constant defined in MetaPictureType::Enum.

See also:

MetaPictureType::Enum

virtual bool_t setData	(	const void *	data,
		int32_t	dataSize
	)		[pure virtual]

Sets image data.

Parameters:

data	[in] A pointer to the new image data.
dataSize	[in] The size of the new image in bytes .

Returns:

TRUE if the data is successfully set, FALSE if there's an error.

The supplied data is copied internally and is not required to be valid after the method returns.

See also:

MetaPicture::data

MetaPicture::dataSize

virtual void setDescription

(

const char_t *

description

)

[pure virtual]

Sets picture description.

Parameters:

description

[in] A pointer to a Unicode string. Can be NULL in which case the picture description is cleared.

virtual void setMimeType

(

const char *

mimeType

)

[pure virtual]

Sets the picture MIME type.

Parameters:

mimeType

[in] A pointer to ANSI string specifying the MIME type

See also:

primo::codecs::MimeType

virtual void setPictureType

(

MetaPictureType::Enum

picType

)

[pure virtual]

Sets the picture type (front cover, back cover, artist, etc.)

Parameters:

[in]

picType

A picture type constant defined in MetaPictureType::Enum.

See also:

MetaPictureType::Enum