Class ID3_Frame_ASPI

Description

Audio files with variable bit rates are intrinsically difficult to deal with

in the case of seeking within the file. The Audio seek point index or ASPI frame makes seeking easier by providing a list a seek points within the audio file. The seek points are a fractional offset within the audio data, providing a starting point from which to find an appropriate point to start decoding. The presence of an ASPI frame requires the existence of a ID3_Frame_TLEN frame, indicating the duration of the file in milliseconds. There may only be one audio seek point index frame in a tag.

  • author: Sven Vollbehr <svollbehr@gmail.com>
  • version: $Rev: 75 $
  • copyright: Copyright (c) 2008 The PHP Reader Project Workgroup
  • todo: Data parsing and write support
  • since: ID3v2.4.0
  • license: New BSD License

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

ID3_Object
   |
   --ID3_Frame
      |
      --ID3_Frame_ASPI
Method Summary
ID3_Frame_ASPI __construct ([Reader $reader = null], [ &$options = array()], Array $options)
integer getDataLength ()
integer getDataStart ()
integer getFractionAt (integer $index)
integer getSize ()
void setDataLength (integer $dataLength)
void setDataStart (integer $dataStart)
Variables

Inherited Variables

Inherited from ID3_Frame

ID3_Frame::$_data

Inherited from ID3_Object

ID3_Object::$_reader
Methods
Constructor __construct (line 82)

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

  • access: public
ID3_Frame_ASPI __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.
getDataLength (line 124)

Returns the byte length of the audio data being indexed.

  • access: public
integer getDataLength ()
getDataStart (line 110)

Returns the byte offset from the beginning of the file.

  • access: public
integer getDataStart ()
getFractionAt (line 151)

Returns the numerator of the fraction representing a relative position in the data or false if index not defined. The denominator is 2 to the power of b.

  • access: public
integer getFractionAt (integer $index)
  • integer $index: The fraction numerator.
getSize (line 141)

Returns the number of index points in the frame.

  • access: public
integer getSize ()

Redefinition of:
ID3_Frame::getSize()
Returns the size of the data in the final frame, after encryption, compression and unsynchronisation. The size is excluding the frame header.
setDataLength (line 131)

Sets the byte length of the audio data being indexed.

  • access: public
void setDataLength (integer $dataLength)
  • integer $dataLength: The length.
setDataStart (line 117)

Sets the byte offset from the beginning of the file.

  • access: public
void setDataStart (integer $dataStart)
  • integer $dataStart: The offset.

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

Documentation generated on Fri, 05 Sep 2008 20:18:18 +0300 by phpDocumentor 1.4.1