Class ID3_Frame_APIC

Description

Implements interfaces:

The Attached picture frame contains a picture directly related to the audio file. Image format is the MIME type and subtype for the image.

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 same picture type. There is the possibility to put only a link to the image file by using the MIME type "-->" and having a complete URL instead of picture data.

The use of linked files should however be used sparingly since there is the risk of separation of files.

Located in /ID3/Frame/APIC.php (line 63)

ID3_Object
   |
   --ID3_Frame
      |
      --ID3_Frame_APIC
Variable Summary
static Array $types
Method Summary
ID3_Frame_APIC __construct ([Reader $reader = null], [ &$options = array()], Array $options)
string getData ()
string getDescription ()
integer getEncoding ()
integer getImageType ()
string getMimeType ()
void setData (string $imageData)
void setDescription (string $description, [integer $encoding = false])
void setEncoding (integer $encoding)
void setImageType (integer $imageType)
void setMimeType (string $mimeType)
string __toString ()
Variables
static Array $types = array
("Other", "32x32 pixels file icon (PNG only)", "Other file icon",
"Cover (front)", "Cover (back)", "Leaflet page",
"Media (e.g. label side of CD)", "Lead artist/lead performer/soloist",
"Artist/performer", "Conductor", "Band/Orchestra", "Composer",
"Lyricist/text writer", "Recording Location", "During recording",
"During performance", "Movie/video screen capture",
"A bright coloured fish", "Illustration", "Band/artist logotype",
"Publisher/Studio logotype")
(line 71)

The list of image types.

  • access: public

Inherited Variables

Inherited from ID3_Frame

ID3_Frame::$_data

Inherited from ID3_Object

ID3_Object::$_options
ID3_Object::$_reader
Methods
Constructor __construct (line 102)

Constructs the class with given parameters and parses object related data.

  • access: public
ID3_Frame_APIC __construct ([Reader $reader = null], [ &$options = array()], Array $options)
  • Reader $reader: The reader object.
  • Array $options: The options array.
  • &$options

Redefinition of:
ID3_Frame::__construct()
Constructs the class with given parameters and reads object related data from the ID3v2 tag.
getData (line 200)

Returns the embedded image data.

  • access: public
string getData ()
getDescription (line 180)

Returns the file description.

  • access: public
string getDescription ()
getEncoding (line 137)

Returns the text encoding.

  • access: public
integer getEncoding ()

Implementation of:
ID3_Encoding::getEncoding()
Returns the text encoding.
getImageType (line 166)

Returns the image type.

  • access: public
integer getImageType ()
getMimeType (line 152)

Returns the MIME type. The MIME type is always ISO-8859-1 encoded.

  • access: public
string getMimeType ()
setData (line 207)

Sets the embedded image data.

  • access: public
void setData (string $imageData)
  • string $imageData: The image data.

Redefinition of:
ID3_Frame::setData()
Sets the frame raw data.
setDescription (line 188)

Sets the content description text using given encoding.

  • access: public
void setDescription (string $description, [integer $encoding = false])
  • string $description: The content description text.
  • integer $encoding: The text encoding.
setEncoding (line 145)

Sets the text encoding.

void setEncoding (integer $encoding)
  • integer $encoding: The text encoding.

Implementation of:
ID3_Encoding::setEncoding()
Sets the text encoding.
setImageType (line 173)

Sets the image type code.

  • access: public
void setImageType (integer $imageType)
  • integer $imageType: The image type code.
setMimeType (line 159)

Sets the MIME type. The MIME type is always ISO-8859-1 encoded.

  • access: public
void setMimeType (string $mimeType)
  • string $mimeType: The MIME type.
__toString (line 214)

Returns the frame raw data.

  • access: public
string __toString ()

Redefinition of:
ID3_Frame::__toString()
Returns the frame raw data.

Inherited Methods

Inherited From ID3_Frame

ID3_Frame::__construct()
ID3_Frame::getFlags()
ID3_Frame::getIdentifier()
ID3_Frame::getSize()
ID3_Frame::hasFlag()
ID3_Frame::setData()
ID3_Frame::setFlags()
ID3_Frame::setIdentifier()
ID3_Frame::__toString()

Inherited From ID3_Object

ID3_Object::__construct()
ID3_Object::decodeSynchsafe32()
ID3_Object::encodeSynchsafe32()
ID3_Object::getOptions()
ID3_Object::setOptions()
ID3_Object::__get()
ID3_Object::__set()
Class Constants

Documentation generated on Tue, 15 Apr 2008 03:32:54 +0300 by phpDocumentor 1.4.1