Docs For Class ID3_Frame

Description

Implements interfaces:

The Synchronised lyrics/text frame is another way of incorporating the words, said or sung lyrics, in the audio file as text, this time, however, in sync with the audio. It might also be used to describing events e.g.

occurring on a stage or on the screen in sync with the audio.

There may be more than one SYLT frame in each tag, but only one with the same language and content descriptor.

author: Ryan Butterfield <buttza@gmail.com>
author: Sven Vollbehr <svollbehr@gmail.com>
version: $Rev: 105 $
copyright: Copyright (c) 2008 The PHP Reader Project Workgroup
license: New BSD License

Located in /ID3/Frame/SYLT.php (line 62)

ID3_Object
   |
   --ID3_Frame
      |
      --ID3_Frame_SYLT

Variable Summary

static Array $types

Method Summary

ID3_Frame_SYLT __construct ([Reader $reader = null], [ &$options = array()], Array $options)

string getDescription ()

integer getEncoding ()

Array getEvents ()

integer getFormat ()

string getLanguage ()

integer getType ()

void setDescription (string $description, [string $language = false], [integer $encoding = false])

void setEncoding (integer $encoding)

void setEvents ( $events, [string $language = false], [integer $encoding = false], Array $text)

void setFormat (integer $format)

void setLanguage (string $language)

void setType (integer $type)

string __toString ()

Variables

static Array $types = array
("Other", "Lyrics", "Text transcription", "Movement/Part name", "Events",
"Chord", "Trivia", "URLs to webpages", "URLs to images") (line 70)

The list of content types.

access: public

Inherited Variables

Inherited from ID3_Frame

ID3_Frame::$_data

Inherited from ID3_Object

ID3_Object::$_reader

Methods

Constructor __construct (line 98)

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

access: public

ID3_Frame_SYLT __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.

getDescription (line 225)

Returns the content description.

access: public

string getDescription ()

getEncoding (line 159)

Returns the text encoding.

access: public

integer getEncoding ()

Implementation of:

ID3_Encoding::getEncoding(): Returns the text encoding.

getEvents (line 250)

Returns the syllable events with their timestamps.

access: public

Array getEvents ()

getFormat (line 196)

Returns the timing format.

access: public

integer getFormat ()

Implementation of:

ID3_Timing::getFormat(): Returns the timing format.

getLanguage (line 175)

Returns the language code as specified in the ISO-639-2 standard.

access: public

string getLanguage ()

Implementation of:

ID3_Language::getLanguage(): Returns the text language code.

getType (line 211)

Returns the content type code.

access: public

integer getType ()

setDescription (line 235)

Sets the content description text using given encoding. The description language and encoding must be that of the actual text.

access: public

void setDescription (string $description, [string $language = false], [integer $encoding = false])

string $description: The content description text.
string $language: The language code.
integer $encoding: The text encoding.

setEncoding (line 167)

Sets the text encoding.

see: ID3_Encoding
access: public

void setEncoding (integer $encoding)

integer $encoding: The text encoding.

Implementation of:

ID3_Encoding::setEncoding(): Sets the text encoding.

setEvents (line 260)

Sets the syllable events with their timestamps using given encoding.

The text language and encoding must be that of the description text.

access: public

void setEvents ( $events, [string $language = false], [integer $encoding = false], Array $text)

Array $text: The test string.
string $language: The language code.
integer $encoding: The text encoding.
$events

setFormat (line 204)

Sets the timing format.

see: ID3_Timing
access: public

void setFormat (integer $format)

integer $format: The timing format.

Implementation of:

ID3_Timing::setFormat(): Sets the timing format.

setLanguage (line 184)

Sets the text language code as specified in the ISO-639-2 standard.

see: ID3_Language
access: public

void setLanguage (string $language)

string $language: The language code.

Implementation of:

ID3_Language::setLanguage(): Sets the text language code.

setType (line 218)

Sets the content type code.

access: public

void setType (integer $type)

integer $type: The content type code.

__toString (line 275)

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::decodeUnsynchronisation()
ID3_Object::encodeSynchsafe32()
ID3_Object::encodeUnsynchronisation()
ID3_Object::explodeString8()
ID3_Object::explodeString16()
ID3_Object::getOption()
ID3_Object::getOptions()
ID3_Object::setOption()
ID3_Object::setOptions()
ID3_Object::__get()
ID3_Object::__set()

Class Constants

Inherited Constants

Inherited from ID3_Frame

ID3_Frame::COMPRESSION
ID3_Frame::DATA_LENGTH_INDICATOR
ID3_Frame::DISCARD_ON_FILECHANGE
ID3_Frame::DISCARD_ON_TAGCHANGE
ID3_Frame::ENCRYPTION
ID3_Frame::GROUPING_IDENTITY
ID3_Frame::READ_ONLY
ID3_Frame::UNSYNCHRONISATION

Class ID3_Frame_SYLT

Inherited Variables

Inherited Methods

Inherited Constants