Docs For Class ID3_Frame

Description

Implements interfaces:

ID3_Timing

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

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

ID3_Object
   |
   --ID3_Frame
      |
      --ID3_Frame_SYTC

Class Constant Summary

BEAT_FREE = 0x00

SINGLE_BEAT = 0x01

Method Summary

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

Array getEvents ()

integer getFormat ()

void setEvents (Array $events)

void setFormat (integer $format)

string __toString ()

Variables

Inherited Variables

Inherited from ID3_Frame

ID3_Frame::$_data

Inherited from ID3_Object

ID3_Object::$_reader

Methods

Constructor __construct (line 90)

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.

getEvents (line 130)

Returns the time-bpm tempo events.

access: public

Array getEvents ()

getFormat (line 115)

Returns the timing format.

access: public

integer getFormat ()

Implementation of:

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

setEvents (line 137)

Sets the time-bpm tempo events.

access: public

void setEvents (Array $events)

Array $events: The time-bpm tempo events.

setFormat (line 123)

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.

__toString (line 148)

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

BEAT_FREE = 0x00 (line 73)

Describes a beat-free time period.

SINGLE_BEAT = 0x01 (line 76)

Indicate one single beat-stroke followed by a beat-free period.

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_SYTC

Inherited Variables

Inherited Methods

Inherited Constants