diff options
Diffstat (limited to 'libraries/phpvideotoolkit/adapters/ffmpeg-php/php-reader/docs/php-reader/ASF/ASF_Object_BandwidthSharing.html')
| -rw-r--r-- | libraries/phpvideotoolkit/adapters/ffmpeg-php/php-reader/docs/php-reader/ASF/ASF_Object_BandwidthSharing.html | 385 |
1 files changed, 385 insertions, 0 deletions
diff --git a/libraries/phpvideotoolkit/adapters/ffmpeg-php/php-reader/docs/php-reader/ASF/ASF_Object_BandwidthSharing.html b/libraries/phpvideotoolkit/adapters/ffmpeg-php/php-reader/docs/php-reader/ASF/ASF_Object_BandwidthSharing.html new file mode 100644 index 0000000..b314e79 --- /dev/null +++ b/libraries/phpvideotoolkit/adapters/ffmpeg-php/php-reader/docs/php-reader/ASF/ASF_Object_BandwidthSharing.html @@ -0,0 +1,385 @@ +<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+ <html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <!-- template designed by Marco Von Ballmoos -->
+ <title>Docs For Class ASF_Object_BandwidthSharing</title>
+ <link rel="stylesheet" href="../../media/stylesheet.css" />
+ <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
+ </head>
+ <body>
+ <div class="page-body">
+<h2 class="class-name">Class ASF_Object_BandwidthSharing</h2>
+
+<a name="sec-description"></a>
+<div class="info-box">
+ <div class="info-box-title">Description</div>
+ <div class="nav-bar">
+ <span class="disabled">Description</span> |
+ <a href="#sec-vars">Vars</a>
+ | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
+
+ <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
+
+ </div>
+ <div class="info-box-body">
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">The <em>Bandwidth Sharing Object</em> indicates streams that share bandwidth in</p>
+<p class="description"><p>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.</p></p>
+ <ul class="tags">
+ <li><span class="field">author:</span> Sven Vollbehr <<a href="mailto:svollbehr@gmail.com">svollbehr@gmail.com</a>></li>
+ <li><span class="field">version:</span> $Rev: 108 $</li>
+ <li><span class="field">copyright:</span> Copyright (c) 2008 The PHP Reader Project Workgroup</li>
+ <li><span class="field">license:</span> <a href="http://code.google.com/p/php-reader/wiki/License">New BSD License</a></li>
+ </ul>
+ <p class="notes">
+ Located in <a class="field" href="_ASF---Object---BandwidthSharing.php.html">/ASF/Object/BandwidthSharing.php</a> (line <span class="field">56</span>)
+ </p>
+
+
+ <pre><a href="../../php-reader/ASF/ASF_Object.html">ASF_Object</a> + | + --ASF_Object_BandwidthSharing</pre>
+
+ </div>
+</div>
+
+
+ <a name="sec-const-summary"></a>
+ <div class="info-box">
+ <div class="info-box-title">Class Constant Summary</span></div>
+ <div class="nav-bar">
+ <a href="#sec-description">Description</a> |
+ <span class="disabled">Constants</span> (<a href="#sec-consts">details</a>)
+ <a href="#sec-vars">Vars</a>
+
+ |
+ |
+ <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+ <div class="const-summary">
+ <div class="const-title">
+ <img src="../../media/images/Constant.png" alt=" " />
+ <a href="#SHARING_EXCLUSIVE" title="details" class="const-name">SHARING_EXCLUSIVE</a> = <span class="var-type"> "af6060aa-5197-11d2-b6af-00c04fd908e9"</span>
+
+ </div>
+ <div class="const-title">
+ <img src="../../media/images/Constant.png" alt=" " />
+ <a href="#SHARING_PARTIAL" title="details" class="const-name">SHARING_PARTIAL</a> = <span class="var-type"> "af6060ab-5197-11d2-b6af-00c04fd908e9"</span>
+
+ </div>
+ </div>
+ </div>
+ </div>
+
+
+ <a name="sec-method-summary"></a>
+ <div class="info-box">
+ <div class="info-box-title">Method Summary</span></div>
+ <div class="nav-bar">
+ <a href="#sec-description">Description</a> |
+ <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
+
+ <a href="#sec-vars">Vars</a>
+
+ |
+ <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
+ </div>
+ <div class="info-box-body">
+ <div class="method-summary">
+
+ <div class="method-definition">
+ <span class="method-result">ASF_Object_BandwidthSharing</span>
+ <a href="#__construct" title="details" class="method-name">__construct</a>
+ (<span class="var-type"><a href="../../php-reader/Reader.html">Reader</a></span> <span class="var-name">$reader</span>, [<span class="var-type"></span> <span class="var-name">&$options</span> = <span class="var-default">array()</span>], <span class="var-type">Array</span> <span class="var-name">$options</span>)
+ </div>
+ <div class="method-definition">
+ <span class="method-result">integer</span>
+ <a href="#getBufferSize" title="details" class="method-name">getBufferSize</a>
+ ()
+ </div>
+ <div class="method-definition">
+ <span class="method-result">integer</span>
+ <a href="#getDataBitrate" title="details" class="method-name">getDataBitrate</a>
+ ()
+ </div>
+ <div class="method-definition">
+ <span class="method-result">string</span>
+ <a href="#getSharingType" title="details" class="method-name">getSharingType</a>
+ ()
+ </div>
+ <div class="method-definition">
+ <span class="method-result">Array</span>
+ <a href="#getStreamNumbers" title="details" class="method-name">getStreamNumbers</a>
+ ()
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <a name="sec-vars"></a>
+ <div class="info-box">
+ <div class="info-box-title">Variables</div>
+ <div class="nav-bar">
+ <a href="#sec-description">Description</a> |
+ <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
+
+
+ <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
+
+ |
+ <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+
<h4>Inherited Variables</h4>
+ <A NAME='inherited_vars'><!-- --></A>
+ <p>Inherited from <span class="classname"><a href="../../php-reader/ASF/ASF_Object.html">ASF_Object</a></span></p>
+ <blockquote>
+ <span class="var-title">
+ <span class="var-name"><a href="../../php-reader/ASF/ASF_Object.html#var$_options">ASF_Object::$_options</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a href="../../php-reader/ASF/ASF_Object.html#var$_reader">ASF_Object::$_reader</a></span><br>
+ </span>
+ </blockquote>
+
+ </div>
+ </div>
+
+ <a name="sec-methods"></a>
+ <div class="info-box">
+ <div class="info-box-title">Methods</div>
+ <div class="nav-bar">
+ <a href="#sec-description">Description</a> |
+ <a href="#sec-vars">Vars</a>
+ <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
+
+ <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
+
+ </div>
+ <div class="info-box-body">
+ <A NAME='method_detail'></A>
+
+<a name="method__construct" id="__construct"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">Constructor __construct</span> (line <span class="line-number">80</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Constructs the class with given parameters and reads object related data from the ASF file.</p>
+ <ul class="tags">
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">ASF_Object_BandwidthSharing</span>
+ <span class="method-name">
+ __construct
+ </span>
+ (<span class="var-type"><a href="../../php-reader/Reader.html">Reader</a></span> <span class="var-name">$reader</span>, [<span class="var-type"></span> <span class="var-name">&$options</span> = <span class="var-default">array()</span>], <span class="var-type">Array</span> <span class="var-name">$options</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"><a href="../../php-reader/Reader.html">Reader</a></span>
+ <span class="var-name">$reader</span><span class="var-description">: The reader object.</span> </li>
+ <li>
+ <span class="var-type">Array</span>
+ <span class="var-name">$options</span><span class="var-description">: The options array.</span> </li>
+ <li>
+ <span class="var-type"></span>
+ <span class="var-name">&$options</span> </li>
+ </ul>
+
+ <hr class="separator" />
+ <div class="notes">Redefinition of:</div>
+ <dl>
+ <dt><a href="../../php-reader/ASF/ASF_Object.html#method__construct">ASF_Object::__construct()</a></dt>
+ <dd>Constructs the class with given parameters and options.</dd>
+ </dl>
+
+ </div>
+<a name="methodgetBufferSize" id="getBufferSize"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">getBufferSize</span> (line <span class="line-number">125</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Specifies the size B, in bits, of the leaky bucket used in the Data Bitrate</p>
+<p class="description"><p>definition. This value can be less than the sum of all of the buffer sizes in the <a href="../../php-reader/ASF/ASF_Object_ExtendedStreamProperties.html">Extended Stream Properties</a> Objects for the streams contained in this bandwidth-sharing relationship.</p></p>
+ <ul class="tags">
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">integer</span>
+ <span class="method-name">
+ getBufferSize
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetDataBitrate" id="getDataBitrate"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">getDataBitrate</span> (line <span class="line-number">114</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Returns the leak rate R, in bits per second, of a leaky bucket that</p>
+<p class="description"><p>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 <a href="../../php-reader/ASF/ASF_Object_ExtendedStreamProperties.html">Extended Stream Properties</a> Objects for the streams contained in this bandwidth-sharing relationship.</p></p>
+ <ul class="tags">
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">integer</span>
+ <span class="method-name">
+ getDataBitrate
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetSharingType" id="getSharingType"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">getSharingType</span> (line <span class="line-number">101</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Returns the type of sharing relationship for this object. Two types are</p>
+<p class="description"><p>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.</p></p>
+ <ul class="tags">
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">string</span>
+ <span class="method-name">
+ getSharingType
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetStreamNumbers" id="getStreamNumbers"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">getStreamNumbers</span> (line <span class="line-number">132</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Returns an array of stream numbers.</p>
+ <ul class="tags">
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">Array</span>
+ <span class="method-name">
+ getStreamNumbers
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+ <h4>Inherited Methods</h4>
+ <a name='inherited_methods'><!-- --></a>
+ <!-- =========== Summary =========== -->
+ <p>Inherited From <span class="classname"><a href="../../php-reader/ASF/ASF_Object.html">ASF_Object</a></span></p>
+ <blockquote>
+ <span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#method__construct">ASF_Object::__construct()</a></span><br>
+ <span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodgetIdentifier">ASF_Object::getIdentifier()</a></span><br>
+ <span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodgetOffset">ASF_Object::getOffset()</a></span><br>
+ <span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodgetOption">ASF_Object::getOption()</a></span><br>
+ <span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodgetOptions">ASF_Object::getOptions()</a></span><br>
+ <span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodgetParent">ASF_Object::getParent()</a></span><br>
+ <span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodgetSize">ASF_Object::getSize()</a></span><br>
+ <span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodsetIdentifier">ASF_Object::setIdentifier()</a></span><br>
+ <span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodsetOffset">ASF_Object::setOffset()</a></span><br>
+ <span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodsetOption">ASF_Object::setOption()</a></span><br>
+ <span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodsetOptions">ASF_Object::setOptions()</a></span><br>
+ <span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodsetParent">ASF_Object::setParent()</a></span><br>
+ <span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodsetSize">ASF_Object::setSize()</a></span><br>
+ <span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#method__get">ASF_Object::__get()</a></span><br>
+ <span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#method__set">ASF_Object::__set()</a></span><br>
+ </blockquote>
+
+ </div>
+ </div>
+
+ <a name="sec-consts"></a>
+ <div class="info-box">
+ <div class="info-box-title">Class Constants</div>
+ <div class="nav-bar">
+ <a href="#sec-description">Description</a> |
+ <a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
+
+
+ <a href="#sec-vars">Vars</a>
+ |
+ <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+ <a name="constSHARING_EXCLUSIVE" id="SHARING_EXCLUSIVE"><!-- --></A>
+<div class="evenrow">
+
+ <div class="const-header">
+ <img src="../../media/images/Variable.png" />
+ <span class="const-title">
+ <span class="const-name">SHARING_EXCLUSIVE</span>
+ = <span class="const-default"> "af6060aa-5197-11d2-b6af-00c04fd908e9"</span>
+ (line <span class="line-number">58</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+
+
+</div>
+<a name="constSHARING_PARTIAL" id="SHARING_PARTIAL"><!-- --></A>
+<div class="oddrow">
+
+ <div class="const-header">
+ <img src="../../media/images/Variable.png" />
+ <span class="const-title">
+ <span class="const-name">SHARING_PARTIAL</span>
+ = <span class="const-default"> "af6060ab-5197-11d2-b6af-00c04fd908e9"</span>
+ (line <span class="line-number">59</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+
+
+</div>
+
+ </div>
+ </div>
+
+ <p class="notes" id="credit">
+ Documentation generated on Fri, 05 Sep 2008 20:18:19 +0300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.1</a>
+ </p>
+ </div></body>
+</html>
\ No newline at end of file |