Docs For Class ASF_Object_MediaObjectIndexParameters

Description

The Media Object Index Parameters Object supplies information about

those streams that actually indexed (there must be at least one stream in an index) by media objects. This object shall be present in the Header Object if there is a Media Object Index Object present in the file.

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

author: Sven Vollbehr <svollbehr@gmail.com>
version: $Rev: 108 $
copyright: Copyright (c) 2008 The PHP Reader Project Workgroup
license: New BSD License

Located in /ASF/Object/MediaObjectIndexParameters.php (line 62)

ASF_Object
   |
   --ASF_Object_MediaObjectIndexParameters

Method Summary

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

integer getIndexEntryCountInterval ()

Array getIndexSpecifiers ()

Variables

Inherited Variables

Inherited from ASF_Object

ASF_Object::$_options
ASF_Object::$_reader

Methods

Constructor __construct (line 77)

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

access: public

ASF_Object_MediaObjectIndexParameters __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.

getIndexEntryCountInterval (line 96)

Returns the interval between each index entry by the number of media objects. This value cannot be 0.

access: public

integer getIndexEntryCountInterval ()

getIndexSpecifiers (line 129)

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.

indexType -- Specifies the type of index. Values are defined as follows: 1 = Nearest Past Data Packet, 2 = Nearest Past Media Object, 3 = Nearest Past Cleanpoint, 0xff = Frame Number Offset. For a video stream, the Nearest Past Media Object and Nearest Past Data Packet indexes point to the closest data packet containing an entire video frame or first fragment of a video frame; Nearest Past Cleanpoint indexes point to the closest data packet containing an entire video frame (or first fragment of a video frame) that is a key frame; and Frame Number Offset indicates how many more frames need to be read for the given stream, starting with the first frame in the packet pointed to by the index entry, in order to get to the requested frame. Nearest Past Media Object is the most common value. Because ASF payloads do not contain the full frame number, there is often a Frame Number Offset index alongside one of the other types of indexes to allow the user to identify the exact frame being seeked to.

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()