Class ASF_Object_IndexParameters

Description
Description | Vars | Methods (details)

The Index Parameters Object supplies information about those streams that are actually indexed (there must be at least one stream in an index) by the Index Object and how they are being indexed.

This object shall be present in the Header Object if there is an Index Object present in the file.

An Index Specifier is required for each stream that will be indexed by the Index Object. These specifiers must exactly match those in the Index Object.

Located in /ASF/Object/IndexParameters.php (line 60) 

ASF_Object
   |
   --ASF_Object_IndexParameters
Method Summary
Description | Vars | Methods (details)
ASF_Object_IndexParameters __construct (Reader $reader, [ &$options = array()], Array $options)
integer getIndexEntryTimeInterval ()
Array getIndexSpecifiers ()
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 75)

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

  • access: public
ASF_Object_IndexParameters __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.
getIndexEntryTimeInterval (line 94)

Returns the time interval between index entries in milliseconds. This value cannot be 0.

  • access: public
integer getIndexEntryTimeInterval ()
getIndexSpecifiers (line 120)

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

  • streamNumber -- Specifies the stream number that the Index Specifiers refer to. Valid values are between 1 and 127.
    object or first fragment of an object. The Nearest Past Cleanpoint indexes point to the closest data packet containing an entire object (or first fragment of an object) that has the Cleanpoint Flag set. Nearest Past Cleanpoint is the most common type of index.

    • access: public
    Array getIndexSpecifiers ()

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