Class ID3_Frame_ETCO

Description

Implements interfaces:

The Event timing codes allows synchronisation with key events in the audio.

The events are an array of timestamp and type pairs. The time stamp is set to zero if directly at the beginning of the sound or after the previous event. All events are sorted in chronological order.

The events $E0-EF are for user events. You might want to synchronise your music to something, like setting off an explosion on-stage, activating a screensaver etc.

There may only be one ETCO frame in each tag.

Located in /ID3/Frame/ETCO.php (line 64)

ID3_Object
   |
   --ID3_Frame
      |
      --ID3_Frame_ETCO
Variable Summary
static Array $types
Method Summary
ID3_Frame_ETCO __construct ([Reader $reader = null], [ &$options = array()], Array $options)
Array getEvents ()
integer getFormat ()
void setEvents (Array $events, [integer $format = false])
void setFormat (integer $format)
string __toString ()
Variables
static Array $types = array
("Padding", "End of initial silence", "Intro start", "Main part start",
"Outro start", "Outro end", "Verse start","Refrain start",
"Interlude start", "Theme start", "Variation start", "Key change",
"Time change", "Momentary unwanted noise", "Sustained noise",
"Sustained noise end", "Intro end", "Main part end", "Verse end",
"Refrain end", "Theme end", "Profanity", "Profanity end",

0xe0 => "User event", "User event", "User event", "User event",
"User event", "User event", "User event", "User event", "User event",
"User event", "User event", "User event", "User event", "User event",

0xfd => "Audio end (start of silence)", "Audio file ends",
"One more byte of events follows")
(line 72)

The list of event types.

  • access: public

Inherited Variables

Inherited from ID3_Frame

ID3_Frame::$_data

Inherited from ID3_Object

ID3_Object::$_options
ID3_Object::$_reader
Methods
Constructor __construct (line 99)

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

  • access: public
ID3_Frame_ETCO __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.
getEvents (line 137)

Returns the events as an associated array having the timestamps as keys and the event types as values.

  • access: public
Array getEvents ()
getFormat (line 121)

Returns the timing format.

  • access: public
integer getFormat ()

Implementation of:
ID3_Timing::getFormat()
Returns the timing format.
setEvents (line 146)

Sets the events using given format. The value must be an associated array having the timestamps as keys and the event types as values.

  • access: public
void setEvents (Array $events, [integer $format = false])
  • Array $events: The events array.
  • integer $format: The timing format.
setFormat (line 129)

Sets the timing format.

void setFormat (integer $format)
  • integer $format: The timing format.

Implementation of:
ID3_Timing::setFormat()
Sets the timing format.
__toString (line 158)

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::encodeSynchsafe32()
ID3_Object::getOptions()
ID3_Object::setOptions()
ID3_Object::__get()
ID3_Object::__set()
Class Constants

Documentation generated on Tue, 15 Apr 2008 03:33:02 +0300 by phpDocumentor 1.4.1