Class ASF_Object_FileProperties

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

The File Properties Object defines the global characteristics of the combined digital media streams found within the Data Object.

Located in /ASF/Object/FileProperties.php (line 54) 

ASF_Object
   |
   --ASF_Object_FileProperties
Class Constant Summary
Description | Constants (details) Vars | | Methods (details)
BROADCAST = 1
SEEKABLE = 2
Method Summary
Description | Constants (details) Vars | Methods (details)
ASF_Object_FileProperties __construct (Reader $reader, [ &$options = array()], Array $options)
integer getCreationDate ()
integer getDataPacketsCount ()
integer getFileId ()
integer getFileSize ()
integer getFlags ()
integer getMaximumBitrate ()
integer getMaximumDataPacketSize ()
integer getMinimumDataPacketSize ()
integer getPlayDuration ()
integer getPreroll ()
integer getSendDuration ()
boolean hasFlag (integer $flag)
Variables
Description | Vars (details) Constants (details) | Methods (details)

Inherited Variables

Inherited from ASF_Object

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

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

  • access: public
ASF_Object_FileProperties __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.
getCreationDate (line 157)

Returns the date and time of the initial creation of the file. The value is

given as the number of 100-nanosecond intervals since January 1, 1601, according to Coordinated Universal Time (Greenwich Mean Time). The value of this field may be invalid if the broadcast flag bit in the flags field is set to 1.

  • access: public
integer getCreationDate ()
getDataPacketsCount (line 166)

Returns the number of Data Packet entries that exist within the Data Object. The value of this field is invalid if the broadcast flag bit in the flags field is set to 1.

  • access: public
integer getDataPacketsCount ()
getFileId (line 138)

Returns the file id field.

  • access: public
integer getFileId ()
getFileSize (line 146)

Returns the size, in bytes, of the entire file. The value of this field is invalid if the broadcast flag bit in the flags field is set to 1.

  • access: public
integer getFileSize ()
getFlags (line 215)

Returns the flags field.

  • access: public
integer getFlags ()
getMaximumBitrate (line 254)

Returns the maximum instantaneous bit rate in bits per second for the entire file. This is equal the sum of the bit rates of the individual digital media streams.

  • access: public
integer getMaximumBitrate ()
getMaximumDataPacketSize (line 242)

Returns the maximum Data Packet size in bytes. In general, the value

of this field is invalid if the broadcast flag bit in the flags field is set to 1. However, the values for the Minimum Data Packet Size and Maximum Data Packet Size fields shall be set to the same value, and this value should be set to the packet size, even when the broadcast flag in the flags field is set to 1.

  • access: public
integer getMaximumDataPacketSize ()
getMinimumDataPacketSize (line 227)

Returns the minimum Data Packet size in bytes. In general, the value

of this field is invalid if the broadcast flag bit in the flags field is set to 1. However, the values for the Minimum Data Packet Size and Maximum Data Packet Size fields shall be set to the same value, and this value should be set to the packet size, even when the broadcast flag in the flags field is set to 1.

  • access: public
integer getMinimumDataPacketSize ()
getPlayDuration (line 177)

Returns the time needed to play the file in 100-nanosecond units. This

value should include the duration (estimated, if an exact value is unavailable) of the the last media object in the presentation. The value of this field is invalid if the broadcast flag bit in the flags field is set to 1.

  • access: public
integer getPlayDuration ()
getPreroll (line 199)

Returns the amount of time to buffer data before starting to play the file,

in millisecond units. If this value is nonzero, the Play Duration field and all of the payload Presentation Time fields have been offset by this amount. Therefore, player software must subtract the value in the preroll field from the play duration and presentation times to calculate their actual values.

  • access: public
integer getPreroll ()
getSendDuration (line 187)

Returns the time needed to send the file in 100-nanosecond units. This value should include the duration of the last packet in the content. The value of this field is invalid if the broadcast flag bit in the flags field is set to 1.

  • access: public
integer getSendDuration ()
hasFlag (line 208)

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

  • access: public
boolean hasFlag (integer $flag)
  • integer $flag: The flag to query.

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()
Class Constants
Description | Constants (details) Vars | Methods (details)
BROADCAST = 1 (line 63)

Indicates, if set, that a file is in the process of being created (for

example, for recording applications), and thus that various values stored in the header objects are invalid. It is highly recommended that post-processing be performed to remove this condition at the earliest opportunity.

SEEKABLE = 2 (line 74)

Indicates, if set, that a file is seekable. Note that for files containing

a single audio stream and a Minimum Data Packet Size field equal to the Maximum Data Packet Size field, this flag shall always be set to

  1. For files containing a single audio stream and a video stream or
mutually exclusive video streams, this flag is only set to 1 if the file contains a matching Simple Index Object for each regular video stream.

Documentation generated on Fri, 05 Sep 2008 20:18:40 +0300 by phpDocumentor 1.4.1