Docs For Class ISO14496_Box

Description

A base class for objects that also contain a version number and flags field.

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

Located in /ISO14496/Box/Full.php (line 52)

ISO14496_Box
   |
   --ISO14496_Box_Full

Direct descendents

Class	Description
ISO14496_Box_BXML	When the primary data is in XML format and it is desired that the XML be stored directly in the meta-box, one of the XML Box forms may be used.
ISO14496_Box_CO64	The Chunk Offset Box table gives the index of each chunk into the containing file. There are two variants, permitting the use of 32-bit or 64-bit offsets. The latter is useful when managing very large presentations.
ISO14496_Box_CPRT	The Copyright Box contains a copyright declaration which applies to the entire presentation, when contained within the Movie Box, or, when contained in a track, to that entire track. There may be multiple copyright boxes using different language codes.
ISO14496_Box_CTTS	The Composition Time to Sample Box provides the offset between
ISO14496_Box_DREF	The Data Reference Box contains a table of data references (normally
ISO14496_Box_ELST	The Edit List Box contains an explicit timeline map. Each entry defines part of the track time-line: by mapping part of the media time-line, or by indicating empty time, or by defining a dwell, where a single time-point in the media is held for a period.
ISO14496_Box_HDLR	The Handler Reference Box is within a Media Box declares the process by which the media-data in the track is presented, and thus, the nature of the media in a track. For example, a video track would be handled by a video handler.
ISO14496_Box_HMHD	The Hint Media Header Box header contains general information, independent of the protocol, for hint tracks.
ISO14496_Box_ID32	The ID3v2 Box resides under the Meta Box and stores ID3 version 2 meta-data. There may be more than one ID3v2 Box present each with a different language code.
ISO14496_Box_DATA	A box that contains data for iTunes/iPod specific boxes.
ISO14496_Box_INFE	The Item Information Entry Box contains the entry information.
ISO14496_Box_IPMC	The IPMP Control Box may contain IPMP descriptors which may be referenced by any stream in the file.
ISO14496_Box_MDHD	The Media Header Box declares overall information that is media-independent, and relevant to characteristics of the media in a track.
ISO14496_Box_MEHD	The Movie Extends Header Box is optional, and provides the overall duration, including fragments, of a fragmented movie. If this box is not present, the overall duration must be computed by examining each fragment.
ISO14496_Box_META	The Meta Box contains descriptive or annotative metadata. The
ISO14496_Box_MFHD	The Movie Fragment Header Box contains a sequence number, as a safety
ISO14496_Box_MFRO	The Movie Fragment Random Access Offset Box provides a copy of the
ISO14496_Box_MVHD	The Movie Header Box defines overall information which is media-independent, and relevant to the entire presentation considered as a whole.
ISO14496_Box_NMHD	Streams other than visual and audio may use a Null Media Header Box, as defined here.
ISO14496_Box_PADB	The Padding Bits BoxIn some streams the media samples do not occupy all bits of the bytes given by the sample size, and are padded at the end to a byte boundary. In some cases, it is necessary to record externally the number of padding bits used. This table supplies that information.
ISO14496_Box_PDIN	The Progressive Download Information Box aids the progressive download of an ISO file. The box contains pairs of numbers (to the end of the box) specifying combinations of effective file download bitrate in units of bytes/sec and a suggested initial playback delay in units of milliseconds.
ISO14496_Box_PITM	For a given handler, the primary data may be one of the referenced items when
ISO14496_Box_SBGP	The Sample To Group Box table can be used to find the group that a
ISO14496_Box_SCHM	The Scheme Type Box identifies the protection scheme.
ISO14496_Box_SDTP	The Independent and Disposable Samples Box optional table answers
ISO14496_Box_SGPD	The Sample Group Description Box table gives information about the characteristics of sample groups. The descriptive information is any other information needed to define or characterize the sample group.
ISO14496_Box_SMHD	The Sound Media Header Box contains general presentation information, independent of the coding, for audio media. This header is used for all tracks containing audio.
ISO14496_Box_STCO	The Chunk Offset Box table gives the index of each chunk into the containing file. There are two variants, permitting the use of 32-bit or 64-bit offsets. The latter is useful when managing very large presentations.
ISO14496_Box_STDP	The Degradation Priority Box contains the degradation priority of each sample. Specifications derived from this define the exact meaning and acceptable range of the priority field.
ISO14496_Box_STSC	Samples within the media data are grouped into chunks. Chunks can be of different sizes, and the samples within a chunk can have different sizes.
ISO14496_Box_STSD	The Sample Description Box table gives detailed information about the coding type used, and any initialization information needed for that coding.
ISO14496_Box_STSH	The Shadow Sync Sample Box table provides an optional set of sync samples that can be used when seeking or for similar purposes. In normal forward play they are ignored.
ISO14496_Box_STSS	The Sync Sample Box provides a compact marking of the random access points within the stream. The table is arranged in strictly increasing order of sample number. If the sync sample box is not present, every sample is a random access point.
ISO14496_Box_STSZ	The Sample Size Box contains the sample count and a table giving the size in bytes of each sample. This allows the media data itself to be unframed. The total number of samples in the media is always indicated in the sample count.
ISO14496_Box_STTS	The Decoding Time to Sample Box contains a compact version of a table
ISO14496_Box_STZ2	The Sample Size Box contains the sample count and a table giving the size in bytes of each sample. This allows the media data itself to be unframed. The total number of samples in the media is always indicated in the sample count.
ISO14496_Box_SUBS	The Sub-Sample Information Box is designed to contain sub-sample information.
ISO14496_Box_TFHD	Each movie fragment can add zero or more Track Fragment Header Box to each track; and a track fragment can add zero or more contiguous runs of samples. The track fragment header sets up information and defaults used for those runs of samples.
ISO14496_Box_TFRA	Each entry contains the location and the presentation time of the random accessible sample. It indicates that the sample in the entry can be random accessed. Note that not every random accessible sample in the track needs to be listed in the table.
ISO14496_Box_TKHD	The Track Header Box specifies the characteristics of a single track.
ISO14496_Box_TREX	The Track Extends Box sets up default values used by the movie fragments. By setting defaults in this way, space and complexity can be saved in each Track Fragment Box.
ISO14496_Box_TRUN	Within the Track Fragment Box, there are zero or more Track Fragment Run Boxes. If the durationIsEmpty flag is set, there are no track runs.
ISO14496_Box_URL	This box is a URL data reference.
ISO14496_Box_URN	This box is a URN data reference.
ISO14496_Box_VMHD	The Video Media Header Box contains general presentation information, independent of the coding, for video media.
ISO14496_Box_XML	When the primary data is in XML format and it is desired that the XML be stored directly in the meta-box, one of the XML Box forms may be used.

Variable Summary

integer $_flags

integer $_version

Method Summary

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

integer getFlags ()

integer getVersion ()

boolean hasFlag (integer $flag)

void setFlags (string $flags)

void setVersion (integer $version)

string __toString ([ $data = ""])

Variables

integer $_flags = 0 (line 58)

access: protected

integer $_version = 0 (line 55)

access: protected

Inherited Variables

Inherited from ISO14496_Box

ISO14496_Box::$_reader

Methods

Constructor __construct (line 66)

Constructs the class with given parameters and reads box related data from the ISO Base Media file.

access: public

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

Reader $reader: The reader object.
&$options

Redefinition of:

ISO14496_Box::__construct(): Constructs the class with given parameters and options.

Redefined in descendants as:

ISO14496_Box_BXML::__construct() : Constructs the class with given parameters and reads box related data from the ISO Base Media file.
ISO14496_Box_CO64::__construct() : Constructs the class with given parameters and reads box related data from the ISO Base Media file.
ISO14496_Box_CPRT::__construct() : Constructs the class with given parameters and reads box related data from the ISO Base Media file.
ISO14496_Box_CTTS::__construct() : Constructs the class with given parameters and reads box related data from the ISO Base Media file.
ISO14496_Box_DREF::__construct() : Constructs the class with given parameters and reads box related data from the ISO Base Media file.
ISO14496_Box_ELST::__construct() : Constructs the class with given parameters and reads box related data from the ISO Base Media file.
ISO14496_Box_HDLR::__construct() : Constructs the class with given parameters and reads box related data from the ISO Base Media file.
ISO14496_Box_HMHD::__construct() : Constructs the class with given parameters and reads box related data from the ISO Base Media file.
ISO14496_Box_ID32::__construct() : Constructs the class with given parameters and reads box related data from the ISO Base Media file.
ISO14496_Box_DATA::__construct() : Constructs the class with given parameters and reads box related data from the ISO Base Media file.
ISO14496_Box_INFE::__construct() : Constructs the class with given parameters and reads box related data from the ISO Base Media file.
ISO14496_Box_MDHD::__construct() : Constructs the class with given parameters and reads box related data from the ISO Base Media file.
ISO14496_Box_MEHD::__construct() : Constructs the class with given parameters and reads box related data from the ISO Base Media file.
ISO14496_Box_META::__construct() : Constructs the class with given parameters and reads box related data from the ISO Base Media file.
ISO14496_Box_MFHD::__construct() : Constructs the class with given parameters and reads box related data from the ISO Base Media file.
ISO14496_Box_MFRO::__construct() : Constructs the class with given parameters and reads box related data from the ISO Base Media file.
ISO14496_Box_MVHD::__construct() : Constructs the class with given parameters and reads box related data from the ISO Base Media file.
ISO14496_Box_PDIN::__construct() : Constructs the class with given parameters and reads box related data from the ISO Base Media file.
ISO14496_Box_PITM::__construct() : Constructs the class with given parameters and reads box related data from the ISO Base Media file.
ISO14496_Box_SBGP::__construct() : Constructs the class with given parameters and reads box related data from the ISO Base Media file.
ISO14496_Box_SCHM::__construct() : Constructs the class with given parameters and reads box related data from the ISO Base Media file.
ISO14496_Box_SDTP::__construct() : Constructs the class with given parameters and reads box related data from the ISO Base Media file.
ISO14496_Box_SMHD::__construct() : Constructs the class with given parameters and reads box related data from the ISO Base Media file.
ISO14496_Box_STCO::__construct() : Constructs the class with given parameters and reads box related data from the ISO Base Media file.
ISO14496_Box_STDP::__construct() : Constructs the class with given parameters and reads box related data from the ISO Base Media file.
ISO14496_Box_STSC::__construct() : Constructs the class with given parameters and reads box related data from the ISO Base Media file.
ISO14496_Box_STSH::__construct() : Constructs the class with given parameters and reads box related data from the ISO Base Media file.
ISO14496_Box_STSS::__construct() : Constructs the class with given parameters and reads box related data from the ISO Base Media file.
ISO14496_Box_STSZ::__construct() : Constructs the class with given parameters and reads box related data from the ISO Base Media file.
ISO14496_Box_STTS::__construct() : Constructs the class with given parameters and reads box related data from the ISO Base Media file.
ISO14496_Box_STZ2::__construct() : Constructs the class with given parameters and reads box related data from the ISO Base Media file.
ISO14496_Box_SUBS::__construct() : Constructs the class with given parameters and reads box related data from the ISO Base Media file.
ISO14496_Box_TFHD::__construct() : Constructs the class with given parameters and reads box related data from the ISO Base Media file.
ISO14496_Box_TFRA::__construct() : Constructs the class with given parameters and reads box related data from the ISO Base Media file.
ISO14496_Box_TKHD::__construct() : Constructs the class with given parameters and reads box related data from the ISO Base Media file.
ISO14496_Box_TREX::__construct() : Constructs the class with given parameters and reads box related data from the ISO Base Media file.
ISO14496_Box_TRUN::__construct() : Constructs the class with given parameters and reads box related data from the ISO Base Media file.
ISO14496_Box_URL::__construct() : Constructs the class with given parameters and reads box related data from the ISO Base Media file.
ISO14496_Box_URN::__construct() : Constructs the class with given parameters and reads box related data from the ISO Base Media file.
ISO14496_Box_VMHD::__construct() : Constructs the class with given parameters and reads box related data from the ISO Base Media file.
ISO14496_Box_XML::__construct() : Constructs the class with given parameters and reads box related data from the ISO Base Media file.

getFlags (line 105)

Returns the map of flags.

access: public

integer getFlags ()

getVersion (line 82)

Returns the version of this format of the box.

access: public

integer getVersion ()

hasFlag (line 98)

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.

setFlags (line 112)

Sets the map of flags.

access: public

void setFlags (string $flags)

string $flags: The map of flags.

setVersion (line 89)

Sets the version of this format of the box.

access: public

void setVersion (integer $version)

integer $version: The version.

__toString (line 119)

Returns the box raw data.

access: public

string __toString ([ $data = ""])

$data

Redefinition of:

ISO14496_Box::__toString(): Returns the box raw data.

Redefined in descendants as:

ISO14496_Box_CO64::__toString() : Returns the box raw data.
ISO14496_Box_DREF::__toString() : Returns the box raw data.
ISO14496_Box_HDLR::__toString() : Returns the box raw data.
ISO14496_Box_ID32::__toString() : Returns the box raw data.
ISO14496_Box_DATA::__toString() : Returns the box raw data.
ISO14496_Box_STCO::__toString() : Returns the box raw data.

Inherited Methods

Inherited From ISO14496_Box

ISO14496_Box::__construct()
ISO14496_Box::addBox()
ISO14496_Box::constructBoxes()
ISO14496_Box::getBoxes()
ISO14496_Box::getBoxesByIdentifier()
ISO14496_Box::getContainer()
ISO14496_Box::getOffset()
ISO14496_Box::getOption()
ISO14496_Box::getOptions()
ISO14496_Box::getParent()
ISO14496_Box::getSize()
ISO14496_Box::getType()
ISO14496_Box::hasBox()
ISO14496_Box::isContainer()
ISO14496_Box::setContainer()
ISO14496_Box::setOffset()
ISO14496_Box::setOption()
ISO14496_Box::setOptions()
ISO14496_Box::setParent()
ISO14496_Box::setSize()
ISO14496_Box::setType()
ISO14496_Box::__get()
ISO14496_Box::__isset()
ISO14496_Box::__set()
ISO14496_Box::__toString()
ISO14496_Box::__unset()

Class ISO14496_Box_Full

Inherited Variables

Inherited Methods