diff options
Diffstat (limited to 'libraries/phpvideotoolkit/adapters/ffmpeg-php/php-reader/docs/php-reader/Reader.html')
| -rw-r--r-- | libraries/phpvideotoolkit/adapters/ffmpeg-php/php-reader/docs/php-reader/Reader.html | 448 |
1 files changed, 448 insertions, 0 deletions
diff --git a/libraries/phpvideotoolkit/adapters/ffmpeg-php/php-reader/docs/php-reader/Reader.html b/libraries/phpvideotoolkit/adapters/ffmpeg-php/php-reader/docs/php-reader/Reader.html new file mode 100644 index 0000000..698916d --- /dev/null +++ b/libraries/phpvideotoolkit/adapters/ffmpeg-php/php-reader/docs/php-reader/Reader.html @@ -0,0 +1,448 @@ +<?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 Reader</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 Reader</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-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">The Reader class encapsulates a file. It is hence responsible of upkeeping the connection to the file, keeping track of the cursor position and reading data from it.</p>
+ <ul class="tags">
+ <li><span class="field">author:</span> Ryan Butterfield <<a href="mailto:buttza@gmail.com">buttza@gmail.com</a>></li>
+ <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: 104 $</li>
+ <li><span class="field">copyright:</span> Copyright (c) 2006-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="_Reader.php.html">/Reader.php</a> (line <span class="field">55</span>)
+ </p>
+
+
+ <pre></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> |
+ <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">Reader</span>
+ <a href="#__construct" title="details" class="method-name">__construct</a>
+ (<span class="var-type">string</span> <span class="var-name">$filename</span>, [<span class="var-type">string</span> <span class="var-name">$mode</span> = <span class="var-default">"rb"</span>])
+ </div>
+ <div class="method-definition">
+ <span class="method-result">void</span>
+ <a href="#__destruct" title="details" class="method-name">__destruct</a>
+ ()
+ </div>
+ <div class="method-definition">
+ <span class="method-result">boolean</span>
+ <a href="#available" title="details" class="method-name">available</a>
+ ()
+ </div>
+ <div class="method-definition">
+ <span class="method-result">integer</span>
+ <a href="#getOffset" title="details" class="method-name">getOffset</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">string</span>
+ <a href="#read" title="details" class="method-name">read</a>
+ (<span class="var-type">integer</span> <span class="var-name">$length</span>)
+ </div>
+ <div class="method-definition">
+ <span class="method-result">void</span>
+ <a href="#setOffset" title="details" class="method-name">setOffset</a>
+ (<span class="var-type">integer</span> <span class="var-name">$offset</span>)
+ </div>
+ <div class="method-definition">
+ <span class="method-result">void</span>
+ <a href="#skip" title="details" class="method-name">skip</a>
+ (<span class="var-type">integer</span> <span class="var-name">$size</span>)
+ </div>
+ <div class="method-definition">
+ <span class="method-result">mixed</span>
+ <a href="#__call" title="details" class="method-name">__call</a>
+ (<span class="var-type">string</span> <span class="var-name">$method</span>, <span class="var-type">string</span> <span class="var-name">$params</span>)
+ </div>
+ <div class="method-definition">
+ <span class="method-result">mixed</span>
+ <a href="#__get" title="details" class="method-name">__get</a>
+ (<span class="var-type">string</span> <span class="var-name">$name</span>)
+ </div>
+ <div class="method-definition">
+ <span class="method-result">mixed</span>
+ <a href="#__set" title="details" class="method-name">__set</a>
+ (<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">string</span> <span class="var-name">$value</span>)
+ </div>
+ </div>
+ </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-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">70</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Constructs the Reader class with given file.</p>
+ <ul class="tags">
+ <li><span class="field">throws:</span> Reader_Exception if the file cannot be read.</li>
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">Reader</span>
+ <span class="method-name">
+ __construct
+ </span>
+ (<span class="var-type">string</span> <span class="var-name">$filename</span>, [<span class="var-type">string</span> <span class="var-name">$mode</span> = <span class="var-default">"rb"</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$filename</span><span class="var-description">: The path to the file.</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$mode</span><span class="var-description">: The type of access.</span> </li>
+ </ul>
+
+
+ </div>
+<a name="method__destruct" id="__destruct"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">Destructor __destruct</span> (line <span class="line-number">86</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Closes 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">
+ __destruct
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodavailable" id="available"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">available</span> (line <span class="line-number">98</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Checks whether there is more to be read in the file. Returns <var>true</var> if the end of the file has not yet been reached; <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">
+ available
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetOffset" id="getOffset"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">getOffset</span> (line <span class="line-number">140</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Returns the current point of operation.</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">
+ getOffset
+ </span>
+ ()
+ </div>
+
+
+
+ </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">163</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Returns the file size in bytes.</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="methodread" id="read"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">read</span> (line <span class="line-number">126</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Reads <var>length</var> amount of bytes from the file stream.</p>
+ <ul class="tags">
+ <li><span class="field">throws:</span> Reader_Exception if <var>length</var> attribute is negative.</li>
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">string</span>
+ <span class="method-name">
+ read
+ </span>
+ (<span class="var-type">integer</span> <span class="var-name">$length</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">integer</span>
+ <span class="var-name">$length</span><span class="var-description">: The amount of bytes.</span> </li>
+ </ul>
+
+
+ </div>
+<a name="methodsetOffset" id="setOffset"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">setOffset</span> (line <span class="line-number">153</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Sets the point of operation, ie the cursor offset value. The offset can also be set to a negative value when it is interpreted as an offset from the end of the file instead of the beginning.</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">
+ setOffset
+ </span>
+ (<span class="var-type">integer</span> <span class="var-name">$offset</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">integer</span>
+ <span class="var-name">$offset</span><span class="var-description">: The new point of operation.</span> </li>
+ </ul>
+
+
+ </div>
+<a name="methodskip" id="skip"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">skip</span> (line <span class="line-number">110</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Jumps <var>size</var> amount of bytes in the file stream.</p>
+ <ul class="tags">
+ <li><span class="field">throws:</span> Reader_Exception if <var>size</var> attribute is negative.</li>
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">void</span>
+ <span class="method-name">
+ skip
+ </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 amount of bytes.</span> </li>
+ </ul>
+
+
+ </div>
+<a name="method__call" id="__call"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">__call</span> (line <span class="line-number">204</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Magic function to delegate the call to helper methods of <var>Transform</var> class to transform read data in another format.</p>
+<p class="description"><p>The read data length is determined from the helper method name. For methods where arbitrary data lengths are accepted a parameter can be used to specify the length.</p></p>
+ <ul class="tags">
+ <li><span class="field">throws:</span> Reader_Exception if no such transformer is implemented</li>
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">mixed</span>
+ <span class="method-name">
+ __call
+ </span>
+ (<span class="var-type">string</span> <span class="var-name">$method</span>, <span class="var-type">string</span> <span class="var-name">$params</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$method</span><span class="var-description">: The method to be called.</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$params</span><span class="var-description">: The parameters should the function accept them.</span> </li>
+ </ul>
+
+
+ </div>
+<a name="method__get" id="__get"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">__get</span> (line <span class="line-number">171</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Magic function so that $obj->value will work.</p>
+ <ul class="tags">
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">mixed</span>
+ <span class="method-name">
+ __get
+ </span>
+ (<span class="var-type">string</span> <span class="var-name">$name</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$name</span><span class="var-description">: The field name.</span> </li>
+ </ul>
+
+
+ </div>
+<a name="method__set" id="__set"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">__set</span> (line <span class="line-number">184</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Magic function so that assignments with $obj->value will work.</p>
+ <ul class="tags">
+ <li><span class="field">access:</span> public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">mixed</span>
+ <span class="method-name">
+ __set
+ </span>
+ (<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">string</span> <span class="var-name">$value</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$name</span><span class="var-description">: The field name.</span> </li>
+ <li>
+ <span class="var-type">string</span>
+ <span class="var-name">$value</span><span class="var-description">: The field value.</span> </li>
+ </ul>
+
+
+ </div>
+
+ </div>
+ </div>
+
+
+ <p class="notes" id="credit">
+ Documentation generated on Fri, 05 Sep 2008 20:19:17 +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 |