MP3_IDv2
[ class tree: MP3_IDv2 ] [ index: MP3_IDv2 ] [ all elements ]

Class: MP3_IDv2_Frame_APIC

Source Location: /MP3_IDv2-0.1.8/MP3/IDv2/Frame/APIC.php

Class Overview

MP3_IDv2_Frame
   |
   --MP3_IDv2_Frame_APIC

Data stucture for APIC frames in a tag.


Author(s):

Version:

  • Release: @package_ version@

Copyright:

  • 2006-2007 Alexander Merz

Methods


Inherited Variables

Inherited Methods

Class: MP3_IDv2_Frame

MP3_IDv2_Frame::__construct()
Constructor
MP3_IDv2_Frame::createContent()
Creates the content from the frame data parts.
MP3_IDv2_Frame::createFrame()
Creates the whole frame (header + headerdata + content).
MP3_IDv2_Frame::createHeader()
Creates the header of the frame including the header extension according to the frame settings.
MP3_IDv2_Frame::getEncryptionMethod()
Get the encryption method for the frame data.
MP3_IDv2_Frame::getGroupIdentifier()
Get the group identifier of the frame
MP3_IDv2_Frame::getId()
Returns the identifier of the frame.
MP3_IDv2_Frame::getInstance()
Singleton method the create a specific frame object.
MP3_IDv2_Frame::getPurpose()
Returns the purpose of the frame
MP3_IDv2_Frame::getRawContent()
Returns the unprocessed content of the frame (excluding header)
MP3_IDv2_Frame::hasGroupingIdentifier()
Checks if the frame belongs to a group or should be
MP3_IDv2_Frame::isCompressed()
Checks if the frame data is compressed or should be
MP3_IDv2_Frame::isEncrypted()
Checks if the frame data is encrypted or should be
MP3_IDv2_Frame::isFlagFileAlterPres()
Checks if the header flag "File alter preservation" is set.
MP3_IDv2_Frame::isFlagReadOnly()
Checks if the frame is marked as read only
MP3_IDv2_Frame::isFlagTagAlterPres()
Checks if the header flag "Tag alter preservation" is set.
MP3_IDv2_Frame::setEncryptionMethod()
Sets the encryption method
MP3_IDv2_Frame::setFlagFileAlterPres()
Sets the header flag "File alter preservation"
MP3_IDv2_Frame::setFlagReadOnly()
Sets the header flag "Read only".
MP3_IDv2_Frame::setFlagTagAlterPres()
Sets the header flag "Tag alter preservation"
MP3_IDv2_Frame::setGroupIdentifier()
Sets the grouping identifier for the frame.
MP3_IDv2_Frame::setId()
Sets the identifier of the frame.
MP3_IDv2_Frame::setPurpose()
Sets the purpose text of the frame
MP3_IDv2_Frame::setRawContent()
Sets the unproccess content of the frame (excluding header!)
MP3_IDv2_Frame::toString()
Returns the frame content as something printable
MP3_IDv2_Frame::useCompression()
Enables/disables the compression of the frame data
MP3_IDv2_Frame::useEncryption()
Enables/disables the use of encryption for the frame data
MP3_IDv2_Frame::useGroupingIdentifier()
Enables/disables the use of a group identifier

Class Details

[line 80]
Data stucture for APIC frames in a tag.

(Attached Picture)



[ Top ]


Method Detail

__construct (Constructor)   [line 410]

MP3_IDv2_Frame_APIC __construct( )

Sets the id and purpose of the frame only
  • Access: public

Overrides MP3_IDv2_Frame::__construct() (Constructor)
[ Top ]

createContent   [line 312]

string createContent( )

Creates the content of the frame (encoding+text)
  • Return: the frame content
  • Access: public

Overrides MP3_IDv2_Frame::createContent() (Creates the content from the frame data parts.)
[ Top ]

getDescription   [line 266]

string getDescription( [bool $nul = false])

Returns the description of the picture
  • Return: the description
  • Access: public

Parameters:

bool   $nul   —  if true, deliever with ending null

[ Top ]

getEncoding   [line 160]

string getEncoding( )

Returns the encoding identifier for the text in the frame.
  • Return: the identifier
  • Access: public

[ Top ]

getMimeType   [line 190]

string getMimeType( [bool $nul = false])

Returns the mime type of the picture
  • Return: the mime type
  • Access: public

Parameters:

bool   $nul   —  if true, deliever with ending null

[ Top ]

getPicture   [line 300]

string getPicture( )

Returns the mime type of the picture
  • Return: the mime type
  • Access: public

[ Top ]

getType   [line 221]

string getType( )

Returns the picture type.
  • Return: the picture type
  • Access: public

[ Top ]

getTypeDescr   [line 232]

string getTypeDescr( )

Returns the description of the picture type.
  • Return: the picture type
  • Access: public

[ Top ]

readFromFile   [line 394]

void readFromFile( string $file)

Reads the picture data from a file
  • Access: public

Parameters:

string   $file   —  the file name

[ Top ]

setDescription   [line 249]

void setDescription( string $descr)

Sets the description of the picture
  • Access: public

Parameters:

string   $descr   —  the description

[ Top ]

setEncoding   [line 148]

void setEncoding( string $enc)

Sets the encoding for the text for the frame.
  • Access: public

Parameters:

string   $enc   —  the byte containing the encoding identifier

[ Top ]

setMimeType   [line 173]

void setMimeType( string $mime)

Sets the mime type of the picture
  • Access: public

Parameters:

string   $mime   —  the mime type

[ Top ]

setPicture   [line 285]

void setPicture( string $data)

Sets the picture binary data
  • Access: public

Parameters:

string   $data   —  the binary picture data

[ Top ]

setRawContent   [line 329]

void setRawContent( string $content)

Sets the data of the frame and processes it.
  • Access: public

Overrides MP3_IDv2_Frame::setRawContent() (Sets the unproccess content of the frame (excluding header!))

Parameters:

string   $content   —  the unproccess content for the frame

[ Top ]

setType   [line 209]

void setType( string $type)

Sets the picture type.
  • Access: public

Parameters:

string   $type   —  the picture type

[ Top ]

toString   [line 422]

string toString( )

Returns the frame content as something printable
  • Return: the frame content
  • Access: public

Overrides MP3_IDv2_Frame::toString() (Returns the frame content as something printable)
[ Top ]

writeToFile   [line 373]

bool writeToFile( string $file)

Writes the picture data to a file
  • Return: true if file could written
  • Access: public

Parameters:

string   $file   —  the file name

[ Top ]


Documentation generated on Mon, 11 Mar 2019 15:49:42 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.