Docs For Class ASF

Class ASF_Object

Description

The base unit of organization for ASF files is called the ASF object. It consists of a 128-bit GUID for the object, a 64-bit integer object size, and the variable-length object data.

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

Located in /ASF/Object.php (line 55)

Direct descendents

Class	Description
ASF_Object_AdvancedContentEncryption	The Advanced Content Encryption Object lets authors protect content by using Next Generation Windows Media Digital Rights Management for Network Devices.
ASF_Object_AdvancedMutualExclusion	The Advanced Mutual Exclusion Object identifies streams that have a mutual exclusion relationship to each other (in other words, only one of the streams within such a relationship can be streamed—the rest are ignored).
ASF_Object_BandwidthSharing	The Bandwidth Sharing Object indicates streams that share bandwidth in
ASF_Object_BitrateMutualExclusion	The Bitrate Mutual Exclusion Object identifies video streams that have
ASF_Object_CodecList	The Codec List Object provides user-friendly information about the codecs and formats used to encode the content found in the ASF file.
ASF_Object_Compatibility	The Compatibility Object is reserved for future use.
ASF_Object_Container	An abstract base container class that contains other ASF objects.
ASF_Object_ContentBranding	The Content Branding Object stores branding data for an ASF file, including information about a banner image and copyright associated with the file.
ASF_Object_ContentDescription	The Content Description Object lets authors record well-known data describing the file and its contents. This object is used to store standard bibliographic information such as title, author, copyright, description, and rating information. This information is pertinent to the entire file.
ASF_Object_ContentEncryption	The Content Encryption Object lets authors protect content by using Microsoft® Digital Rights Manager version 1.
ASF_Object_Data	The Data Object contains all of the Data Packets for a file.
ASF_Object_DigitalSignature	The Digital Signature Object lets authors sign the portion of their header that lies between the end of the File Properties Object and the beginning of the Digital Signature Object.
ASF_Object_ErrorCorrection	The Error Correction Object defines the error correction method. This
ASF_Object_ExtendedContentDescription	The ASF_Extended_Content_Description_Object object implementation.
ASF_Object_ExtendedContentEncryption	The Extended Content Encryption Object lets authors protect content by using the Windows Media Rights Manager 7 Software Development Kit (SDK).
ASF_Object_ExtendedStreamProperties	The Extended Stream Properties Object defines additional optional properties and characteristics of a digital media stream that are not described in the Stream Properties Object.
ASF_Object_FileProperties	The File Properties Object defines the global characteristics of the combined digital media streams found within the Data Object.
ASF_Object_GroupMutualExclusion	The Group Mutual Exclusion Object is used to describe mutual exclusion
ASF_Object_Index	This top-level ASF object supplies the necessary indexing information for an ASF file that contains more than just a plain script-audio-video combination.
ASF_Object_IndexParameters	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.
ASF_Object_LanguageList	The Language List Object contains an array of Unicode-based language IDs. All other header objects refer to languages through zero-based positions in this array.
ASF_Object_Marker	The Marker Object class.
ASF_Object_MediaObjectIndex	This top-level ASF object supplies media object indexing information for the streams of an ASF file. It includes stream-specific indexing information based on an adjustable index entry media object count interval. This object can be used to index all the video frames or key frames in a video stream.
ASF_Object_MediaObjectIndexParameters	The Media Object Index Parameters Object supplies information about
ASF_Object_Metadata	The Metadata Object permits authors to store stream-based metadata in a file. This object supports the same types of metadata information as the Extended Content Description Object except that it also allows a stream number to be specified.
ASF_Object_MetadataLibrary	The Metadata Library Object lets authors store stream-based, language-attributed, multiply defined, and large metadata attributes in a file.
ASF_Object_Padding	The Padding Object is a dummy object that is used to pad the size of the Header Object. This object enables the size of any object stored in the Header Object to grow or shrink without having to rewrite the entire Data Object and Index Object sections of the ASF file.
ASF_Object_ScriptCommand	The Script Command Object provides a list of type/parameter pairs of
ASF_Object_SimpleIndex	For each video stream in an ASF file, there should be one instance of the Simple Index Object. Additionally, the instances of the Simple Index Object shall be ordered by stream number.
ASF_Object_StreamBitrateProperties	The Stream Bitrate Properties Object defines the average bit rate of each digital media stream.
ASF_Object_StreamPrioritization	The Stream Prioritization Object indicates the author's intentions as
ASF_Object_StreamProperties	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.
ASF_Object_TimecodeIndex	This top-level ASF object supplies timecode indexing information for the
ASF_Object_TimecodeIndexParameters	The Timecode Index Parameters Object supplies information about those

Variable Summary

Array $_options

Reader $_reader

Method Summary

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

string getIdentifier ()

integer getOffset ()

void getOption (string $option, [mixed $defaultValue = false])

Array getOptions ()

ASF_Object getParent ()

integer getSize ()

void setIdentifier (string $id)

void setOffset (integer $offset)

void setOption (string $option, mixed $value)

void setOptions ( &$options, Array $options)

void setParent ( &$parent, ASF_Object $parent)

void setSize (integer $size)

mixed __get (string $name)

mixed __set (string $name, string $value)

Variables

Array $_options (line 69)

The options array.

access: protected

Reader $_reader (line 62)

The reader object.

access: protected

Methods

Constructor __construct (line 89)

Constructs the class with given parameters and options.

access: public

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

Reader $reader: The reader object.
Array $options: The options array.
&$options

Redefined in descendants as:

