Class: MP3_IDv2_Frame_CommonText

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

Class Overview

MP3_IDv2_Frame
   |
   --MP3_IDv2_Frame_CommonText

Data stucture for text frames in a tag.

Author(s):

Alexander Merz <alexander.merz at web.de>

Version:

Release: @package_version@

Copyright:

2006-2007 Alexander Merz

Methods

Child classes:

MP3_IDv2_Frame_TPE3: Data stucture for TPE3 frame in a tag (Conductor)

MP3_IDv2_Frame_TCON: Data stucture for TCON frames in a tag (Content type)

MP3_IDv2_Frame_TOAL: Data stucture for TOAL frame in a tag (Original album/movie/show title)

MP3_IDv2_Frame_TRSO: Data stucture for TRSO frame in a tag (Internet radio station owner)

MP3_IDv2_Frame_TIT3: Data stucture for TIT3 frames in a tag (Subtitle/Description refinement)

MP3_IDv2_Frame_TIT2: Data stucture for the TIT2 frame in a tag (Title/Songname/Content description)

MP3_IDv2_Frame_TENC: Data stucture for TENC frames in a tag (Encoded by)

MP3_IDv2_Frame_TOWN: Data stucture for TOWN frame in a tag (File owner/licensee)

MP3_IDv2_Frame_TPE4: Data stucture for TPE4 frame in a tag (Interpreted, remixed, or otherwise modified by)

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

MP3_IDv2_Frame_TYER: Data stucture for TYER frame in a tag (Year of recording)

MP3_IDv2_Frame_TORY: Data stucture for TORY frame in a tag (Original release year)

MP3_IDv2_Frame_TXXX: Data stucture for TXXX frame in a tag (User-defined text frame)

MP3_IDv2_Frame_TPUB: Data stucture for TPUB frame in a tag (Publisher)

MP3_IDv2_Frame_TSIZ: Data stucture for TSIZ frame in a tag (Size of the audiodata)

MP3_IDv2_Frame_TPOS: Data stucture for TPOS frame in a tag (Part of a set)

MP3_IDv2_Frame_IPLS: Data stucture for IPLS frame in a tag (Involved people list)

MP3_IDv2_Frame_TRCK: Data stucture for TRCK frame in a tag (Track number/Position in set)

MP3_IDv2_Frame_TDAT: Data stucture for TDAT frames in a tag (Date) This frame isn't part of 2.4.

MP3_IDv2_Frame_TSSE: Data stucture for TSSE frame in a tag (Software/Hardware and settings used for encoding)

MP3_IDv2_Frame_TBPM: Data stucture for TBPM frame in a tag (Beats per minute)

MP3_IDv2_Frame_TPE2: Data stucture for TPE2 frames in a tag (Band/Orchestra/Accompaniment)

MP3_IDv2_Frame_TKEY: Data stucture for TKEY frames in a tag (Initial key)

MP3_IDv2_Frame_TALB: Data stucture for TALB frame in a tag (Album/Movie/Show title)

MP3_IDv2_Frame_TLAN: Data stucture for TLAN frames in a tag (Language(s))

MP3_IDv2_Frame_TSRC: Data stucture for TSRC frame in a tag (ISRC data)

MP3_IDv2_Frame_TOFN: Data stucture for TOFN frame in a tag (Original filename)

MP3_IDv2_Frame_TDLY: Data stucture for TDLY frames in a tag (Playlist delay)

MP3_IDv2_Frame_TLEN: Data stucture for TLEN frames in a tag (Audio length)

MP3_IDv2_Frame_TIME: Data stucture for TIME frames in a tag

MP3_IDv2_Frame_TFLT: Data stucture for TFLT frames in a tag (File type)

MP3_IDv2_Frame_TRSN: Data stucture for TRSN frame in a tag (Internet radio station name)

MP3_IDv2_Frame_TIT1: Data stucture for TIT1 frames in a tag (Content group description)

MP3_IDv2_Frame_TRDA: Data stucture for TRDA frame in a tag (Recording dates)

MP3_IDv2_Frame_TEXT: Data stucture for TEXT frames in a tag

MP3_IDv2_Frame_TMED: Data stucture for TMED frames in a tag (Media type)

MP3_IDv2_Frame_TCOP: Data stucture for TCOP frames in a tag (Copyright message)

MP3_IDv2_Frame_TCOM: Data stucture for TCOM frame in a tag (Composer(s))

Inherited Variables

Class: MP3_IDv2_Frame

MP3_IDv2_Frame::$_changed
MP3_IDv2_Frame::$_content
MP3_IDv2_Frame::$_decompressedSize
MP3_IDv2_Frame::$_encryptionMethod
MP3_IDv2_Frame::$_flagCompression
MP3_IDv2_Frame::$_flagEncryption
MP3_IDv2_Frame::$_flagFileAlterPres
MP3_IDv2_Frame::$_flagGroup
MP3_IDv2_Frame::$_flagReadOnly
MP3_IDv2_Frame::$_flagTagAlterPres
MP3_IDv2_Frame::$_groupid
MP3_IDv2_Frame::$_id
MP3_IDv2_Frame::$_purpose

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 56]
Data stucture for text frames in a tag.

These frames starts with a T in the frame identifier except 'txxx'

A text frame consists of a starting single byte for the encoding of the text and is followed by a string of arbitrary length. A string may separated into multiple parts using a null value.

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

[ Top ]

Method Detail

createContent [line 132]

string createContent(
)

Creates the content of the frame (encoding+text)

Return: the frame content
Access: public

Overridden in child classes as:

MP3_IDv2_Frame_TXXX::createContent(): Creates the whole content (descr+value).

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

[ Top ]

getEncoding [line 120]

string getEncoding(
)

Returns the encoding identifier for the text in the frame.

Return: the identifier
Access: public

[ Top ]

getText [line 94]

string getText(
)

Returns the text in the frame.

Return: the text
Access: public

Overridden in child classes as:

MP3_IDv2_Frame_TCON::getText(): Returns the text

[ Top ]

setEncoding [line 107]

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 ]

setRawContent [line 145]

void setRawContent(
string
$content)

Sets the data of the frame and processes it.

Access: public

Overridden in child classes as:

MP3_IDv2_Frame_TCON::setRawContent(): Sets the data of the frame and processes it.

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

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

Parameters:

string $content — the unproccess content for the frame

[ Top ]

setText [line 81]

void setText(
string
$text)

Sets the text for the frame.

Access: public

Parameters:

string $text — the text to set

[ Top ]

toString [line 163]

string toString(
)

Returns the frame content as something printable

Return: the frame content
Access: public

Overridden in child classes as:

MP3_IDv2_Frame_TCON::toString(): Returns the frame content as something printable

MP3_IDv2_Frame_TXXX::toString(): Returns the frame content as something printable

MP3_IDv2_Frame_IPLS::toString(): Returns the frame content as something printable

MP3_IDv2_Frame_TCOP::toString(): Returns the frame content as something printable

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

[ Top ]