AVBlocks for C++  3.4
Audio and Video Software Development Kit
Loading...
Searching...
No Matches
MetaPicture Class Referenceabstract

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

#include <av.h>

Inheritance diagram for MetaPicture:
Reference

Public Member Functions

virtual MetaPicture * clone () const =0
 Creates a deep copy of this object.
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 const char_t * description () const =0
 Returns a picture description as a free text.
virtual bool_t immutable () const =0
 Returns whether the object is immutable.
virtual const char * mimeType () const =0
 Returns the picture MIME type.
virtual MetaPictureType::Enum pictureType () const =0
 Returns the meta picture type (front cover, back cover, artist, etc.).
virtual bool_t setData (const void *data, int32_t dataSize)=0
 Sets image data.
virtual bool_t setDescription (const char_t *description)=0
 Sets picture description.
virtual bool_t setMimeType (const char *mimeType)=0
 Sets the picture MIME type.
virtual bool_t setPictureType (MetaPictureType::Enum picType)=0
 Sets the picture type (front cover, back cover, artist, etc.).
Public Member Functions inherited from Reference
virtual int32_t release () const =0
 Releases the instance.
virtual int32_t retain () const =0
 Retains the instance.
virtual int32_t retainCount () const =0
 Returns the current reference count.

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

◆ ~MetaPicture()

virtual ~MetaPicture ( )
protectedvirtual

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

See also
primo::Reference::release

Member Function Documentation

◆ clone()

virtual MetaPicture * clone ( ) const
pure virtual

Creates a deep copy of this object.

Returns
A new MetaPicture object. The caller is responsible for releasing the new object when it's not needed anymore.
NULL if the object cannot be cloned because there is not enough memory.
Remarks
When cloned an immutable object becomes mutable.
See also
Object Management

◆ data()

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

Referenced by setData().

◆ 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.

Referenced by setData().

◆ description()

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.

Referenced by setDescription().

◆ immutable()

virtual bool_t immutable ( ) const
pure virtual

Returns whether the object is immutable.

An immmutable object cannot be modified and all modifying methods fail to produce a result.

Returns
TRUE if the object is immutable, FALSE otherwise.
Remarks
An immutable object can be modified by the AVBlocks library.
Object immutability spreads to all nested objects. Therefore it is not possible to add/set an immutable object to a mutable object.
When cloned an immutable object becomes mutable.

◆ mimeType()

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

Referenced by setMimeType().

◆ pictureType()

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

◆ setData()

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

References data(), and dataSize().

◆ setDescription()

virtual bool_t 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.
Returns
TRUE if the description is successfully set, otherwise FALSE.

References description().

◆ setMimeType()

virtual bool_t setMimeType ( const char * mimeType)
pure virtual

Sets the picture MIME type.

Parameters
mimeType[in] A pointer to ANSI string specifying the MIME type
Returns
TRUE if the MIME type is successfully set, otherwise FALSE.
See also
primo::codecs::MimeType

References mimeType().

◆ setPictureType()

virtual bool_t setPictureType ( MetaPictureType::Enum picType)
pure virtual

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

Parameters
[in]picTypeA picture type constant defined in MetaPictureType::Enum.
Returns
TRUE if the picture type is successfully set, otherwise FALSE.
See also
MetaPictureType::Enum