org.farng.mp3.id3
Class FrameBodyAPIC

java.lang.Object
  extended byorg.farng.mp3.AbstractMP3FileItem
      extended byorg.farng.mp3.AbstractMP3FragmentBody
          extended byorg.farng.mp3.id3.AbstractID3v2FrameBody
              extended byorg.farng.mp3.id3.FrameBodyAPIC

public class FrameBodyAPIC
extends AbstractID3v2FrameBody

4.14.   Attached picture

   This frame contains a picture directly related to the audio file.
   Image format is the MIME type and subtype [MIME] for the image. In
   the event that the MIME media type name is omitted, "image/" will be

   implied. The "image/png" [PNG] or "image/jpeg" [JFIF] picture format
   should be used when interoperability is wanted. Description is a
   short description of the picture, represented as a terminated

   text string. There may be several pictures attached to one file, each
   in their individual "APIC" frame, but only one with the same content
   descriptor. There may only be one picture with the picture type
   declared as picture type $01 and $02 respectively. There is the

   possibility to put only a link to the image file by using the 'MIME
   type' "-->" and having a complete URL [URL] instead of picture data.
   The use of linked files should however be used sparingly since there
   is the risk of separation of files.

     <Header for 'Attached picture', ID: "APIC">
     Text encoding      $xx
     MIME type          <text string>

$00
     Picture type       $xx
     Description        <text string according to encoding> $00 (00)

     Picture data       <binary data>

   Picture type:  $00  Other
                 

$01  32x32 pixels 'file icon' (PNG only)
                  $02  Other file icon
                  $03  Cover (front)

                  $04  Cover (back)
                  $05  Leaflet page
                  $06  Media (e.g. label side of CD)

                  $07  Lead artist/lead performer/soloist
                  $08  Artist/performer
                  $09  Conductor

                  $0A  Band/Orchestra
                  $0B  Composer
                  $0C  Lyricist/text writer

                  $0D  Recording Location
                  $0E  During recording
                  $0F  During performance

                  $10  Movie/video screen capture
                  $11  A bright coloured fish
                  $12  Illustration

                  $13  Band/artist logotype
                  $14  Publisher/Studio logotype

Version:
$Revision: 1.4 $
Author:
Eric Farng

Constructor Summary
FrameBodyAPIC()
          Creates a new FrameBodyAPIC object.
FrameBodyAPIC(byte textEncoding, java.lang.String mimeType, byte pictureType, java.lang.String description, byte[] data)
          Creates a new FrameBodyAPIC object.
FrameBodyAPIC(FrameBodyAPIC body)
          Creates a new FrameBodyAPIC object.
FrameBodyAPIC(java.io.RandomAccessFile file)
          Creates a new FrameBodyAPIC object.
 
Method Summary
 java.lang.String getDescription()
          This method calls toString for all it's objects and appends them.
 java.lang.String getIdentifier()
          ID string that usually corresponds to the class name, but can be displayed to the user.
 void setDescription(java.lang.String description)
           
protected  void setupObjectList()
          Create the order of MP3Object objects that this body expects.
 
Methods inherited from class org.farng.mp3.id3.AbstractID3v2FrameBody
equals, readHeader, writeHeader
 
Methods inherited from class org.farng.mp3.AbstractMP3FragmentBody
appendToObjectList, getBriefDescription, getObject, getObjectListIterator, getSize, has6ByteHeader, isSubsetOf, iterator, read, setObject, toString, write
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FrameBodyAPIC

public FrameBodyAPIC()
Creates a new FrameBodyAPIC object.


FrameBodyAPIC

public FrameBodyAPIC(FrameBodyAPIC body)
Creates a new FrameBodyAPIC object.


FrameBodyAPIC

public FrameBodyAPIC(byte textEncoding,
                     java.lang.String mimeType,
                     byte pictureType,
                     java.lang.String description,
                     byte[] data)
Creates a new FrameBodyAPIC object.


FrameBodyAPIC

public FrameBodyAPIC(java.io.RandomAccessFile file)
              throws java.io.IOException,
                     InvalidTagException
Creates a new FrameBodyAPIC object.

Method Detail

setDescription

public void setDescription(java.lang.String description)

getDescription

public java.lang.String getDescription()
Description copied from class: AbstractMP3FragmentBody
This method calls toString for all it's objects and appends them. It contains new line characters and is more suited for display purposes

Overrides:
getDescription in class AbstractMP3FragmentBody
Returns:
formatted description string

getIdentifier

public java.lang.String getIdentifier()
Description copied from class: AbstractMP3FileItem
ID string that usually corresponds to the class name, but can be displayed to the user. It is not indended to identify each individual instance.

Specified by:
getIdentifier in class AbstractMP3FileItem
Returns:
ID string

setupObjectList

protected void setupObjectList()
Description copied from class: AbstractMP3FragmentBody
Create the order of MP3Object objects that this body expects. This method needs to be overwritten.

Specified by:
setupObjectList in class AbstractMP3FragmentBody


Copyright (c) 2004 Eric Farng