ASF_Object_AdvancedContentEncryption::__construct() : Constructs the class with given parameters and reads object related data from the ASF file.
ASF_Object_AdvancedMutualExclusion::__construct() : Constructs the class with given parameters and reads object related data from the ASF file.
ASF_Object_BandwidthSharing::__construct() : Constructs the class with given parameters and reads object related data from the ASF file.
ASF_Object_BitrateMutualExclusion::__construct() : Constructs the class with given parameters and reads object related data from the ASF file.
ASF_Object_CodecList::__construct() : Constructs the class with given parameters and reads object related data from the ASF file.
ASF_Object_Compatibility::__construct() : Constructs the class with given parameters and reads object related data from the ASF file.
ASF::__construct() : Constructs the ASF class with given file and options.
ASF_Object_Header::__construct() : Constructs the class with given parameters and options.
ASF_Object_HeaderExtension::__construct() : Constructs the class with given parameters and reads object related data from the ASF file.
ASF_Object_ContentBranding::__construct() : Constructs the class with given parameters and reads object related data from the ASF file.
ASF_Object_ContentDescription::__construct() : Constructs the class with given parameters and reads object related data from the ASF file.
ASF_Object_ContentEncryption::__construct() : Constructs the class with given parameters and reads object related data from the ASF file.
ASF_Object_Data::__construct() : Constructs the class with given parameters and reads object related data from the ASF file.
ASF_Object_DigitalSignature::__construct() : Constructs the class with given parameters and reads object related data from the ASF file.
ASF_Object_ErrorCorrection::__construct() : Constructs the class with given parameters and reads object related data from the ASF file.
ASF_Object_ExtendedContentDescription::__construct() : Constructs the class with given parameters and reads object related data from the ASF file.
ASF_Object_ExtendedContentEncryption::__construct() : Constructs the class with given parameters and reads object related data from the ASF file.
ASF_Object_ExtendedStreamProperties::__construct() : Constructs the class with given parameters and reads object related data from the ASF file.
ASF_Object_FileProperties::__construct() : Constructs the class with given parameters and reads object related data from the ASF file.
ASF_Object_GroupMutualExclusion::__construct() : Constructs the class with given parameters and reads object related data from the ASF file.
ASF_Object_Index::__construct() : Constructs the class with given parameters and reads object related data from the ASF file.
ASF_Object_IndexParameters::__construct() : Constructs the class with given parameters and reads object related data from the ASF file.
ASF_Object_LanguageList::__construct() : Constructs the class with given parameters and reads object related data from the ASF file.
ASF_Object_Marker::__construct() : Constructs the class with given parameters and reads object related data from the ASF file.
ASF_Object_MediaObjectIndex::__construct() : Constructs the class with given parameters and reads object related data from the ASF file.
ASF_Object_MediaObjectIndexParameters::__construct() : Constructs the class with given parameters and reads object related data from the ASF file.
ASF_Object_Metadata::__construct() : Constructs the class with given parameters and reads object related data from the ASF file.
ASF_Object_MetadataLibrary::__construct() : Constructs the class with given parameters and reads object related data from the ASF file.
ASF_Object_ScriptCommand::__construct() : Constructs the class with given parameters and reads object related data from the ASF file.
ASF_Object_SimpleIndex::__construct() : Constructs the class with given parameters and reads object related data from the ASF file.
ASF_Object_StreamBitrateProperties::__construct() : Constructs the class with given parameters and reads object related data from the ASF file.
ASF_Object_StreamPrioritization::__construct() : Constructs the class with given parameters and reads object related data from the ASF file.
ASF_Object_StreamProperties::__construct() : Constructs the class with given parameters and reads object related data from the ASF file.
ASF_Object_TimecodeIndex::__construct() : Constructs the class with given parameters and reads object related data from the ASF file.
ASF_Object_TimecodeIndexParameters::__construct() : Constructs the class with given parameters and reads object related data from the ASF file.

getIdentifier (line 117)

Returns the GUID of the ASF object.

access: public

string getIdentifier ()

getOffset (line 103)

Returns the file offset to box start, or -1 if the box was created on heap.

access: public

integer getOffset ()

getOption (line 161)

Returns the given option value, or the default value if the option is not defined.

access: public

void getOption (string $option, [mixed $defaultValue = false])

string $option: The name of the option.
mixed $defaultValue: The default value to be returned.

getOptions (line 152)

Returns the options array.

access: public

Array getOptions ()

getParent (line 191)

Returns the parent object containing this box.

access: public

ASF_Object getParent ()

getSize (line 131)

Returns the object size in bytes, including the header.

access: public

integer getSize ()

setIdentifier (line 124)

Set the GUID of the ASF object.

access: public

void setIdentifier (string $id)

string $id: The GUID

setOffset (line 110)

Sets the file offset where the box starts.

access: public

void setOffset (integer $offset)

integer $offset: The file offset to box start.

setOption (line 181)

Sets the given option the given value.

access: public

void setOption (string $option, mixed $value)

string $option: The name of the option.
mixed $value: The value to set for the option.

setOptions (line 173)

Sets the options array. See ISO14496 class for available options.

access: public

void setOptions ( &$options, Array $options)

Array $options: The options array.
&$options

setParent (line 198)

Sets the parent containing object.

access: public

void setParent ( &$parent, ASF_Object $parent)

ASF_Object $parent: The parent object.
&$parent

setSize (line 138)

Sets the box size. The size must include the header.

access: public

void setSize (integer $size)

integer $size: The box size.

__get (line 206)

Magic function so that $obj->value will work.

access: public

mixed __get (string $name)

string $name: The field name.

Redefined in descendants as:

ASF_Object_Container::__get() : Override magic function so that $obj->value will work as expected.

__set (line 220)

Magic function so that assignments with $obj->value will work.

access: public

mixed __set (string $name, string $value)

string $name: The field name.
string $value: The field value.

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