diff options
Diffstat (limited to 'libraries/phpvideotoolkit/adapters/ffmpeg-php/php-reader/docs/php-reader/ID3/ID3_Header.html')
| -rw-r--r-- | libraries/phpvideotoolkit/adapters/ffmpeg-php/php-reader/docs/php-reader/ID3/ID3_Header.html | 561 |
1 files changed, 561 insertions, 0 deletions
diff --git a/libraries/phpvideotoolkit/adapters/ffmpeg-php/php-reader/docs/php-reader/ID3/ID3_Header.html b/libraries/phpvideotoolkit/adapters/ffmpeg-php/php-reader/docs/php-reader/ID3/ID3_Header.html new file mode 100644 index 0000000..12b9b6f --- /dev/null +++ b/libraries/phpvideotoolkit/adapters/ffmpeg-php/php-reader/docs/php-reader/ID3/ID3_Header.html @@ -0,0 +1,561 @@ +<?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_Header</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_Header</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 first part of the ID3v2 tag is the 10 byte tag header. The header contains information about the tag version and options.</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: 107 $</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="_ID3---Header.php.html">/ID3/Header.php</a> (line <span class="field">53</span>)
+ </p>
+
+
+ <pre><a href="../../php-reader/ID3/ID3_Object.html">ID3_Object</a> + | + --ID3_Header</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="#EXPERIMENTAL" title="details" class="const-name">EXPERIMENTAL</a> = <span class="var-type"> 32</span>
+
+ </div>
+ <div class="const-title">
+ <img src="../../media/images/Constant.png" alt=" " />
+ <a href="#EXTENDEDHEADER" title="details" class="const-name">EXTENDEDHEADER</a> = <span class="var-type"> 64</span>
+
+ </div>
+ <div class="const-title">
+ <img src="../../media/images/Constant.png" alt=" " />
+ <a href="#FOOTER" title="details" class="const-name">FOOTER</a> = <span class="var-type"> 16</span>
+
+ </div>
+ <div class="const-title">
+ <img src="../../media/images/Constant.png" alt=" " />
+ <a href="#UNSYNCHRONISATION" title="details" class="const-name">UNSYNCHRONISATION</a> = <span class="var-type"> 128</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">ID3_Header</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="#getFlags" title="details" class="method-name">getFlags</a>
+ ()
+ </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">integer</span>
+ <a href="#getVersion" title="details" class="method-name">getVersion</a>
+ ()
+ </div>
+ <div class="method-definition">
+ <span class="method-result">boolean</span>
+ <a href="#hasFlag" title="details" class="method-name">hasFlag</a>
+ (<span class="var-type">integer</span> <span class="var-name">$flag</span>)
+ </div>
+ <div class="method-definition">
+ <span class="method-result">void</span>
+ <a href="#setFlags" title="details" class="method-name">setFlags</a>
+ (<span class="var-type">string</span> <span class="var-name">$flags</span>)
+ </div>
+ <div class="method-definition">
+ <span class="method-result">void</span>
+ <a href="#setSize" title="details" class="method-name">setSize</a>
+ (<span class="var-type">integer</span> <span class="var-name">$size</span>)
+ </div>
+ <div class="method-definition">
+ <span class="method-result">void</span>
+ <a href="#setVersion" title="details" class="method-name">setVersion</a>
+ (<span class="var-type">integer</span> <span class="var-name">$version</span>)
+ </div>
+ <div class="method-definition">
+ <span class="method-result">string</span>
+ <a href="#__toString" title="details" class="method-name">__toString</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/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-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">90</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Constructs the class with given parameters and reads object related data from the ID3v2 tag.</p>
+ <ul class="tags">
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">ID3_Header</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_Object.html#method__construct">ID3_Object::__construct()</a></dt>
+ <dd>Constructs the class with given parameters and reads object related data from the ID3v2 tag.</dd>
+ </dl>
+
+ </div>
+<a name="methodgetFlags" id="getFlags"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">getFlags</span> (line <span class="line-number">137</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Returns the flags byte.</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">
+ getFlags
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetSize" id="getSize"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">getSize</span> (line <span class="line-number">151</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Returns the tag size, excluding the header and the footer.</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>
+
+
+
+ </div>
+<a name="methodgetVersion" id="getVersion"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">getVersion</span> (line <span class="line-number">109</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Returns the tag version number. The version number is in the form of major.revision.</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">
+ getVersion
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodhasFlag" id="hasFlag"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">hasFlag</span> (line <span class="line-number">130</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Checks whether or not the flag is set. Returns <var>true</var> if the flag is set, <var>false</var> otherwise.</p>
+ <ul class="tags">
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">boolean</span>
+ <span class="method-name">
+ hasFlag
+ </span>
+ (<span class="var-type">integer</span> <span class="var-name">$flag</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">integer</span>
+ <span class="var-name">$flag</span><span class="var-description">: The flag to query.</span> </li>
+ </ul>
+
+
+ </div>
+<a name="methodsetFlags" id="setFlags"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">setFlags</span> (line <span class="line-number">144</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Sets the flags byte.</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">
+ setFlags
+ </span>
+ (<span class="var-type">string</span> <span class="var-name">$flags</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$flags</span><span class="var-description">: The flags byte.</span> </li>
+ </ul>
+
+
+ </div>
+<a name="methodsetSize" id="setSize"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">setSize</span> (line <span class="line-number">159</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Sets the tag size, excluding the header and the footer. Called automatically upon tag generation to adjust the tag size.</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">
+ setSize
+ </span>
+ (<span class="var-type">integer</span> <span class="var-name">$size</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">integer</span>
+ <span class="var-name">$size</span><span class="var-description">: The size of the tag, in bytes.</span> </li>
+ </ul>
+
+
+ </div>
+<a name="methodsetVersion" id="setVersion"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">setVersion</span> (line <span class="line-number">118</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Sets the tag version number. Supported version numbers are 3.0 and 4.0 for ID3v2.3.0 and ID3v2.4.0 standards, respectively.</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">
+ setVersion
+ </span>
+ (<span class="var-type">integer</span> <span class="var-name">$version</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">integer</span>
+ <span class="var-name">$version</span><span class="var-description">: The tag version number in the form of major.revision.</span> </li>
+ </ul>
+
+
+ </div>
+<a name="method__toString" id="__toString"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">__toString</span> (line <span class="line-number">166</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Returns the header/footer raw data without the identifier.</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">
+ __toString
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+ <h4>Inherited Methods</h4>
+ <a name='inherited_methods'><!-- --></a>
+ <!-- =========== 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">
+ <a name="constEXPERIMENTAL" id="EXPERIMENTAL"><!-- --></A>
+<div class="evenrow">
+
+ <div class="const-header">
+ <img src="../../media/images/Variable.png" />
+ <span class="const-title">
+ <span class="const-name">EXPERIMENTAL</span>
+ = <span class="const-default"> 32</span>
+ (line <span class="line-number">65</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">A flag used as an experimental indicator. This flag shall always be set</p>
+
+
+</div>
+<a name="constEXTENDEDHEADER" id="EXTENDEDHEADER"><!-- --></A>
+<div class="oddrow">
+
+ <div class="const-header">
+ <img src="../../media/images/Variable.png" />
+ <span class="const-title">
+ <span class="const-name">EXTENDEDHEADER</span>
+ = <span class="const-default"> 64</span>
+ (line <span class="line-number">61</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">A flag to denote whether or not the header is followed by an extended</p>
+
+
+</div>
+<a name="constFOOTER" id="FOOTER"><!-- --></A>
+<div class="evenrow">
+
+ <div class="const-header">
+ <img src="../../media/images/Variable.png" />
+ <span class="const-title">
+ <span class="const-name">FOOTER</span>
+ = <span class="const-default"> 16</span>
+ (line <span class="line-number">72</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">A flag to denote whether a footer is present at the very end of the tag.</p>
+ <ul class="tags">
+ <li><span class="field">since:</span> ID3v2.4.0</li>
+ </ul>
+
+
+</div>
+<a name="constUNSYNCHRONISATION" id="UNSYNCHRONISATION"><!-- --></A>
+<div class="oddrow">
+
+ <div class="const-header">
+ <img src="../../media/images/Variable.png" />
+ <span class="const-title">
+ <span class="const-name">UNSYNCHRONISATION</span>
+ = <span class="const-default"> 128</span>
+ (line <span class="line-number">57</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">A flag to denote whether or not unsynchronisation is applied on all</p>
+
+
+</div>
+
+ </div>
+ </div>
+
+ <p class="notes" id="credit">
+ Documentation generated on Fri, 05 Sep 2008 20:18:47 +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 |