Class ASF_Object_SimpleIndex

Description
Description | Vars | Methods (details)

For each video stream in an ASF file, there should be one instance of the Simple Index Object. Additionally, the instances of the Simple Index Object shall be ordered by stream number.

Index entries in the Simple Index Object are in terms of Presentation Times. The corresponding Packet Number field values (of the Index Entry, see below) indicate the packet number of the ASF Data Packet with the closest past key frame. Note that for video streams that contain both key frames and non-key frames, the Packet Number field will always point to the closest past key frame.

Located in /ASF/Object/SimpleIndex.php (line 61) 

ASF_Object
   |
   --ASF_Object_SimpleIndex
Method Summary
Description | Vars | Methods (details)
ASF_Object_SimpleIndex __construct (Reader $reader, [ &$options = array()], Array $options)
string getFileId ()
Array getIndexEntries ()
integer getIndexEntryTimeInterval ()
integer getMaximumPacketCount ()
Variables
Description | Vars (details) | Methods (details)

Inherited Variables

Inherited from ASF_Object

ASF_Object::$_options
 ASF_Object::$_reader
Methods
Description | Vars Methods (details)
Constructor __construct (line 82)

Constructs the class with given parameters and reads object related data from the ASF file.

  • access: public
ASF_Object_SimpleIndex __construct (Reader $reader, [ &$options = array()], Array $options)
  • Reader $reader: The reader object.
  • Array $options: The options array.
  • &$options
Redefinition of:
ASF_Object::__construct()
Constructs the class with given parameters and options.
getFileId (line 106)

Returns the unique identifier for this ASF file. The value of this field

should be changed every time the file is modified in any way. The value of this field may be set to 0 or set to be identical to the value of the File ID field of the Data Object and the Header Object.

  • access: public
string getFileId ()
getIndexEntries (line 142)

Returns an array of index entries. Each entry consists of the following keys.

  • packetNumber -- Specifies the number of the Data Packet associated with this index entry. Note that for video streams that contain both key frames and non-key frames, this field will always point to the closest key frame prior to the time interval.
  • packetCount -- Specifies the number of Data Packets to send at this index entry. If a video key frame has been fragmented into two Data Packets, the value of this field will be equal to 2.

  • access: public
Array getIndexEntries ()
getIndexEntryTimeInterval (line 115)

Returns the time interval between each index entry in 100-nanosecond units.

The most common value is 10000000, to indicate that the index entries are in 1-second intervals, though other values can be used as well.

  • access: public
integer getIndexEntryTimeInterval ()
getMaximumPacketCount (line 125)

Returns the maximum Packet Count value of all Index Entries.

  • access: public
integer getMaximumPacketCount ()

Inherited Methods

Inherited From ASF_Object

ASF_Object::__construct()
ASF_Object::getIdentifier()
ASF_Object::getOffset()
ASF_Object::getOption()
ASF_Object::getOptions()
ASF_Object::getParent()
ASF_Object::getSize()
ASF_Object::setIdentifier()
ASF_Object::setOffset()
ASF_Object::setOption()
ASF_Object::setOptions()
ASF_Object::setParent()
ASF_Object::setSize()
ASF_Object::__get()
ASF_Object::__set()

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