Class ID3_Frame_SYTC

Description

Implements interfaces:

For a more accurate description of the tempo of a musical piece, the Synchronised tempo codes frame might be used.

The tempo data consists of one or more tempo codes. Each tempo code consists of one tempo part and one time part. The tempo is in BPM described with one or two bytes. If the first byte has the value $FF, one more byte follows, which is added to the first giving a range from 2 - 510 BPM, since $00 and $01 is reserved. $00 is used to describe a beat-free time period, which is not the same as a music-free time period. $01 is used to indicate one single beat-stroke followed by a beat-free period.

The tempo descriptor is followed by a time stamp. Every time the tempo in the music changes, a tempo descriptor may indicate this for the player. All tempo descriptors must be sorted in chronological order. The first beat-stroke in a time-period is at the same time as the beat description occurs. There may only be one SYTC frame in each tag.

  • author: Sven Vollbehr <svollbehr@gmail.com>
  • version: $Rev: 75 $
  • copyright: Copyright (c) 2008 The PHP Reader Project Workgroup
  • todo: The data could be parsed further; data samples needed
  • license: New BSD License

Located in /ID3/Frame/SYTC.php (line 69)

ID3_Object
   |
   --ID3_Frame
      |
      --ID3_Frame_SYTC
Method Summary
ID3_Frame_SYTC __construct ([Reader $reader = null], [ &$options = array()], Array $options)
string getData ()
integer getFormat ()
void setData ( $tempoData, string $data)
void setFormat (integer $format)
string __toString ()
Variables

Inherited Variables

Inherited from ID3_Frame

ID3_Frame::$_data

Inherited from ID3_Object

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

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

  • access: public
ID3_Frame_SYTC __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.
getData (line 115)

Returns the tempo data.

  • access: public
string getData ()
getFormat (line 100)

Returns the timing format.

  • access: public
integer getFormat ()

Implementation of:
ID3_Timing::getFormat()
Returns the timing format.
setData (line 122)

Sets the tempo data.

  • access: public
void setData ( $tempoData, string $data)
  • string $data: The data string.
  • $tempoData

Redefinition of:
ID3_Frame::setData()
Sets the frame raw data.
setFormat (line 108)

Sets the timing format.

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

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

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:28 +0300 by phpDocumentor 1.4.1