diff options
Diffstat (limited to 'libraries/phpvideotoolkit/adapters/ffmpeg-php/php-reader/docs/php-reader/ID3/ID3_Frame_ASPI.html')
| -rw-r--r-- | libraries/phpvideotoolkit/adapters/ffmpeg-php/php-reader/docs/php-reader/ID3/ID3_Frame_ASPI.html | 456 |
1 files changed, 456 insertions, 0 deletions
diff --git a/libraries/phpvideotoolkit/adapters/ffmpeg-php/php-reader/docs/php-reader/ID3/ID3_Frame_ASPI.html b/libraries/phpvideotoolkit/adapters/ffmpeg-php/php-reader/docs/php-reader/ID3/ID3_Frame_ASPI.html new file mode 100644 index 0000000..56154ba --- /dev/null +++ b/libraries/phpvideotoolkit/adapters/ffmpeg-php/php-reader/docs/php-reader/ID3/ID3_Frame_ASPI.html @@ -0,0 +1,456 @@ +<?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 ID3_Frame_ASPI</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 ID3_Frame_ASPI</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-consts">Constants</a>
+
+ </div>
+ <div class="info-box-body">
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Audio files with variable bit rates are intrinsically difficult to deal with</p>
+<p class="description"><p>in the case of seeking within the file. The <em>Audio seek point index</em> or ASPI frame makes seeking easier by providing a list a seek points within the audio file. The seek points are a fractional offset within the audio data, providing a starting point from which to find an appropriate point to start decoding. The presence of an ASPI frame requires the existence of a <a href="../../php-reader/ID3/ID3_Frame_TLEN.html">ID3_Frame_TLEN</a> frame, indicating the duration of the file in milliseconds. There may only be one audio seek point index frame in a tag.</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: 75 $</li>
+ <li><span class="field">copyright:</span> Copyright (c) 2008 The PHP Reader Project Workgroup</li>
+ <li><span class="field">todo:</span> Data parsing and write support</li>
+ <li><span class="field">since:</span> ID3v2.4.0</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="_ID3---Frame---ASPI.php.html">/ID3/Frame/ASPI.php</a> (line <span class="field">62</span>)
+ </p>
+
+
+ <pre><a href="../../php-reader/ID3/ID3_Object.html">ID3_Object</a> + | + --<a href="../../php-reader/ID3/ID3_Frame.html">ID3_Frame</a> + | + --ID3_Frame_ASPI</pre>
+
+ </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-consts">Constants</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">ID3_Frame_ASPI</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-default">null</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="#getDataLength" title="details" class="method-name">getDataLength</a>
+ ()
+ </div>
+ <div class="method-definition">
+ <span class="method-result">integer</span>
+ <a href="#getDataStart" title="details" class="method-name">getDataStart</a>
+ ()
+ </div>
+ <div class="method-definition">
+ <span class="method-result">integer</span>
+ <a href="#getFractionAt" title="details" class="method-name">getFractionAt</a>
+ (<span class="var-type">integer</span> <span class="var-name">$index</span>)
+ </div>
+ <div class="method-definition">
+ <span class="method-result">integer</span>
+ <a href="#getSize" title="details" class="method-name">getSize</a>
+ ()
+ </div>
+ <div class="method-definition">
+ <span class="method-result">void</span>
+ <a href="#setDataLength" title="details" class="method-name">setDataLength</a>
+ (<span class="var-type">integer</span> <span class="var-name">$dataLength</span>)
+ </div>
+ <div class="method-definition">
+ <span class="method-result">void</span>
+ <a href="#setDataStart" title="details" class="method-name">setDataStart</a>
+ (<span class="var-type">integer</span> <span class="var-name">$dataStart</span>)
+ </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-consts">Constants</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/ID3/ID3_Frame.html">ID3_Frame</a></span></p>
+ <blockquote>
+ <span class="var-title">
+ <span class="var-name"><a href="../../php-reader/ID3/ID3_Frame.html#var$_data">ID3_Frame::$_data</a></span><br>
+ </span>
+ </blockquote>
+ <p>Inherited from <span class="classname"><a href="../../php-reader/ID3/ID3_Object.html">ID3_Object</a></span></p>
+ <blockquote>
+ <span class="var-title">
+ <span class="var-name"><a href="../../php-reader/ID3/ID3_Object.html#var$_reader">ID3_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-consts">Constants</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="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">Constructor __construct</span> (line <span class="line-number">82</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Constructs the class with given parameters and parses object related data.</p>
+ <ul class="tags">
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">ID3_Frame_ASPI</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-default">null</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/ID3/ID3_Frame.html#method__construct">ID3_Frame::__construct()</a></dt>
+ <dd>Constructs the class with given parameters and reads object related data from the ID3v2 tag.</dd>
+ </dl>
+
+ </div>
+<a name="methodgetDataLength" id="getDataLength"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">getDataLength</span> (line <span class="line-number">124</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Returns the byte length of the audio data being indexed.</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">
+ getDataLength
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetDataStart" id="getDataStart"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">getDataStart</span> (line <span class="line-number">110</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Returns the byte offset from the beginning of the file.</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">
+ getDataStart
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetFractionAt" id="getFractionAt"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">getFractionAt</span> (line <span class="line-number">151</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Returns the numerator of the fraction representing a relative position in the data or <var>false</var> if index not defined. The denominator is 2 to the power of b.</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">
+ getFractionAt
+ </span>
+ (<span class="var-type">integer</span> <span class="var-name">$index</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">integer</span>
+ <span class="var-name">$index</span><span class="var-description">: The fraction numerator.</span> </li>
+ </ul>
+
+
+ </div>
+<a name="methodgetSize" id="getSize"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">getSize</span> (line <span class="line-number">141</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Returns the number of index points in the frame.</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">
+ getSize
+ </span>
+ ()
+ </div>
+
+
+ <hr class="separator" />
+ <div class="notes">Redefinition of:</div>
+ <dl>
+ <dt><a href="../../php-reader/ID3/ID3_Frame.html#methodgetSize">ID3_Frame::getSize()</a></dt>
+ <dd>Returns the size of the data in the final frame, after encryption, compression and unsynchronisation. The size is excluding the frame header.</dd>
+ </dl>
+
+ </div>
+<a name="methodsetDataLength" id="setDataLength"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">setDataLength</span> (line <span class="line-number">131</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Sets the byte length of the audio data being indexed.</p>
+ <ul class="tags">
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">void</span>
+ <span class="method-name">
+ setDataLength
+ </span>
+ (<span class="var-type">integer</span> <span class="var-name">$dataLength</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">integer</span>
+ <span class="var-name">$dataLength</span><span class="var-description">: The length.</span> </li>
+ </ul>
+
+
+ </div>
+<a name="methodsetDataStart" id="setDataStart"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">setDataStart</span> (line <span class="line-number">117</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Sets the byte offset from the beginning of the file.</p>
+ <ul class="tags">
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">void</span>
+ <span class="method-name">
+ setDataStart
+ </span>
+ (<span class="var-type">integer</span> <span class="var-name">$dataStart</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">integer</span>
+ <span class="var-name">$dataStart</span><span class="var-description">: The offset.</span> </li>
+ </ul>
+
+
+ </div>
+ <h4>Inherited Methods</h4>
+ <a name='inherited_methods'><!-- --></a>
+ <!-- =========== Summary =========== -->
+ <p>Inherited From <span class="classname"><a href="../../php-reader/ID3/ID3_Frame.html">ID3_Frame</a></span></p>
+ <blockquote>
+ <span class="method-name"><a href="../../php-reader/ID3/ID3_Frame.html#method__construct">ID3_Frame::__construct()</a></span><br>
+ <span class="method-name"><a href="../../php-reader/ID3/ID3_Frame.html#methodgetFlags">ID3_Frame::getFlags()</a></span><br>
+ <span class="method-name"><a href="../../php-reader/ID3/ID3_Frame.html#methodgetIdentifier">ID3_Frame::getIdentifier()</a></span><br>
+ <span class="method-name"><a href="../../php-reader/ID3/ID3_Frame.html#methodgetSize">ID3_Frame::getSize()</a></span><br>
+ <span class="method-name"><a href="../../php-reader/ID3/ID3_Frame.html#methodhasFlag">ID3_Frame::hasFlag()</a></span><br>
+ <span class="method-name"><a href="../../php-reader/ID3/ID3_Frame.html#methodsetData">ID3_Frame::setData()</a></span><br>
+ <span class="method-name"><a href="../../php-reader/ID3/ID3_Frame.html#methodsetFlags">ID3_Frame::setFlags()</a></span><br>
+ <span class="method-name"><a href="../../php-reader/ID3/ID3_Frame.html#methodsetIdentifier">ID3_Frame::setIdentifier()</a></span><br>
+ <span class="method-name"><a href="../../php-reader/ID3/ID3_Frame.html#method__toString">ID3_Frame::__toString()</a></span><br>
+ </blockquote>
+ <!-- =========== Summary =========== -->
+ <p>Inherited From <span class="classname"><a href="../../php-reader/ID3/ID3_Object.html">ID3_Object</a></span></p>
+ <blockquote>
+ <span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#method__construct">ID3_Object::__construct()</a></span><br>
+ <span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#methoddecodeSynchsafe32">ID3_Object::decodeSynchsafe32()</a></span><br>
+ <span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#methoddecodeUnsynchronisation">ID3_Object::decodeUnsynchronisation()</a></span><br>
+ <span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#methodencodeSynchsafe32">ID3_Object::encodeSynchsafe32()</a></span><br>
+ <span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#methodencodeUnsynchronisation">ID3_Object::encodeUnsynchronisation()</a></span><br>
+ <span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#methodexplodeString8">ID3_Object::explodeString8()</a></span><br>
+ <span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#methodexplodeString16">ID3_Object::explodeString16()</a></span><br>
+ <span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#methodgetOption">ID3_Object::getOption()</a></span><br>
+ <span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#methodgetOptions">ID3_Object::getOptions()</a></span><br>
+ <span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#methodsetOption">ID3_Object::setOption()</a></span><br>
+ <span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#methodsetOptions">ID3_Object::setOptions()</a></span><br>
+ <span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#method__get">ID3_Object::__get()</a></span><br>
+ <span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#method__set">ID3_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">
+
<h4>Inherited Constants</h4>
+ <A NAME='inherited_vars'><!-- --></A>
+ <p>Inherited from <span class="classname"><a href="../../php-reader/ID3/ID3_Frame.html">ID3_Frame</a></span></p>
+ <blockquote>
+ <img src="../../media/images/Variable.png" />
+ <span class="const-title">
+ <span class="const-name"><a href="../../php-reader/ID3/ID3_Frame.html#constCOMPRESSION">ID3_Frame::COMPRESSION</a></span><br>
+ </span>
+ <img src="../../media/images/Variable.png" />
+ <span class="const-title">
+ <span class="const-name"><a href="../../php-reader/ID3/ID3_Frame.html#constDATA_LENGTH_INDICATOR">ID3_Frame::DATA_LENGTH_INDICATOR</a></span><br>
+ </span>
+ <img src="../../media/images/Variable.png" />
+ <span class="const-title">
+ <span class="const-name"><a href="../../php-reader/ID3/ID3_Frame.html#constDISCARD_ON_FILECHANGE">ID3_Frame::DISCARD_ON_FILECHANGE</a></span><br>
+ </span>
+ <img src="../../media/images/Variable.png" />
+ <span class="const-title">
+ <span class="const-name"><a href="../../php-reader/ID3/ID3_Frame.html#constDISCARD_ON_TAGCHANGE">ID3_Frame::DISCARD_ON_TAGCHANGE</a></span><br>
+ </span>
+ <img src="../../media/images/Variable.png" />
+ <span class="const-title">
+ <span class="const-name"><a href="../../php-reader/ID3/ID3_Frame.html#constENCRYPTION">ID3_Frame::ENCRYPTION</a></span><br>
+ </span>
+ <img src="../../media/images/Variable.png" />
+ <span class="const-title">
+ <span class="const-name"><a href="../../php-reader/ID3/ID3_Frame.html#constGROUPING_IDENTITY">ID3_Frame::GROUPING_IDENTITY</a></span><br>
+ </span>
+ <img src="../../media/images/Variable.png" />
+ <span class="const-title">
+ <span class="const-name"><a href="../../php-reader/ID3/ID3_Frame.html#constREAD_ONLY">ID3_Frame::READ_ONLY</a></span><br>
+ </span>
+ <img src="../../media/images/Variable.png" />
+ <span class="const-title">
+ <span class="const-name"><a href="../../php-reader/ID3/ID3_Frame.html#constUNSYNCHRONISATION">ID3_Frame::UNSYNCHRONISATION</a></span><br>
+ </span>
+ </blockquote>
+
+ </div>
+ </div>
+
+ <p class="notes" id="credit">
+ Documentation generated on Fri, 05 Sep 2008 20:18:18 +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 |