Docs For Class MP3_IDv2

$_experimental = false

[line 95]

holds the flag for an experimental flag

Access: protected

Type:

bool

[ Top ]

$_extCRC = null

[line 101]

holds the CRC size of the tag data

Access: protected

Type:

int

[ Top ]

$_extendedHeader = false

[line 89]

holds the flag for that the tag has an extended header

Access: protected

Type:

bool

[ Top ]

$_frames = array()

[line 109]

holds the list of frame of the tag

Var: a list of MP3_IDv2_Frame objects
See: MP3_IDv2_Frame
Access: protected

Type:

array

[ Top ]

$_maxVersion = 3

[line 70]

holds the major version number of the tag

Access: protected

Type:

int

[ Top ]

$_minVersion = 0

[line 76]

holds the minor version number of the tag

Access: protected

Type:

int

[ Top ]

$_size = null

[line 64]

the size of the whole tag excluding the header

Access: protected

Type:

int

[ Top ]

$_unsynchronisation = false

[line 83]

holds the flag for unsynchonized tag data

(everything excluding the tag header)

Access: protected

Type:

bool

[ Top ]

$_useCRC = false

[line 115]

holds the flag for CRC in the extended header

Access: protected

Type:

bool

[ Top ]

addFrame [line 351]

void addFrame(
object MP3_IDv2_Frame
$frame)

Adds a frame to the tag

Access: public

Parameters:

object MP3_IDv2_Frame $frame — the frame to add

[ Top ]

createExtendedHeader [line 298]

string createExtendedHeader(
)

Creates the extended header of the tag depending on the tag settings.

This function does not check if the extended header flag is set!

Return: the extended header of the tag
Access: public

[ Top ]

createHeader [line 256]

string createHeader(
)

Creates the tag header depending on the tag settings

Return: the tag header
Access: public

[ Top ]

createTag [line 362]

string createTag(
)

Creates the whole tag depending on the tag settings.

This includes also the creation of the frames. So you really get the whole tag.

Return: the tag
Access: public

[ Top ]

getCRC [line 246]

int getCRC(
)

Returns the CRC-32 checksum over the tag date

Return: the CRC-32 checksum
Access: public

[ Top ]

getFrameById [line 423]

object MP3_IDv2_Frame getFrameById(
string
$id)

Returns only the first frame with the given id in the tag

Return: the founded frame or null if not found
See: MP3_IDv2_Tag::getFramesById();
Access: public

Parameters:

string $id — the identifer of the frame to catch

[ Top ]

getFrames [line 393]

array getFrames(
)

Returns the frames of the tag.

Return: the list of MP3_IDv2_Frame objects
Access: public

[ Top ]

getFramesById [line 405]

array getFramesById(
string
$id)

Returns all frames identified by their identifiers of the tag.

Return: the list of founded frames as MP3_IDv2_Frame objects
See: MP3_IDv2_Tag::getFrameById()
Access: public

Parameters:

string $id — the identifer of the frames to catch

[ Top ]

getSize [line 157]

int getSize(
)

Returns the size of the tag data.

Return: the size of the tag data excluding the header and extended header
Access: public

[ Top ]

getVersion [line 137]

string getVersion(
)

Returns the version used for building the tag.

Return: the Version as "max.min
Access: public

[ Top ]

isExperimental [line 225]

bool isExperimental(
)

Checks if the tag is an experimental tag

Return: true if tag is experimental
Access: public

[ Top ]

isExtendedHeader [line 204]

bool isExtendedHeader(
)

Checks if tag has an extended header or should create one

Return: true if has one/create one
Access: public

[ Top ]

isUnsynchronisation [line 184]

bool isUnsynchronisation(
)

Returns ift the tag data is unsychonized or should be

Return: true is unsychronisation is activ
Access: public

[ Top ]

setExperimental [line 215]

void setExperimental(
bool
$b)

Marks this tag as experimental (This has no effect on tag handling currently)

Access: public

Parameters:

bool $b — true to mark, false to demark

[ Top ]

setExtendedHeader [line 194]

void setExtendedHeader(
bool
$b)

Enables/diables the usage of an extended tag header

Access: protected

Parameters:

bool $b — true for enable, false for disable

[ Top ]

setSize [line 147]

void setSize(
int
$size)

Sets the size of the tag data.

Access: protected

Parameters:

int $size — the tag data size including the extended header

[ Top ]

setUnsynchronisation [line 174]

void setUnsynchronisation(
bool
$b)

Enables/disable the unsychonisation of the tag data

Access: public

Parameters:

bool $b — true for enabling the unsychronisation, false for disabling

[ Top ]

setVersion [line 125]

void setVersion(
int
$max, int
$min)

Sets the version of the tag.

Actually unused for processing.

Access: public

Parameters:

int	`$max`	—	major version of the tag
int	`$min`	—	minor version

[ Top ]

sync8to7 [line 333]

int sync8to7(
int
$s)

Does the unsynchronisation for the tag size in the header

Return: the unsych size
Access: public

Parameters:

int $s — the size of the tag data+extended header

[ Top ]

useCRC [line 236]

void useCRC(
[bool
$b = true])

Enables or disables the usage of a CRC in the tag

Access: public

Parameters:

bool $b — false for disable

[ Top ]

Class: MP3_IDv2_Tag

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$_experimental = false

$_extCRC = null

$_extendedHeader = false

$_frames = array()

$_maxVersion = 3

$_minVersion = 0

$_size = null

$_unsynchronisation = false

$_useCRC = false

Method Detail

addFrame [line 351]

Parameters:

createExtendedHeader [line 298]

createHeader [line 256]

createTag [line 362]

getCRC [line 246]

getFrameById [line 423]

Parameters:

getFrames [line 393]

getFramesById [line 405]

Parameters:

getSize [line 157]

getVersion [line 137]

isExperimental [line 225]

isExtendedHeader [line 204]

isUnsynchronisation [line 184]

setExperimental [line 215]

Parameters:

setExtendedHeader [line 194]

Parameters:

setSize [line 147]

Parameters:

setUnsynchronisation [line 174]

Parameters:

setVersion [line 125]

Parameters:

sync8to7 [line 333]

Parameters:

useCRC [line 236]

Parameters: