Class ID3_Frame_RBUF

Description
Description | Vars | Methods (details) Constants (details)

Sometimes the server from which an audio file is streamed is aware of

transmission or coding problems resulting in interruptions in the audio stream. In these cases, the size of the buffer can be recommended by the server using the Recommended buffer size frame. If the embedded info flag is set then this indicates that an ID3 tag with the maximum size described in buffer size may occur in the audio stream. In such case the tag should reside between two MPEG frames, if the audio is MPEG encoded. If the position of the next tag is known, offset to next tag may be used. The offset is calculated from the end of tag in which this frame resides to the first byte of the header in the next. This field may be omitted. Embedded tags are generally not recommended since this could render unpredictable behaviour from present software/hardware.

For applications like streaming audio it might be an idea to embed tags into the audio stream though. If the clients connects to individual connections like HTTP and there is a possibility to begin every transmission with a tag, then this tag should include a recommended buffer size frame. If the client is connected to a arbitrary point in the stream, such as radio or multicast, then the recommended buffer size frame should be included in every tag.

The buffer size should be kept to a minimum. There may only be one RBUF frame in each tag.

Located in /ID3/Frame/RBUF.php (line 74) 

ID3_Object
   |
   --ID3_Frame
      |
      --ID3_Frame_RBUF
Class Constant Summary
Description | Constants (details) Vars | | Methods (details)
EMBEDDED = 0x1
Method Summary
Description | Constants (details) Vars | Methods (details)
ID3_Frame_RBUF __construct ([Reader $reader = null], [ &$options = array()], Array $options)
integer getBufferSize ()
integer getInfoFlags ()
integer getOffset ()
boolean hasInfoFlag (integer $flag)
void setBufferSize ( $bufferSize, integer $size)
void setInfoFlags ( $infoFlags, string $flags)
void setOffset (integer $offset)
string __toString ()
Variables
Description | Vars (details) Constants (details) | Methods (details)

Inherited Variables

Inherited from ID3_Frame

ID3_Frame::$_data

Inherited from ID3_Object

ID3_Object::$_reader
Methods
Description | Vars Constants (details) Methods (details)
Constructor __construct (line 97)

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

  • access: public
ID3_Frame_RBUF __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.
getBufferSize (line 116)

Returns the buffer size.

  • access: public
integer getBufferSize ()
getInfoFlags (line 145)

Returns the flags byte.

  • access: public
integer getInfoFlags ()
getOffset (line 159)

Returns the offset to next tag.

  • access: public
integer getOffset ()
hasInfoFlag (line 135)

Checks whether or not the flag is set. Returns true if the flag is set, false otherwise.

  • access: public
boolean hasInfoFlag (integer $flag)
  • integer $flag: The flag to query.
setBufferSize (line 123)

Sets the buffer size.

  • access: public
void setBufferSize ( $bufferSize, integer $size)
  • integer $size: The buffer size.
  • $bufferSize
setInfoFlags (line 152)

Sets the flags byte.

  • access: public
void setInfoFlags ( $infoFlags, string $flags)
  • string $flags: The flags byte.
  • $infoFlags
setOffset (line 166)

Sets the offset to next tag.

  • access: public
void setOffset (integer $offset)
  • integer $offset: The offset.
__toString (line 173)

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
Description | Constants (details) Vars | Methods (details)
EMBEDDED = 0x1 (line 80)

A flag to denote that an ID3 tag with the maximum size described in buffer size may occur in the audio stream.

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

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