TagLib 1.7.2 (TagLib::ID3v2::AttachedPictureFrame Class Reference)

TagLib::ID3v2::AttachedPictureFrame Class Reference

An ID3v2 attached picture frame implementation. More...

#include <attachedpictureframe.h>

Inheritance diagram for TagLib::ID3v2::AttachedPictureFrame:
Collaboration diagram for TagLib::ID3v2::AttachedPictureFrame:

List of all members.

Public Types

enum  Type {
  Other = 0x00, FileIcon = 0x01, OtherFileIcon = 0x02, FrontCover = 0x03,
  BackCover = 0x04, LeafletPage = 0x05, Media = 0x06, LeadArtist = 0x07,
  Artist = 0x08, Conductor = 0x09, Band = 0x0A, Composer = 0x0B,
  Lyricist = 0x0C, RecordingLocation = 0x0D, DuringRecording = 0x0E, DuringPerformance = 0x0F,
  MovieScreenCapture = 0x10, ColouredFish = 0x11, Illustration = 0x12, BandLogo = 0x13,
  PublisherLogo = 0x14
}

Public Member Functions

 AttachedPictureFrame ()
 AttachedPictureFrame (const ByteVector &data)
virtual ~AttachedPictureFrame ()
virtual String toString () const
String::Type textEncoding () const
void setTextEncoding (String::Type t)
String mimeType () const
void setMimeType (const String &m)
Type type () const
void setType (Type t)
String description () const
void setDescription (const String &desc)
ByteVector picture () const
void setPicture (const ByteVector &p)

Protected Member Functions

virtual void parseFields (const ByteVector &data)
virtual ByteVector renderFields () const

Protected Attributes

AttachedPictureFramePrivate * d

Friends

class FrameFactory

Detailed Description

An ID3v2 attached picture frame implementation.

This is an implementation of ID3v2 attached pictures. Pictures may be included in tags, one per APIC frame (but there may be multiple APIC frames in a single tag). These pictures are usually in either JPEG or PNG format.


Member Enumeration Documentation

This describes the function or content of the picture.

Enumerator:
Other 

A type not enumerated below.

FileIcon 

32x32 PNG image that should be used as the file icon

OtherFileIcon 

File icon of a different size or format.

FrontCover 

Front cover image of the album.

BackCover 

Back cover image of the album.

LeafletPage 

Inside leaflet page of the album.

Media 

Image from the album itself.

LeadArtist 

Picture of the lead artist or soloist.

Artist 

Picture of the artist or performer.

Conductor 

Picture of the conductor.

Band 

Picture of the band or orchestra.

Composer 

Picture of the composer.

Lyricist 

Picture of the lyricist or text writer.

RecordingLocation 

Picture of the recording location or studio.

DuringRecording 

Picture of the artists during recording.

DuringPerformance 

Picture of the artists during performance.

MovieScreenCapture 

Picture from a movie or video related to the track.

ColouredFish 

Picture of a large, coloured fish.

Illustration 

Illustration related to the track.

BandLogo 

Logo of the band or performer.

PublisherLogo 

Logo of the publisher (record company)


Constructor & Destructor Documentation

TagLib::ID3v2::AttachedPictureFrame::AttachedPictureFrame ( )

Constructs an empty picture frame. The description, content and text encoding should be set manually.

TagLib::ID3v2::AttachedPictureFrame::AttachedPictureFrame ( const ByteVector data) [explicit]

Constructs an AttachedPicture frame based on data.

virtual TagLib::ID3v2::AttachedPictureFrame::~AttachedPictureFrame ( ) [virtual]

Destroys the AttahcedPictureFrame instance.


Member Function Documentation

String TagLib::ID3v2::AttachedPictureFrame::description ( ) const

Returns a text description of the image.

See also:
setDescription()
textEncoding()
setTextEncoding()
String TagLib::ID3v2::AttachedPictureFrame::mimeType ( ) const

Returns the mime type of the image. This should in most cases be "image/png" or "image/jpeg".

virtual void TagLib::ID3v2::AttachedPictureFrame::parseFields ( const ByteVector data) [protected, virtual]

Called by parse() to parse the field data. It makes this information available through the public API. This must be overridden by the subclasses.

Implements TagLib::ID3v2::Frame.

Reimplemented in TagLib::ID3v2::AttachedPictureFrameV22.

ByteVector TagLib::ID3v2::AttachedPictureFrame::picture ( ) const

Returns the image data as a ByteVector.

Note:
ByteVector has a data() method that returns a const char * which should make it easy to export this data to external programs.
See also:
setPicture()
mimeType()
virtual ByteVector TagLib::ID3v2::AttachedPictureFrame::renderFields ( ) const [protected, virtual]

Render the field data back to a binary format in a ByteVector. This must be overridden by subclasses.

Implements TagLib::ID3v2::Frame.

void TagLib::ID3v2::AttachedPictureFrame::setDescription ( const String desc)

Sets a textual description of the image to desc.

See also:
description()
textEncoding()
setTextEncoding()
void TagLib::ID3v2::AttachedPictureFrame::setMimeType ( const String m)

Sets the mime type of the image. This should in most cases be "image/png" or "image/jpeg".

void TagLib::ID3v2::AttachedPictureFrame::setPicture ( const ByteVector p)

Sets the image data to p. p should be of the type specified in this frame's mime-type specification.

See also:
picture()
mimeType()
setMimeType()
void TagLib::ID3v2::AttachedPictureFrame::setTextEncoding ( String::Type  t)

Set the text encoding used for the description.

See also:
description()
void TagLib::ID3v2::AttachedPictureFrame::setType ( Type  t)

Sets the type for the image.

See also:
Type
type()
String::Type TagLib::ID3v2::AttachedPictureFrame::textEncoding ( ) const

Returns the text encoding used for the description.

See also:
setTextEncoding()
description()
virtual String TagLib::ID3v2::AttachedPictureFrame::toString ( ) const [virtual]

Returns a string containing the description and mime-type

Implements TagLib::ID3v2::Frame.

Type TagLib::ID3v2::AttachedPictureFrame::type ( ) const

Returns the type of the image.

See also:
Type
setType()

Friends And Related Function Documentation

friend class FrameFactory [friend]

Reimplemented from TagLib::ID3v2::Frame.

Reimplemented in TagLib::ID3v2::AttachedPictureFrameV22.


Member Data Documentation

AttachedPictureFramePrivate* TagLib::ID3v2::AttachedPictureFrame::d [protected]

Reimplemented from TagLib::ID3v2::Frame.


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