Class ASF_Object_StreamProperties

Description

The Stream Properties Object defines the specific properties and characteristics of a digital media stream. This object defines how a digital media stream within the Data Object is interpreted, as well as the specific format (of elements) of the Data Packet itself.

Whereas every stream in an ASF presentation, including each stream in a mutual exclusion relationship, must be represented by a Stream Properties Object, in certain cases, this object might be found embedded in the Extended Stream Properties Object.

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

ASF_Object
   |
   --ASF_Object_StreamProperties
Class Constant Summary
 AUDIO_MEDIA = "f8699e40-5b4d-11cf-a8fd-00805f5c442b"
 AUDIO_SPREAD = "bfc3cd50-618f-11cf-8bb2-00aa00b4e220"
 BINARY_MEDIA = "3afb65e2-47ef-40f2-ac2c-70a90d71d343"
 COMMAND_MEDIA = "59dacfc0-59e6-11d0-a3ac-00a0c90348f6"
 DEGRADABLE_JPEG_MEDIA = "35907dE0-e415-11cf-a917-00805f5c442b"
 FILE_TRANSFER_MEDIA = "91bd222c-f21c-497a-8b6d-5aa86bfc0185"
 JFIF_MEDIA = "b61be100-5b4e-11cf-a8fD-00805f5c442b"
 NO_ERROR_CORRECTION = "20fb5700-5b55-11cf-a8fd-00805f5c442b"
 VIDEO_MEDIA = "bc19efc0-5b4d-11cf-a8fd-00805f5c442b"
Method Summary
ASF_Object_StreamProperties __construct (Reader $reader, [ &$options = array()], Array $options)
integer getFlags ()
integer getStreamNumber ()
string getStreamType ()
integer getTimeOffset ()
boolean hasFlag (integer $flag)
Variables

Inherited Variables

Inherited from ASF_Object

ASF_Object::$_options
ASF_Object::$_reader
Methods
Constructor __construct (line 104)

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

  • access: public
ASF_Object_StreamProperties __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.
getErrorCorrectionData (line 284)

Returns data specific to the error correction type. The structure for the

Error Correction Data field is determined by the value stored in the Error Correction Type field. For example, an audio data stream might need to know how codec chunks were redistributed, or it might need a sample of encoded silence.

The error correction type-specific data is returned as key-value pairs of an associate array.

  • access: public
integer getErrorCorrectionData ()
getErrorCorrectionType (line 225)

Returns the error correction type used by this digital media stream. For streams other than audio, this value should be set to NO_ERROR_CORRECTION.

For audio streams, this value should be set to AUDIO_SPREAD.

  • access: public
string getErrorCorrectionType ()
getFlags (line 258)

Returns the flags field.

  • access: public
integer getFlags ()
getStreamNumber (line 209)

Returns the number of this stream. 0 is an invalid stream. Valid values are between 1 and 127. The numbers assigned to streams in an ASF presentation may be any combination of unique values; parsing logic must not assume that streams are numbered sequentially.

  • access: public
integer getStreamNumber ()
getStreamType (line 216)

Returns the type of the stream (for example, audio, video, and so on).

  • access: public
string getStreamType ()
getTimeOffset (line 242)

Returns the presentation time offset of the stream in 100-nanosecond units.

The value of this field is added to all of the timestamps of the samples in the stream. This value shall be equal to the send time of the first interleaved packet in the data section. The value of this field is typically 0. It is non-zero in the case when an ASF file is edited and it is not possible for the editor to change the presentation times and send times of ASF packets. Note that if more than one stream is present in an ASF file the offset values of all stream properties objects must be equal.

  • access: public
integer getTimeOffset ()
getTypeSpecificData (line 270)

Returns type-specific format data. The structure for the Type-Specific Data field is determined by the value stored in the Stream Type field.

The type-specific data is returned as key-value pairs of an associate array.

  • access: public
Array getTypeSpecificData ()
hasFlag (line 251)

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
AUDIO_MEDIA = "f8699e40-5b4d-11cf-a8fd-00805f5c442b" (line 68)
AUDIO_SPREAD = "bfc3cd50-618f-11cf-8bb2-00aa00b4e220" (line 77)
BINARY_MEDIA = "3afb65e2-47ef-40f2-ac2c-70a90d71d343" (line 74)
COMMAND_MEDIA = "59dacfc0-59e6-11d0-a3ac-00a0c90348f6" (line 70)
DEGRADABLE_JPEG_MEDIA = "35907dE0-e415-11cf-a917-00805f5c442b" (line 72)
ENCRYPTED_CONTENT = 0x8000 (line 66)

Indicates, if set, that the data contained in this stream is encrypted and will be unreadable unless there is a way to decrypt the stream.

FILE_TRANSFER_MEDIA = "91bd222c-f21c-497a-8b6d-5aa86bfc0185" (line 73)
JFIF_MEDIA = "b61be100-5b4e-11cf-a8fD-00805f5c442b" (line 71)
NO_ERROR_CORRECTION = "20fb5700-5b55-11cf-a8fd-00805f5c442b" (line 76)
VIDEO_MEDIA = "bc19efc0-5b4d-11cf-a8fd-00805f5c442b" (line 69)

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