Docs For Class ASF_Object_BandwidthSharing

Description

The Bandwidth Sharing Object indicates streams that share bandwidth in

such a way that the maximum bandwidth of the set of streams is less than the sum of the maximum bandwidths of the individual streams. There should be one instance of this object for each set of objects that share bandwidth. Whether or not this object can be used meaningfully is content-dependent.

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/BandwidthSharing.php (line 56)

ASF_Object
   |
   --ASF_Object_BandwidthSharing

Class Constant Summary

SHARING_EXCLUSIVE = "af6060aa-5197-11d2-b6af-00c04fd908e9"

SHARING_PARTIAL = "af6060ab-5197-11d2-b6af-00c04fd908e9"

Method Summary

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

integer getBufferSize ()

integer getDataBitrate ()

string getSharingType ()

Array getStreamNumbers ()

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_BandwidthSharing __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.

getBufferSize (line 125)

Specifies the size B, in bits, of the leaky bucket used in the Data Bitrate

definition. This value can be less than the sum of all of the buffer sizes in the Extended Stream Properties Objects for the streams contained in this bandwidth-sharing relationship.

access: public

integer getBufferSize ()

getDataBitrate (line 114)

Returns the leak rate R, in bits per second, of a leaky bucket that

contains the data portion of all of the streams, excluding all ASF Data Packet overhead, without overflowing. The size of the leaky bucket is specified by the value of the Buffer Size field. This value can be less than the sum of all of the data bit rates in the Extended Stream Properties Objects for the streams contained in this bandwidth-sharing relationship.

access: public

integer getDataBitrate ()

getSharingType (line 101)

Returns the type of sharing relationship for this object. Two types are

predefined: SHARING_PARTIAL, in which any number of the streams in the relationship may be streaming data at any given time; and SHARING_EXCLUSIVE, in which only one of the streams in the relationship may be streaming data at any given time.

access: public

string getSharingType ()

getStreamNumbers (line 132)

Returns an array of stream numbers.

access: public

Array getStreamNumbers ()

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

SHARING_EXCLUSIVE = "af6060aa-5197-11d2-b6af-00c04fd908e9" (line 58)

SHARING_PARTIAL = "af6060ab-5197-11d2-b6af-00c04fd908e9" (line 59)