Docs For Class ASF_Object_TimecodeIndexParameters

Description

The Timecode Index Parameters Object supplies information about those

streams that are actually indexed (there must be at least one stream in an index) by timecodes. All streams referred to in the Timecode Index Parameters Object must have timecode Payload Extension Systems associated with them in the Extended Stream Properties Object. This object shall be present in the Header Object if there is a Timecode Index Object present in the file.

An Index Specifier is required for each stream that will be indexed by the Timecode Index Object. These specifiers must exactly match those in the Timecode 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/TimecodeIndexParameters.php (line 65)

ASF_Object
   |
   --ASF_Object_TimecodeIndexParameters

Method Summary

ASF_Object_TimecodeIndexParameters __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 80)

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

access: public

ASF_Object_TimecodeIndexParameters __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 99)

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

access: public

integer getIndexEntryCountInterval ()

getIndexSpecifiers (line 124)

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: 2 = Nearest Past Media Object, 3 = Nearest Past Cleanpoint (1 is not a valid value). For a video stream, The Nearest Past Media Object indexes point to the closest data packet containing an entire video frame or the first fragment of a video frame, and the 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. Nearest Past Media Object is the most common value.

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