Docs For Class MP3_IDv2_Frame

Class: MP3_IDv2_Frame_TPE1

Class Overview

MP3_IDv2_Frame
   |
   --MP3_IDv2_Frame_CommonText
      |
      --MP3_IDv2_Frame_TPE1

Data stucture for TPE1 frame in a tag (Lead artist(s)/Lead performer(s)/Soloist(s)/Performing group)

Author(s):

Alexander Merz <alexander.merz at web.de>

Version:

Release: @package_version@

Copyright:

2006 Alexander Merz

Methods

Class: MP3_IDv2_Frame_CommonText

MP3_IDv2_Frame_CommonText::createContent(): Creates the content of the frame (encoding+text)
MP3_IDv2_Frame_CommonText::getEncoding(): Returns the encoding identifier for the text in the frame.
MP3_IDv2_Frame_CommonText::getText(): Returns the text in the frame.
MP3_IDv2_Frame_CommonText::setEncoding(): Sets the encoding for the text for the frame.
MP3_IDv2_Frame_CommonText::setRawContent(): Sets the data of the frame and processes it.
MP3_IDv2_Frame_CommonText::setText(): Sets the text for the frame.
MP3_IDv2_Frame_CommonText::toString(): Returns the frame content as something printable

Class: MP3_IDv2_Frame

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 47]
Data stucture for TPE1 frame in a tag (Lead artist(s)/Lead performer(s)/Soloist(s)/Performing group)

Author: Alexander Merz <alexander.merz@web.de>
Version: Release: @package_version@
Copyright: 2006 Alexander Merz
Link: http://pear.php.net/package/MP3_IDv2
Since: Class available since Release 0.1.0

Method Detail

__construct (Constructor) [line 53]

MP3_IDv2_Frame_TPE1 __construct(
)

Sets the id and purpose of the frame only

Access: public

Overridden in child classes as:

MP3_IDv2_Frame_TOPE::__construct(): Sets the id and purpose of the frame only

[ Top ]

addArtist [line 72]

void addArtist(
string
$artist)

Adds an artist to the artists

Access: public

Parameters:

string $artist — an artist

[ Top ]

getArtists [line 63]

array getArtists(
)

Returns the artists as list of strings

Return: list of the artists
Access: public

[ Top ]

Class: MP3_IDv2_Frame_TPE1

Class Overview

Author(s):

Version:

Copyright:

Methods

Child classes:

Inherited Variables

Class: MP3_IDv2_Frame

Inherited Methods

Class: MP3_IDv2_Frame_CommonText

Class: MP3_IDv2_Frame

Class Details

Method Detail

__construct (Constructor) [line 53]

addArtist [line 72]

Parameters:

getArtists [line 63]