| /vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/Coordinate/AspectRatio.html |
|---|
| @@ -0,0 +1,429 @@ |
|---|
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="robots" content="index, follow, all" /> |
| <title>FFMpeg\Coordinate\AspectRatio | PHP-FFMpeg API</title> |
| <link rel="stylesheet" type="text/css" href="../../stylesheet.css"> |
| </head> |
| <body id="class"> |
| <div class="header"> |
| <ul> |
| <li><a href="../../classes.html">Classes</a></li> |
| <li><a href="../../namespaces.html">Namespaces</a></li> |
| <li><a href="../../interfaces.html">Interfaces</a></li> |
| <li><a href="../../traits.html">Traits</a></li> |
| <li><a href="../../doc-index.html">Index</a></li> |
| |
| </ul> |
| |
| <div id="title">PHP-FFMpeg API</div> |
| |
| <div class="type">Class</div> |
| <h1><a href="../../FFMpeg/Coordinate.html">FFMpeg\Coordinate</a>\AspectRatio</h1> |
| </div> |
| <div class="content"> |
| <p> class |
| <strong>AspectRatio</strong></p> |
| |
| |
| <h2>Constants</h2> |
| |
| <table> |
| <tr> |
| <td>AR_4_3</td> |
| <td class="last"> |
| <p><em> |
| </em></p> |
| <p> |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td>AR_16_9</td> |
| <td class="last"> |
| <p><em> |
| </em></p> |
| <p> |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td>AR_3_2</td> |
| <td class="last"> |
| <p><em> |
| </em></p> |
| <p> |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td>AR_5_3</td> |
| <td class="last"> |
| <p><em> |
| </em></p> |
| <p> |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td>AR_5_4</td> |
| <td class="last"> |
| <p><em> |
| </em></p> |
| <p> |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td>AR_1_1</td> |
| <td class="last"> |
| <p><em> |
| </em></p> |
| <p> |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td>AR_1_DOT_85_1</td> |
| <td class="last"> |
| <p><em> |
| </em></p> |
| <p> |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td>AR_2_DOT_39_1</td> |
| <td class="last"> |
| <p><em> |
| </em></p> |
| <p> |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td>AR_ROTATED_3_4</td> |
| <td class="last"> |
| <p><em> |
| </em></p> |
| <p> |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td>AR_ROTATED_9_16</td> |
| <td class="last"> |
| <p><em> |
| </em></p> |
| <p> |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td>AR_ROTATED_2_3</td> |
| <td class="last"> |
| <p><em> |
| </em></p> |
| <p> |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td>AR_ROTATED_3_5</td> |
| <td class="last"> |
| <p><em> |
| </em></p> |
| <p> |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td>AR_ROTATED_4_5</td> |
| <td class="last"> |
| <p><em> |
| </em></p> |
| <p> |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td>AR_ROTATED_1_DOT_85</td> |
| <td class="last"> |
| <p><em> |
| </em></p> |
| <p> |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td>AR_ROTATED_2_DOT_39</td> |
| <td class="last"> |
| <p><em> |
| </em></p> |
| <p> |
| </p> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h2>Methods</h2> |
| |
| <table> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method___construct">__construct</a>($ratio) |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| float |
| </td> |
| <td class="last"> |
| <a href="#method_getValue">getValue</a>() |
| <p>Returns the value of the ratio.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| Integer |
| </td> |
| <td class="last"> |
| <a href="#method_calculateWidth">calculateWidth</a>(Integer $height, Integer $modulus = 1) |
| <p>Computes the best width for given height and modulus.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| Integer |
| </td> |
| <td class="last"> |
| <a href="#method_calculateHeight">calculateHeight</a>(Integer $width, Integer $modulus = 1) |
| <p>Computes the best height for given width and modulus.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| static <a href="../../FFMpeg/Coordinate/AspectRatio.html"><abbr title="FFMpeg\Coordinate\AspectRatio">AspectRatio</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_create">create</a>(<a href="../../FFMpeg/Coordinate/Dimension.html"><abbr title="FFMpeg\Coordinate\Dimension">Dimension</abbr></a> $dimension, Boolean $forceStandards = true) |
| <p>Creates a ratio based on Dimension.</p> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| <h2>Details</h2> |
| |
| <h3 id="method___construct"> |
| <div class="location">at line 61</div> |
| <code> public |
| <strong>__construct</strong>($ratio)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td></td> |
| <td>$ratio</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getValue"> |
| <div class="location">at line 71</div> |
| <code> public float |
| <strong>getValue</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the value of the ratio.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>float</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_calculateWidth"> |
| <div class="location">at line 84</div> |
| <code> public Integer |
| <strong>calculateWidth</strong>(Integer $height, Integer $modulus = 1)</code> |
| </h3> |
| <div class="details"> |
| <p>Computes the best width for given height and modulus.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>Integer</td> |
| <td>$height</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td>Integer</td> |
| <td>$modulus</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>Integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_calculateHeight"> |
| <div class="location">at line 103</div> |
| <code> public Integer |
| <strong>calculateHeight</strong>(Integer $width, Integer $modulus = 1)</code> |
| </h3> |
| <div class="details"> |
| <p>Computes the best height for given width and modulus.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>Integer</td> |
| <td>$width</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td>Integer</td> |
| <td>$modulus</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>Integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_create"> |
| <div class="location">at line 145</div> |
| <code> static public <a href="../../FFMpeg/Coordinate/AspectRatio.html"><abbr title="FFMpeg\Coordinate\AspectRatio">AspectRatio</abbr></a> |
| <strong>create</strong>(<a href="../../FFMpeg/Coordinate/Dimension.html"><abbr title="FFMpeg\Coordinate\Dimension">Dimension</abbr></a> $dimension, Boolean $forceStandards = true)</code> |
| </h3> |
| <div class="details"> |
| <p>Creates a ratio based on Dimension.</p> |
| <p>The strategy parameter forces by default to use standardized ratios. If |
| custom ratio need to be used, disable it.</p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Coordinate/Dimension.html"><abbr title="FFMpeg\Coordinate\Dimension">Dimension</abbr></a></td> |
| <td>$dimension</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td>Boolean</td> |
| <td>$forceStandards</td> |
| <td>Whether to force or not standard ratios</td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Coordinate/AspectRatio.html"><abbr title="FFMpeg\Coordinate\AspectRatio">AspectRatio</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div id="footer"> |
| Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>. |
| </div> |
| </body> |
| </html> |
| /vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/Coordinate/Dimension.html |
|---|
| @@ -0,0 +1,223 @@ |
|---|
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="robots" content="index, follow, all" /> |
| <title>FFMpeg\Coordinate\Dimension | PHP-FFMpeg API</title> |
| <link rel="stylesheet" type="text/css" href="../../stylesheet.css"> |
| </head> |
| <body id="class"> |
| <div class="header"> |
| <ul> |
| <li><a href="../../classes.html">Classes</a></li> |
| <li><a href="../../namespaces.html">Namespaces</a></li> |
| <li><a href="../../interfaces.html">Interfaces</a></li> |
| <li><a href="../../traits.html">Traits</a></li> |
| <li><a href="../../doc-index.html">Index</a></li> |
| |
| </ul> |
| |
| <div id="title">PHP-FFMpeg API</div> |
| |
| <div class="type">Class</div> |
| <h1><a href="../../FFMpeg/Coordinate.html">FFMpeg\Coordinate</a>\Dimension</h1> |
| </div> |
| <div class="content"> |
| <p> class |
| <strong>Dimension</strong></p> |
| |
| <div class="description"> |
| <p>Dimension object, used for manipulating width and height couples</p> |
| <p> |
| </p> |
| </div> |
| |
| |
| |
| <h2>Methods</h2> |
| |
| <table> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method___construct">__construct</a>(integer $width, integer $height) |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getWidth">getWidth</a>() |
| <p>Returns width.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getHeight">getHeight</a>() |
| <p>Returns height.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Coordinate/AspectRatio.html"><abbr title="FFMpeg\Coordinate\AspectRatio">AspectRatio</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getRatio">getRatio</a>(<abbr title="FFMpeg\Coordinate\type">type</abbr> $forceStandards = true) |
| <p>Returns the ratio.</p> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| <h2>Details</h2> |
| |
| <h3 id="method___construct"> |
| <div class="location">at line 30</div> |
| <code> public |
| <strong>__construct</strong>(integer $width, integer $height)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td>$width</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td>integer</td> |
| <td>$height</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td>when one of the parameteres is invalid</td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getWidth"> |
| <div class="location">at line 45</div> |
| <code> public integer |
| <strong>getWidth</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns width.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getHeight"> |
| <div class="location">at line 55</div> |
| <code> public integer |
| <strong>getHeight</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns height.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getRatio"> |
| <div class="location">at line 67</div> |
| <code> public <a href="../../FFMpeg/Coordinate/AspectRatio.html"><abbr title="FFMpeg\Coordinate\AspectRatio">AspectRatio</abbr></a> |
| <strong>getRatio</strong>(<abbr title="FFMpeg\Coordinate\type">type</abbr> $forceStandards = true)</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the ratio.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><abbr title="FFMpeg\Coordinate\type">type</abbr></td> |
| <td>$forceStandards</td> |
| <td>Whether or not force the use of standards ratios;</td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Coordinate/AspectRatio.html"><abbr title="FFMpeg\Coordinate\AspectRatio">AspectRatio</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div id="footer"> |
| Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>. |
| </div> |
| </body> |
| </html> |
| /vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/Coordinate/TimeCode.html |
|---|
| @@ -0,0 +1,234 @@ |
|---|
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="robots" content="index, follow, all" /> |
| <title>FFMpeg\Coordinate\TimeCode | PHP-FFMpeg API</title> |
| <link rel="stylesheet" type="text/css" href="../../stylesheet.css"> |
| </head> |
| <body id="class"> |
| <div class="header"> |
| <ul> |
| <li><a href="../../classes.html">Classes</a></li> |
| <li><a href="../../namespaces.html">Namespaces</a></li> |
| <li><a href="../../interfaces.html">Interfaces</a></li> |
| <li><a href="../../traits.html">Traits</a></li> |
| <li><a href="../../doc-index.html">Index</a></li> |
| |
| </ul> |
| |
| <div id="title">PHP-FFMpeg API</div> |
| |
| <div class="type">Class</div> |
| <h1><a href="../../FFMpeg/Coordinate.html">FFMpeg\Coordinate</a>\TimeCode</h1> |
| </div> |
| <div class="content"> |
| <p> class |
| <strong>TimeCode</strong></p> |
| |
| |
| |
| |
| <h2>Methods</h2> |
| |
| <table> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method___construct">__construct</a>($hours, $minutes, $seconds, $frames) |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method___toString">__toString</a>() |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| static <a href="../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_fromString">fromString</a>(string $timecode) |
| <p>Creates timecode from string.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| static <a href="../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_fromSeconds">fromSeconds</a>(float $quantity) |
| <p>Creates timecode from number of seconds.</p> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| <h2>Details</h2> |
| |
| <h3 id="method___construct"> |
| <div class="location">at line 24</div> |
| <code> public |
| <strong>__construct</strong>($hours, $minutes, $seconds, $frames)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td></td> |
| <td>$hours</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$minutes</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$seconds</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$frames</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method___toString"> |
| <div class="location">at line 32</div> |
| <code> public |
| <strong>__toString</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_fromString"> |
| <div class="location">at line 46</div> |
| <code> static public <a href="../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a> |
| <strong>fromString</strong>(string $timecode)</code> |
| </h3> |
| <div class="details"> |
| <p>Creates timecode from string.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td>$timecode</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td>In case an invalid timecode is supplied</td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_fromSeconds"> |
| <div class="location">at line 74</div> |
| <code> static public <a href="../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a> |
| <strong>fromSeconds</strong>(float $quantity)</code> |
| </h3> |
| <div class="details"> |
| <p>Creates timecode from number of seconds.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>float</td> |
| <td>$quantity</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div id="footer"> |
| Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>. |
| </div> |
| </body> |
| </html> |
| /vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/FFMpeg.html |
|---|
| @@ -0,0 +1,372 @@ |
|---|
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="robots" content="index, follow, all" /> |
| <title>FFMpeg\FFMpeg | PHP-FFMpeg API</title> |
| <link rel="stylesheet" type="text/css" href="../stylesheet.css"> |
| </head> |
| <body id="class"> |
| <div class="header"> |
| <ul> |
| <li><a href="../classes.html">Classes</a></li> |
| <li><a href="../namespaces.html">Namespaces</a></li> |
| <li><a href="../interfaces.html">Interfaces</a></li> |
| <li><a href="../traits.html">Traits</a></li> |
| <li><a href="../doc-index.html">Index</a></li> |
| |
| </ul> |
| |
| <div id="title">PHP-FFMpeg API</div> |
| |
| <div class="type">Class</div> |
| <h1><a href="../FFMpeg.html">FFMpeg</a>\FFMpeg</h1> |
| </div> |
| <div class="content"> |
| <p> class |
| <strong>FFMpeg</strong></p> |
| |
| |
| |
| |
| <h2>Methods</h2> |
| |
| <table> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method___construct">__construct</a>(<a href="../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> $ffmpeg, <a href="../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe) |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../FFMpeg/FFMpeg.html"><abbr title="FFMpeg\FFMpeg">FFMpeg</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_setFFProbe">setFFProbe</a>(<a href="../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe) |
| <p>Sets FFProbe.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getFFProbe">getFFProbe</a>() |
| <p>Gets FFProbe.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../FFMpeg/FFMpeg.html"><abbr title="FFMpeg\FFMpeg">FFMpeg</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_setFFMpegDriver">setFFMpegDriver</a>(<a href="../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> $ffmpeg) |
| <p>Sets the ffmpeg driver.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getFFMpegDriver">getFFMpegDriver</a>() |
| <p>Gets the ffmpeg driver.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../FFMpeg/Media/Audio.html"><abbr title="FFMpeg\Media\Audio">Audio</abbr></a>|<a href="../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_open">open</a>(string $pathfile) |
| <p>Opens a file in order to be processed.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| static <a href="../FFMpeg/FFMpeg.html"><abbr title="FFMpeg\FFMpeg">FFMpeg</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_create">create</a>(array|<abbr title="Alchemy\BinaryDriver\ConfigurationInterface">ConfigurationInterface</abbr> $configuration = array(), <abbr title="Psr\Log\LoggerInterface">LoggerInterface</abbr> $logger = null, <a href="../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $probe = null) |
| <p>Creates a new FFMpeg instance.</p> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| <h2>Details</h2> |
| |
| <h3 id="method___construct"> |
| <div class="location">at line 29</div> |
| <code> public |
| <strong>__construct</strong>(<a href="../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> $ffmpeg, <a href="../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a></td> |
| <td>$ffmpeg</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td>$ffprobe</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setFFProbe"> |
| <div class="location">at line 42</div> |
| <code> public <a href="../FFMpeg/FFMpeg.html"><abbr title="FFMpeg\FFMpeg">FFMpeg</abbr></a> |
| <strong>setFFProbe</strong>(<a href="../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets FFProbe.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td>$ffprobe</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../FFMpeg/FFMpeg.html"><abbr title="FFMpeg\FFMpeg">FFMpeg</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getFFProbe"> |
| <div class="location">at line 54</div> |
| <code> public <a href="../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> |
| <strong>getFFProbe</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Gets FFProbe.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setFFMpegDriver"> |
| <div class="location">at line 64</div> |
| <code> public <a href="../FFMpeg/FFMpeg.html"><abbr title="FFMpeg\FFMpeg">FFMpeg</abbr></a> |
| <strong>setFFMpegDriver</strong>(<a href="../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> $ffmpeg)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the ffmpeg driver.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a></td> |
| <td>$ffmpeg</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../FFMpeg/FFMpeg.html"><abbr title="FFMpeg\FFMpeg">FFMpeg</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getFFMpegDriver"> |
| <div class="location">at line 76</div> |
| <code> public <a href="../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> |
| <strong>getFFMpegDriver</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Gets the ffmpeg driver.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_open"> |
| <div class="location">at line 90</div> |
| <code> public <a href="../FFMpeg/Media/Audio.html"><abbr title="FFMpeg\Media\Audio">Audio</abbr></a>|<a href="../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a> |
| <strong>open</strong>(string $pathfile)</code> |
| </h3> |
| <div class="details"> |
| <p>Opens a file in order to be processed.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td>$pathfile</td> |
| <td>A pathfile</td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../FFMpeg/Media/Audio.html"><abbr title="FFMpeg\Media\Audio">Audio</abbr></a>|<a href="../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_create"> |
| <div class="location">at line 114</div> |
| <code> static public <a href="../FFMpeg/FFMpeg.html"><abbr title="FFMpeg\FFMpeg">FFMpeg</abbr></a> |
| <strong>create</strong>(array|<abbr title="Alchemy\BinaryDriver\ConfigurationInterface">ConfigurationInterface</abbr> $configuration = array(), <abbr title="Psr\Log\LoggerInterface">LoggerInterface</abbr> $logger = null, <a href="../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $probe = null)</code> |
| </h3> |
| <div class="details"> |
| <p>Creates a new FFMpeg instance.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>array|<abbr title="Alchemy\BinaryDriver\ConfigurationInterface">ConfigurationInterface</abbr></td> |
| <td>$configuration</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><abbr title="Psr\Log\LoggerInterface">LoggerInterface</abbr></td> |
| <td>$logger</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td>$probe</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../FFMpeg/FFMpeg.html"><abbr title="FFMpeg\FFMpeg">FFMpeg</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div id="footer"> |
| Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>. |
| </div> |
| </body> |
| </html> |
| /vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/FFProbe/DataMapping/AbstractData.html |
|---|
| @@ -0,0 +1,340 @@ |
|---|
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="robots" content="index, follow, all" /> |
| <title>FFMpeg\FFProbe\DataMapping\AbstractData | PHP-FFMpeg API</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css"> |
| </head> |
| <body id="class"> |
| <div class="header"> |
| <ul> |
| <li><a href="../../../classes.html">Classes</a></li> |
| <li><a href="../../../namespaces.html">Namespaces</a></li> |
| <li><a href="../../../interfaces.html">Interfaces</a></li> |
| <li><a href="../../../traits.html">Traits</a></li> |
| <li><a href="../../../doc-index.html">Index</a></li> |
| |
| </ul> |
| |
| <div id="title">PHP-FFMpeg API</div> |
| |
| <div class="type">Class</div> |
| <h1><a href="../../../FFMpeg/FFProbe/DataMapping.html">FFMpeg\FFProbe\DataMapping</a>\AbstractData</h1> |
| </div> |
| <div class="content"> |
| <p>abstract class |
| <strong>AbstractData</strong> implements |
| <a href="http://php.net/Countable"><abbr title="Countable">Countable</abbr></a></p> |
| |
| |
| |
| |
| <h2>Methods</h2> |
| |
| <table> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method___construct">__construct</a>(array $properties) |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| Boolean |
| </td> |
| <td class="last"> |
| <a href="#method_has">has</a>(string $property) |
| <p>Returns true if data has property.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| mixed |
| </td> |
| <td class="last"> |
| <a href="#method_get">get</a>(string $property) |
| <p>Returns the property value given its name.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_set">set</a>(string $property, mixed $value) |
| <p>Sets the property value given its name.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_keys">keys</a>() |
| <p>Returns all property names.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_all">all</a>() |
| <p>Returns all properties and their values.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_count">count</a>() |
| <p>{@inheritdoc}</p> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| <h2>Details</h2> |
| |
| <h3 id="method___construct"> |
| <div class="location">at line 20</div> |
| <code> public |
| <strong>__construct</strong>(array $properties)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td>$properties</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_has"> |
| <div class="location">at line 31</div> |
| <code> public Boolean |
| <strong>has</strong>(string $property)</code> |
| </h3> |
| <div class="details"> |
| <p>Returns true if data has property.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td>$property</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>Boolean</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_get"> |
| <div class="location">at line 44</div> |
| <code> public mixed |
| <strong>get</strong>(string $property)</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the property value given its name.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td>$property</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>mixed</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td>In case the data does not have the property</td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_set"> |
| <div class="location">at line 61</div> |
| <code> public <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a> |
| <strong>set</strong>(string $property, mixed $value)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the property value given its name.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td>$property</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td>mixed</td> |
| <td>$value</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_keys"> |
| <div class="location">at line 73</div> |
| <code> public array |
| <strong>keys</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns all property names.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_all"> |
| <div class="location">at line 83</div> |
| <code> public array |
| <strong>all</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns all properties and their values.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_count"> |
| <div class="location">at line 91</div> |
| <code> public |
| <strong>count</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>{@inheritdoc}</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div id="footer"> |
| Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>. |
| </div> |
| </body> |
| </html> |
| /vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/FFProbe/DataMapping/Format.html |
|---|
| @@ -0,0 +1,339 @@ |
|---|
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="robots" content="index, follow, all" /> |
| <title>FFMpeg\FFProbe\DataMapping\Format | PHP-FFMpeg API</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css"> |
| </head> |
| <body id="class"> |
| <div class="header"> |
| <ul> |
| <li><a href="../../../classes.html">Classes</a></li> |
| <li><a href="../../../namespaces.html">Namespaces</a></li> |
| <li><a href="../../../interfaces.html">Interfaces</a></li> |
| <li><a href="../../../traits.html">Traits</a></li> |
| <li><a href="../../../doc-index.html">Index</a></li> |
| |
| </ul> |
| |
| <div id="title">PHP-FFMpeg API</div> |
| |
| <div class="type">Class</div> |
| <h1><a href="../../../FFMpeg/FFProbe/DataMapping.html">FFMpeg\FFProbe\DataMapping</a>\Format</h1> |
| </div> |
| <div class="content"> |
| <p> class |
| <strong>Format</strong> extends <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a></p> |
| |
| |
| |
| |
| <h2>Methods</h2> |
| |
| <table> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method___construct">__construct</a>(array $properties) |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method___construct"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| Boolean |
| </td> |
| <td class="last"> |
| <a href="#method_has">has</a>(string $property) |
| <p>Returns true if data has property.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method_has"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| mixed |
| </td> |
| <td class="last"> |
| <a href="#method_get">get</a>(string $property) |
| <p>Returns the property value given its name.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method_get"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_set">set</a>(string $property, mixed $value) |
| <p>Sets the property value given its name.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method_set"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_keys">keys</a>() |
| <p>Returns all property names.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method_keys"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_all">all</a>() |
| <p>Returns all properties and their values.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method_all"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_count">count</a>() |
| <p>{@inheritdoc}</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method_count"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a></small></td> |
| </tr> |
| </table> |
| |
| |
| <h2>Details</h2> |
| |
| <h3 id="method___construct"> |
| <div class="location">in <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method___construct"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a> at line 20</div> |
| <code> public |
| <strong>__construct</strong>(array $properties)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td>$properties</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_has"> |
| <div class="location">in <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method_has"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a> at line 31</div> |
| <code> public Boolean |
| <strong>has</strong>(string $property)</code> |
| </h3> |
| <div class="details"> |
| <p>Returns true if data has property.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td>$property</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>Boolean</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_get"> |
| <div class="location">in <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method_get"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a> at line 44</div> |
| <code> public mixed |
| <strong>get</strong>(string $property)</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the property value given its name.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td>$property</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>mixed</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td>In case the data does not have the property</td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_set"> |
| <div class="location">in <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method_set"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a> at line 61</div> |
| <code> public <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a> |
| <strong>set</strong>(string $property, mixed $value)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the property value given its name.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td>$property</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td>mixed</td> |
| <td>$value</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_keys"> |
| <div class="location">in <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method_keys"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a> at line 73</div> |
| <code> public array |
| <strong>keys</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns all property names.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_all"> |
| <div class="location">in <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method_all"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a> at line 83</div> |
| <code> public array |
| <strong>all</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns all properties and their values.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_count"> |
| <div class="location">in <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method_count"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a> at line 91</div> |
| <code> public |
| <strong>count</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>{@inheritdoc}</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div id="footer"> |
| Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>. |
| </div> |
| </body> |
| </html> |
| /vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/FFProbe/DataMapping/Stream.html |
|---|
| @@ -0,0 +1,460 @@ |
|---|
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="robots" content="index, follow, all" /> |
| <title>FFMpeg\FFProbe\DataMapping\Stream | PHP-FFMpeg API</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css"> |
| </head> |
| <body id="class"> |
| <div class="header"> |
| <ul> |
| <li><a href="../../../classes.html">Classes</a></li> |
| <li><a href="../../../namespaces.html">Namespaces</a></li> |
| <li><a href="../../../interfaces.html">Interfaces</a></li> |
| <li><a href="../../../traits.html">Traits</a></li> |
| <li><a href="../../../doc-index.html">Index</a></li> |
| |
| </ul> |
| |
| <div id="title">PHP-FFMpeg API</div> |
| |
| <div class="type">Class</div> |
| <h1><a href="../../../FFMpeg/FFProbe/DataMapping.html">FFMpeg\FFProbe\DataMapping</a>\Stream</h1> |
| </div> |
| <div class="content"> |
| <p> class |
| <strong>Stream</strong> extends <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a></p> |
| |
| |
| |
| |
| <h2>Methods</h2> |
| |
| <table> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method___construct">__construct</a>(array $properties) |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method___construct"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| Boolean |
| </td> |
| <td class="last"> |
| <a href="#method_has">has</a>(string $property) |
| <p>Returns true if data has property.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method_has"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| mixed |
| </td> |
| <td class="last"> |
| <a href="#method_get">get</a>(string $property) |
| <p>Returns the property value given its name.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method_get"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_set">set</a>(string $property, mixed $value) |
| <p>Sets the property value given its name.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method_set"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_keys">keys</a>() |
| <p>Returns all property names.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method_keys"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_all">all</a>() |
| <p>Returns all properties and their values.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method_all"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_count">count</a>() |
| <p>{@inheritdoc}</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method_count"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| Boolean |
| </td> |
| <td class="last"> |
| <a href="#method_isAudio">isAudio</a>() |
| <p>Returns true if the stream is an audio stream.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| Boolean |
| </td> |
| <td class="last"> |
| <a href="#method_isVideo">isVideo</a>() |
| <p>Returns true if the stream is a video stream.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../../FFMpeg/Coordinate/Dimension.html"><abbr title="FFMpeg\Coordinate\Dimension">Dimension</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getDimensions">getDimensions</a>() |
| <p>Returns the dimension of the video stream.</p> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| <h2>Details</h2> |
| |
| <h3 id="method___construct"> |
| <div class="location">in <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method___construct"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a> at line 20</div> |
| <code> public |
| <strong>__construct</strong>(array $properties)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td>$properties</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_has"> |
| <div class="location">in <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method_has"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a> at line 31</div> |
| <code> public Boolean |
| <strong>has</strong>(string $property)</code> |
| </h3> |
| <div class="details"> |
| <p>Returns true if data has property.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td>$property</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>Boolean</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_get"> |
| <div class="location">in <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method_get"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a> at line 44</div> |
| <code> public mixed |
| <strong>get</strong>(string $property)</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the property value given its name.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td>$property</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>mixed</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td>In case the data does not have the property</td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_set"> |
| <div class="location">in <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method_set"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a> at line 61</div> |
| <code> public <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a> |
| <strong>set</strong>(string $property, mixed $value)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the property value given its name.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td>$property</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td>mixed</td> |
| <td>$value</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_keys"> |
| <div class="location">in <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method_keys"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a> at line 73</div> |
| <code> public array |
| <strong>keys</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns all property names.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_all"> |
| <div class="location">in <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method_all"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a> at line 83</div> |
| <code> public array |
| <strong>all</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns all properties and their values.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_count"> |
| <div class="location">in <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method_count"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a> at line 91</div> |
| <code> public |
| <strong>count</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>{@inheritdoc}</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_isAudio"> |
| <div class="location">at line 25</div> |
| <code> public Boolean |
| <strong>isAudio</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns true if the stream is an audio stream.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>Boolean</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_isVideo"> |
| <div class="location">at line 35</div> |
| <code> public Boolean |
| <strong>isVideo</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns true if the stream is a video stream.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>Boolean</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getDimensions"> |
| <div class="location">at line 48</div> |
| <code> public <a href="../../../FFMpeg/Coordinate/Dimension.html"><abbr title="FFMpeg\Coordinate\Dimension">Dimension</abbr></a> |
| <strong>getDimensions</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the dimension of the video stream.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/Coordinate/Dimension.html"><abbr title="FFMpeg\Coordinate\Dimension">Dimension</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/LogicException"><abbr title="LogicException">LogicException</abbr></a></td> |
| <td>In case the stream is not a video stream.</td> |
| </tr> |
| <tr> |
| <td><a href="http://php.net/RuntimeException"><abbr title="RuntimeException">RuntimeException</abbr></a></td> |
| <td>In case the dimensions can not be extracted.</td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div id="footer"> |
| Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>. |
| </div> |
| </body> |
| </html> |
| /vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/FFProbe/DataMapping/StreamCollection.html |
|---|
| @@ -0,0 +1,329 @@ |
|---|
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="robots" content="index, follow, all" /> |
| <title>FFMpeg\FFProbe\DataMapping\StreamCollection | PHP-FFMpeg API</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css"> |
| </head> |
| <body id="class"> |
| <div class="header"> |
| <ul> |
| <li><a href="../../../classes.html">Classes</a></li> |
| <li><a href="../../../namespaces.html">Namespaces</a></li> |
| <li><a href="../../../interfaces.html">Interfaces</a></li> |
| <li><a href="../../../traits.html">Traits</a></li> |
| <li><a href="../../../doc-index.html">Index</a></li> |
| |
| </ul> |
| |
| <div id="title">PHP-FFMpeg API</div> |
| |
| <div class="type">Class</div> |
| <h1><a href="../../../FFMpeg/FFProbe/DataMapping.html">FFMpeg\FFProbe\DataMapping</a>\StreamCollection</h1> |
| </div> |
| <div class="content"> |
| <p> class |
| <strong>StreamCollection</strong> implements |
| <a href="http://php.net/Countable"><abbr title="Countable">Countable</abbr></a>, <a href="http://php.net/IteratorAggregate"><abbr title="IteratorAggregate">IteratorAggregate</abbr></a></p> |
| |
| |
| |
| |
| <h2>Methods</h2> |
| |
| <table> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method___construct">__construct</a>(array $streams = array()) |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| null|<a href="../../../FFMpeg/FFProbe/DataMapping/Stream.html"><abbr title="FFMpeg\FFProbe\DataMapping\Stream">Stream</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_first">first</a>() |
| <p>Returns the first stream of the collection, null if the collection is empty.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../../FFMpeg/FFProbe/DataMapping/StreamCollection.html"><abbr title="FFMpeg\FFProbe\DataMapping\StreamCollection">StreamCollection</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_add">add</a>(<a href="../../../FFMpeg/FFProbe/DataMapping/Stream.html"><abbr title="FFMpeg\FFProbe\DataMapping\Stream">Stream</abbr></a> $stream) |
| <p>Adds a stream to the collection.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../../FFMpeg/FFProbe/DataMapping/StreamCollection.html"><abbr title="FFMpeg\FFProbe\DataMapping\StreamCollection">StreamCollection</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_videos">videos</a>() |
| <p>Returns a new StreamCollection with only video streams.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../../FFMpeg/FFProbe/DataMapping/StreamCollection.html"><abbr title="FFMpeg\FFProbe\DataMapping\StreamCollection">StreamCollection</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_audios">audios</a>() |
| <p>Returns a new StreamCollection with only audio streams.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_count">count</a>() |
| <p>{@inheritdoc}</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_all">all</a>() |
| <p>Returns the array of contained streams.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_getIterator">getIterator</a>() |
| <p>{@inheritdoc}</p> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| <h2>Details</h2> |
| |
| <h3 id="method___construct"> |
| <div class="location">at line 18</div> |
| <code> public |
| <strong>__construct</strong>(array $streams = array())</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td>$streams</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_first"> |
| <div class="location">at line 29</div> |
| <code> public null|<a href="../../../FFMpeg/FFProbe/DataMapping/Stream.html"><abbr title="FFMpeg\FFProbe\DataMapping\Stream">Stream</abbr></a> |
| <strong>first</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the first stream of the collection, null if the collection is empty.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>null|<a href="../../../FFMpeg/FFProbe/DataMapping/Stream.html"><abbr title="FFMpeg\FFProbe\DataMapping\Stream">Stream</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_add"> |
| <div class="location">at line 43</div> |
| <code> public <a href="../../../FFMpeg/FFProbe/DataMapping/StreamCollection.html"><abbr title="FFMpeg\FFProbe\DataMapping\StreamCollection">StreamCollection</abbr></a> |
| <strong>add</strong>(<a href="../../../FFMpeg/FFProbe/DataMapping/Stream.html"><abbr title="FFMpeg\FFProbe\DataMapping\Stream">Stream</abbr></a> $stream)</code> |
| </h3> |
| <div class="details"> |
| <p>Adds a stream to the collection.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/FFProbe/DataMapping/Stream.html"><abbr title="FFMpeg\FFProbe\DataMapping\Stream">Stream</abbr></a></td> |
| <td>$stream</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/FFProbe/DataMapping/StreamCollection.html"><abbr title="FFMpeg\FFProbe\DataMapping\StreamCollection">StreamCollection</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_videos"> |
| <div class="location">at line 55</div> |
| <code> public <a href="../../../FFMpeg/FFProbe/DataMapping/StreamCollection.html"><abbr title="FFMpeg\FFProbe\DataMapping\StreamCollection">StreamCollection</abbr></a> |
| <strong>videos</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns a new StreamCollection with only video streams.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/FFProbe/DataMapping/StreamCollection.html"><abbr title="FFMpeg\FFProbe\DataMapping\StreamCollection">StreamCollection</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_audios"> |
| <div class="location">at line 67</div> |
| <code> public <a href="../../../FFMpeg/FFProbe/DataMapping/StreamCollection.html"><abbr title="FFMpeg\FFProbe\DataMapping\StreamCollection">StreamCollection</abbr></a> |
| <strong>audios</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns a new StreamCollection with only audio streams.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/FFProbe/DataMapping/StreamCollection.html"><abbr title="FFMpeg\FFProbe\DataMapping\StreamCollection">StreamCollection</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_count"> |
| <div class="location">at line 77</div> |
| <code> public |
| <strong>count</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>{@inheritdoc}</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_all"> |
| <div class="location">at line 87</div> |
| <code> public array |
| <strong>all</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the array of contained streams.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getIterator"> |
| <div class="location">at line 95</div> |
| <code> public |
| <strong>getIterator</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>{@inheritdoc}</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div id="footer"> |
| Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>. |
| </div> |
| </body> |
| </html> |
| /vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/FFProbe.html |
|---|
| @@ -0,0 +1,736 @@ |
|---|
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="robots" content="index, follow, all" /> |
| <title>FFMpeg\FFProbe | PHP-FFMpeg API</title> |
| <link rel="stylesheet" type="text/css" href="../stylesheet.css"> |
| </head> |
| <body id="class"> |
| <div class="header"> |
| <ul> |
| <li><a href="../classes.html">Classes</a></li> |
| <li><a href="../namespaces.html">Namespaces</a></li> |
| <li><a href="../interfaces.html">Interfaces</a></li> |
| <li><a href="../traits.html">Traits</a></li> |
| <li><a href="../doc-index.html">Index</a></li> |
| |
| </ul> |
| |
| <div id="title">PHP-FFMpeg API</div> |
| |
| <div class="type">Class</div> |
| <h1><a href="../FFMpeg.html">FFMpeg</a>\FFProbe</h1> |
| </div> |
| <div class="content"> |
| <p> class |
| <strong>FFProbe</strong></p> |
| |
| |
| <h2>Constants</h2> |
| |
| <table> |
| <tr> |
| <td>TYPE_STREAMS</td> |
| <td class="last"> |
| <p><em> |
| </em></p> |
| <p> |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td>TYPE_FORMAT</td> |
| <td class="last"> |
| <p><em> |
| </em></p> |
| <p> |
| </p> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h2>Methods</h2> |
| |
| <table> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method___construct">__construct</a>(<a href="../FFMpeg/Driver/FFProbeDriver.html"><abbr title="FFMpeg\Driver\FFProbeDriver">FFProbeDriver</abbr></a> $ffprobe, <abbr title="Doctrine\Common\Cache\Cache">Cache</abbr> $cache) |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../FFMpeg/FFProbe/OutputParserInterface.html"><abbr title="FFMpeg\FFProbe\OutputParserInterface">OutputParserInterface</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getParser">getParser</a>() |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_setParser">setParser</a>(<a href="../FFMpeg/FFProbe/OutputParserInterface.html"><abbr title="FFMpeg\FFProbe\OutputParserInterface">OutputParserInterface</abbr></a> $parser) |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../FFMpeg/Driver/FFProbeDriver.html"><abbr title="FFMpeg\Driver\FFProbeDriver">FFProbeDriver</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getFFProbeDriver">getFFProbeDriver</a>() |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_setFFProbeDriver">setFFProbeDriver</a>(<a href="../FFMpeg/Driver/FFProbeDriver.html"><abbr title="FFMpeg\Driver\FFProbeDriver">FFProbeDriver</abbr></a> $ffprobe) |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_setOptionsTester">setOptionsTester</a>(<a href="../FFMpeg/FFProbe/OptionsTesterInterface.html"><abbr title="FFMpeg\FFProbe\OptionsTesterInterface">OptionsTesterInterface</abbr></a> $tester) |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../FFMpeg/FFProbe/OptionsTesterInterface.html"><abbr title="FFMpeg\FFProbe\OptionsTesterInterface">OptionsTesterInterface</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getOptionsTester">getOptionsTester</a>() |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_setCache">setCache</a>(<abbr title="Doctrine\Common\Cache\Cache">Cache</abbr> $cache) |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <abbr title="Doctrine\Common\Cache\Cache">Cache</abbr> |
| </td> |
| <td class="last"> |
| <a href="#method_getCache">getCache</a>() |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../FFMpeg/FFProbe/MapperInterface.html"><abbr title="FFMpeg\FFProbe\MapperInterface">MapperInterface</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getMapper">getMapper</a>() |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_setMapper">setMapper</a>(<a href="../FFMpeg/FFProbe/MapperInterface.html"><abbr title="FFMpeg\FFProbe\MapperInterface">MapperInterface</abbr></a> $mapper) |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../FFMpeg/FFProbe/DataMapping/Format.html"><abbr title="FFMpeg\FFProbe\DataMapping\Format">Format</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_format">format</a>(string $pathfile) |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../FFMpeg/FFProbe/DataMapping/StreamCollection.html"><abbr title="FFMpeg\FFProbe\DataMapping\StreamCollection">StreamCollection</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_streams">streams</a>(string $pathfile) |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| static <a href="../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_create">create</a>(array|<abbr title="Alchemy\BinaryDriver\ConfigurationInterface">ConfigurationInterface</abbr> $configuration = array(), <abbr title="Psr\Log\LoggerInterface">LoggerInterface</abbr> $logger = null, <abbr title="Doctrine\Common\Cache\Cache">Cache</abbr> $cache = null) |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| <h2>Details</h2> |
| |
| <h3 id="method___construct"> |
| <div class="location">at line 47</div> |
| <code> public |
| <strong>__construct</strong>(<a href="../FFMpeg/Driver/FFProbeDriver.html"><abbr title="FFMpeg\Driver\FFProbeDriver">FFProbeDriver</abbr></a> $ffprobe, <abbr title="Doctrine\Common\Cache\Cache">Cache</abbr> $cache)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../FFMpeg/Driver/FFProbeDriver.html"><abbr title="FFMpeg\Driver\FFProbeDriver">FFProbeDriver</abbr></a></td> |
| <td>$ffprobe</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><abbr title="Doctrine\Common\Cache\Cache">Cache</abbr></td> |
| <td>$cache</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getParser"> |
| <div class="location">at line 59</div> |
| <code> public <a href="../FFMpeg/FFProbe/OutputParserInterface.html"><abbr title="FFMpeg\FFProbe\OutputParserInterface">OutputParserInterface</abbr></a> |
| <strong>getParser</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../FFMpeg/FFProbe/OutputParserInterface.html"><abbr title="FFMpeg\FFProbe\OutputParserInterface">OutputParserInterface</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setParser"> |
| <div class="location">at line 69</div> |
| <code> public <a href="../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> |
| <strong>setParser</strong>(<a href="../FFMpeg/FFProbe/OutputParserInterface.html"><abbr title="FFMpeg\FFProbe\OutputParserInterface">OutputParserInterface</abbr></a> $parser)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../FFMpeg/FFProbe/OutputParserInterface.html"><abbr title="FFMpeg\FFProbe\OutputParserInterface">OutputParserInterface</abbr></a></td> |
| <td>$parser</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getFFProbeDriver"> |
| <div class="location">at line 79</div> |
| <code> public <a href="../FFMpeg/Driver/FFProbeDriver.html"><abbr title="FFMpeg\Driver\FFProbeDriver">FFProbeDriver</abbr></a> |
| <strong>getFFProbeDriver</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../FFMpeg/Driver/FFProbeDriver.html"><abbr title="FFMpeg\Driver\FFProbeDriver">FFProbeDriver</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setFFProbeDriver"> |
| <div class="location">at line 89</div> |
| <code> public <a href="../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> |
| <strong>setFFProbeDriver</strong>(<a href="../FFMpeg/Driver/FFProbeDriver.html"><abbr title="FFMpeg\Driver\FFProbeDriver">FFProbeDriver</abbr></a> $ffprobe)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../FFMpeg/Driver/FFProbeDriver.html"><abbr title="FFMpeg\Driver\FFProbeDriver">FFProbeDriver</abbr></a></td> |
| <td>$ffprobe</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setOptionsTester"> |
| <div class="location">at line 101</div> |
| <code> public <a href="../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> |
| <strong>setOptionsTester</strong>(<a href="../FFMpeg/FFProbe/OptionsTesterInterface.html"><abbr title="FFMpeg\FFProbe\OptionsTesterInterface">OptionsTesterInterface</abbr></a> $tester)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../FFMpeg/FFProbe/OptionsTesterInterface.html"><abbr title="FFMpeg\FFProbe\OptionsTesterInterface">OptionsTesterInterface</abbr></a></td> |
| <td>$tester</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getOptionsTester"> |
| <div class="location">at line 111</div> |
| <code> public <a href="../FFMpeg/FFProbe/OptionsTesterInterface.html"><abbr title="FFMpeg\FFProbe\OptionsTesterInterface">OptionsTesterInterface</abbr></a> |
| <strong>getOptionsTester</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../FFMpeg/FFProbe/OptionsTesterInterface.html"><abbr title="FFMpeg\FFProbe\OptionsTesterInterface">OptionsTesterInterface</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setCache"> |
| <div class="location">at line 121</div> |
| <code> public <a href="../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> |
| <strong>setCache</strong>(<abbr title="Doctrine\Common\Cache\Cache">Cache</abbr> $cache)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><abbr title="Doctrine\Common\Cache\Cache">Cache</abbr></td> |
| <td>$cache</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getCache"> |
| <div class="location">at line 131</div> |
| <code> public <abbr title="Doctrine\Common\Cache\Cache">Cache</abbr> |
| <strong>getCache</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><abbr title="Doctrine\Common\Cache\Cache">Cache</abbr></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getMapper"> |
| <div class="location">at line 139</div> |
| <code> public <a href="../FFMpeg/FFProbe/MapperInterface.html"><abbr title="FFMpeg\FFProbe\MapperInterface">MapperInterface</abbr></a> |
| <strong>getMapper</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../FFMpeg/FFProbe/MapperInterface.html"><abbr title="FFMpeg\FFProbe\MapperInterface">MapperInterface</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setMapper"> |
| <div class="location">at line 149</div> |
| <code> public <a href="../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> |
| <strong>setMapper</strong>(<a href="../FFMpeg/FFProbe/MapperInterface.html"><abbr title="FFMpeg\FFProbe\MapperInterface">MapperInterface</abbr></a> $mapper)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../FFMpeg/FFProbe/MapperInterface.html"><abbr title="FFMpeg\FFProbe\MapperInterface">MapperInterface</abbr></a></td> |
| <td>$mapper</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_format"> |
| <div class="location">at line 168</div> |
| <code> public <a href="../FFMpeg/FFProbe/DataMapping/Format.html"><abbr title="FFMpeg\FFProbe\DataMapping\Format">Format</abbr></a> |
| <strong>format</strong>(string $pathfile)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td>$pathfile</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../FFMpeg/FFProbe/DataMapping/Format.html"><abbr title="FFMpeg\FFProbe\DataMapping\Format">Format</abbr></a></td> |
| <td>A Format object</td> |
| </tr> |
| </table> |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="http://php.net/RuntimeException"><abbr title="RuntimeException">RuntimeException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_streams"> |
| <div class="location">at line 185</div> |
| <code> public <a href="../FFMpeg/FFProbe/DataMapping/StreamCollection.html"><abbr title="FFMpeg\FFProbe\DataMapping\StreamCollection">StreamCollection</abbr></a> |
| <strong>streams</strong>(string $pathfile)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td>$pathfile</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../FFMpeg/FFProbe/DataMapping/StreamCollection.html"><abbr title="FFMpeg\FFProbe\DataMapping\StreamCollection">StreamCollection</abbr></a></td> |
| <td>A collection of streams</td> |
| </tr> |
| </table> |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="http://php.net/RuntimeException"><abbr title="RuntimeException">RuntimeException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_create"> |
| <div class="location">at line 201</div> |
| <code> static public <a href="../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> |
| <strong>create</strong>(array|<abbr title="Alchemy\BinaryDriver\ConfigurationInterface">ConfigurationInterface</abbr> $configuration = array(), <abbr title="Psr\Log\LoggerInterface">LoggerInterface</abbr> $logger = null, <abbr title="Doctrine\Common\Cache\Cache">Cache</abbr> $cache = null)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>array|<abbr title="Alchemy\BinaryDriver\ConfigurationInterface">ConfigurationInterface</abbr></td> |
| <td>$configuration</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><abbr title="Psr\Log\LoggerInterface">LoggerInterface</abbr></td> |
| <td>$logger</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><abbr title="Doctrine\Common\Cache\Cache">Cache</abbr></td> |
| <td>$cache</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div id="footer"> |
| Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>. |
| </div> |
| </body> |
| </html> |
| /vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/Filters/Audio/AudioResamplableFilter.html |
|---|
| @@ -0,0 +1,218 @@ |
|---|
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="robots" content="index, follow, all" /> |
| <title>FFMpeg\Filters\Audio\AudioResamplableFilter | PHP-FFMpeg API</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css"> |
| </head> |
| <body id="class"> |
| <div class="header"> |
| <ul> |
| <li><a href="../../../classes.html">Classes</a></li> |
| <li><a href="../../../namespaces.html">Namespaces</a></li> |
| <li><a href="../../../interfaces.html">Interfaces</a></li> |
| <li><a href="../../../traits.html">Traits</a></li> |
| <li><a href="../../../doc-index.html">Index</a></li> |
| |
| </ul> |
| |
| <div id="title">PHP-FFMpeg API</div> |
| |
| <div class="type">Class</div> |
| <h1><a href="../../../FFMpeg/Filters/Audio.html">FFMpeg\Filters\Audio</a>\AudioResamplableFilter</h1> |
| </div> |
| <div class="content"> |
| <p> class |
| <strong>AudioResamplableFilter</strong> implements |
| <a href="../../../FFMpeg/Filters/Audio/AudioFilterInterface.html"><abbr title="FFMpeg\Filters\Audio\AudioFilterInterface">AudioFilterInterface</abbr></a></p> |
| |
| |
| |
| |
| <h2>Methods</h2> |
| |
| <table> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method___construct">__construct</a>($rate, $priority) |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getPriority">getPriority</a>() |
| <p>Returns the priority of the filter.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| Integer |
| </td> |
| <td class="last"> |
| <a href="#method_getRate">getRate</a>() |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_apply">apply</a>(<a href="../../../FFMpeg/Media/Audio.html"><abbr title="FFMpeg\Media\Audio">Audio</abbr></a> $audio, <a href="../../../FFMpeg/Format/AudioInterface.html"><abbr title="FFMpeg\Format\AudioInterface">AudioInterface</abbr></a> $format) |
| <p>Applies the filter on the the Audio media given an format.</p> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| <h2>Details</h2> |
| |
| <h3 id="method___construct"> |
| <div class="location">at line 24</div> |
| <code> public |
| <strong>__construct</strong>($rate, $priority)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td></td> |
| <td>$rate</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$priority</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getPriority"> |
| <div class="location">at line 33</div> |
| <code> public integer |
| <strong>getPriority</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the priority of the filter.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getRate"> |
| <div class="location">at line 42</div> |
| <code> public Integer |
| <strong>getRate</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>Integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_apply"> |
| <div class="location">at line 50</div> |
| <code> public array |
| <strong>apply</strong>(<a href="../../../FFMpeg/Media/Audio.html"><abbr title="FFMpeg\Media\Audio">Audio</abbr></a> $audio, <a href="../../../FFMpeg/Format/AudioInterface.html"><abbr title="FFMpeg\Format\AudioInterface">AudioInterface</abbr></a> $format)</code> |
| </h3> |
| <div class="details"> |
| <p>Applies the filter on the the Audio media given an format.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/Media/Audio.html"><abbr title="FFMpeg\Media\Audio">Audio</abbr></a></td> |
| <td>$audio</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../../../FFMpeg/Format/AudioInterface.html"><abbr title="FFMpeg\Format\AudioInterface">AudioInterface</abbr></a></td> |
| <td>$format</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td>An array of arguments</td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div id="footer"> |
| Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>. |
| </div> |
| </body> |
| </html> |
| /vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/Filters/Video/ClipFilter.html |
|---|
| @@ -0,0 +1,262 @@ |
|---|
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="robots" content="index, follow, all" /> |
| <title>FFMpeg\Filters\Video\ClipFilter | PHP-FFMpeg API</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css"> |
| </head> |
| <body id="class"> |
| <div class="header"> |
| <ul> |
| <li><a href="../../../classes.html">Classes</a></li> |
| <li><a href="../../../namespaces.html">Namespaces</a></li> |
| <li><a href="../../../interfaces.html">Interfaces</a></li> |
| <li><a href="../../../traits.html">Traits</a></li> |
| <li><a href="../../../doc-index.html">Index</a></li> |
| |
| </ul> |
| |
| <div id="title">PHP-FFMpeg API</div> |
| |
| <div class="type">Class</div> |
| <h1><a href="../../../FFMpeg/Filters/Video.html">FFMpeg\Filters\Video</a>\ClipFilter</h1> |
| </div> |
| <div class="content"> |
| <p> class |
| <strong>ClipFilter</strong> implements |
| <a href="../../../FFMpeg/Filters/Video/VideoFilterInterface.html"><abbr title="FFMpeg\Filters\Video\VideoFilterInterface">VideoFilterInterface</abbr></a></p> |
| |
| |
| |
| |
| <h2>Methods</h2> |
| |
| <table> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method___construct">__construct</a>(<a href="../../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a> $start, <a href="../../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a> $duration = null, $priority) |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getPriority">getPriority</a>() |
| <p>Returns the priority of the filter.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getStart">getStart</a>() |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getDuration">getDuration</a>() |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_apply">apply</a>(<a href="../../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a> $video, <a href="../../../FFMpeg/Format/VideoInterface.html"><abbr title="FFMpeg\Format\VideoInterface">VideoInterface</abbr></a> $format) |
| <p>Applies the filter on the the Video media given an format.</p> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| <h2>Details</h2> |
| |
| <h3 id="method___construct"> |
| <div class="location">at line 27</div> |
| <code> public |
| <strong>__construct</strong>(<a href="../../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a> $start, <a href="../../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a> $duration = null, $priority)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a></td> |
| <td>$start</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a></td> |
| <td>$duration</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$priority</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getPriority"> |
| <div class="location">at line 37</div> |
| <code> public integer |
| <strong>getPriority</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the priority of the filter.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getStart"> |
| <div class="location">at line 45</div> |
| <code> public <a href="../../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a> |
| <strong>getStart</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getDuration"> |
| <div class="location">at line 53</div> |
| <code> public <a href="../../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a> |
| <strong>getDuration</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_apply"> |
| <div class="location">at line 61</div> |
| <code> public array |
| <strong>apply</strong>(<a href="../../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a> $video, <a href="../../../FFMpeg/Format/VideoInterface.html"><abbr title="FFMpeg\Format\VideoInterface">VideoInterface</abbr></a> $format)</code> |
| </h3> |
| <div class="details"> |
| <p>Applies the filter on the the Video media given an format.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a></td> |
| <td>$video</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../../../FFMpeg/Format/VideoInterface.html"><abbr title="FFMpeg\Format\VideoInterface">VideoInterface</abbr></a></td> |
| <td>$format</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td>An array of arguments</td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div id="footer"> |
| Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>. |
| </div> |
| </body> |
| </html> |
| /vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/Filters/Video/CustomFilter.html |
|---|
| @@ -0,0 +1,178 @@ |
|---|
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="robots" content="index, follow, all" /> |
| <title>FFMpeg\Filters\Video\CustomFilter | PHP-FFMpeg API</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css"> |
| </head> |
| <body id="class"> |
| <div class="header"> |
| <ul> |
| <li><a href="../../../classes.html">Classes</a></li> |
| <li><a href="../../../namespaces.html">Namespaces</a></li> |
| <li><a href="../../../interfaces.html">Interfaces</a></li> |
| <li><a href="../../../traits.html">Traits</a></li> |
| <li><a href="../../../doc-index.html">Index</a></li> |
| |
| </ul> |
| |
| <div id="title">PHP-FFMpeg API</div> |
| |
| <div class="type">Class</div> |
| <h1><a href="../../../FFMpeg/Filters/Video.html">FFMpeg\Filters\Video</a>\CustomFilter</h1> |
| </div> |
| <div class="content"> |
| <p> class |
| <strong>CustomFilter</strong> implements |
| <a href="../../../FFMpeg/Filters/Video/VideoFilterInterface.html"><abbr title="FFMpeg\Filters\Video\VideoFilterInterface">VideoFilterInterface</abbr></a></p> |
| |
| |
| |
| |
| <h2>Methods</h2> |
| |
| <table> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method___construct">__construct</a>(string $filter, int $priority) |
| <p>A custom filter, useful if you want to build complex filters</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getPriority">getPriority</a>() |
| <p>Returns the priority of the filter.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_apply">apply</a>(<a href="../../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a> $video, <a href="../../../FFMpeg/Format/VideoInterface.html"><abbr title="FFMpeg\Format\VideoInterface">VideoInterface</abbr></a> $format) |
| <p>Applies the filter on the the Video media given an format.</p> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| <h2>Details</h2> |
| |
| <h3 id="method___construct"> |
| <div class="location">at line 29</div> |
| <code> public |
| <strong>__construct</strong>(string $filter, int $priority)</code> |
| </h3> |
| <div class="details"> |
| <p>A custom filter, useful if you want to build complex filters</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td>$filter</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td>int</td> |
| <td>$priority</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getPriority"> |
| <div class="location">at line 38</div> |
| <code> public integer |
| <strong>getPriority</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the priority of the filter.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_apply"> |
| <div class="location">at line 46</div> |
| <code> public array |
| <strong>apply</strong>(<a href="../../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a> $video, <a href="../../../FFMpeg/Format/VideoInterface.html"><abbr title="FFMpeg\Format\VideoInterface">VideoInterface</abbr></a> $format)</code> |
| </h3> |
| <div class="details"> |
| <p>Applies the filter on the the Video media given an format.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a></td> |
| <td>$video</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../../../FFMpeg/Format/VideoInterface.html"><abbr title="FFMpeg\Format\VideoInterface">VideoInterface</abbr></a></td> |
| <td>$format</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td>An array of arguments</td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div id="footer"> |
| Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>. |
| </div> |
| </body> |
| </html> |
| /vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/Filters/Video/FrameRateFilter.html |
|---|
| @@ -0,0 +1,267 @@ |
|---|
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="robots" content="index, follow, all" /> |
| <title>FFMpeg\Filters\Video\FrameRateFilter | PHP-FFMpeg API</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css"> |
| </head> |
| <body id="class"> |
| <div class="header"> |
| <ul> |
| <li><a href="../../../classes.html">Classes</a></li> |
| <li><a href="../../../namespaces.html">Namespaces</a></li> |
| <li><a href="../../../interfaces.html">Interfaces</a></li> |
| <li><a href="../../../traits.html">Traits</a></li> |
| <li><a href="../../../doc-index.html">Index</a></li> |
| |
| </ul> |
| |
| <div id="title">PHP-FFMpeg API</div> |
| |
| <div class="type">Class</div> |
| <h1><a href="../../../FFMpeg/Filters/Video.html">FFMpeg\Filters\Video</a>\FrameRateFilter</h1> |
| </div> |
| <div class="content"> |
| <p> class |
| <strong>FrameRateFilter</strong> implements |
| <a href="../../../FFMpeg/Filters/Video/VideoFilterInterface.html"><abbr title="FFMpeg\Filters\Video\VideoFilterInterface">VideoFilterInterface</abbr></a></p> |
| |
| |
| |
| |
| <h2>Methods</h2> |
| |
| <table> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method___construct">__construct</a>(<a href="../../../FFMpeg/Coordinate/FrameRate.html"><abbr title="FFMpeg\Coordinate\FrameRate">FrameRate</abbr></a> $rate, $gop, $priority) |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getPriority">getPriority</a>() |
| <p>Returns the priority of the filter.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../../FFMpeg/Coordinate/FrameRate.html"><abbr title="FFMpeg\Coordinate\FrameRate">FrameRate</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getFrameRate">getFrameRate</a>() |
| <p>Returns the frame rate.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| Integer |
| </td> |
| <td class="last"> |
| <a href="#method_getGOP">getGOP</a>() |
| <p>Returns the GOP size.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_apply">apply</a>(<a href="../../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a> $video, <a href="../../../FFMpeg/Format/VideoInterface.html"><abbr title="FFMpeg\Format\VideoInterface">VideoInterface</abbr></a> $format) |
| <p>Applies the filter on the the Video media given an format.</p> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| <h2>Details</h2> |
| |
| <h3 id="method___construct"> |
| <div class="location">at line 24</div> |
| <code> public |
| <strong>__construct</strong>(<a href="../../../FFMpeg/Coordinate/FrameRate.html"><abbr title="FFMpeg\Coordinate\FrameRate">FrameRate</abbr></a> $rate, $gop, $priority)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/Coordinate/FrameRate.html"><abbr title="FFMpeg\Coordinate\FrameRate">FrameRate</abbr></a></td> |
| <td>$rate</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$gop</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$priority</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getPriority"> |
| <div class="location">at line 34</div> |
| <code> public integer |
| <strong>getPriority</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the priority of the filter.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getFrameRate"> |
| <div class="location">at line 44</div> |
| <code> public <a href="../../../FFMpeg/Coordinate/FrameRate.html"><abbr title="FFMpeg\Coordinate\FrameRate">FrameRate</abbr></a> |
| <strong>getFrameRate</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the frame rate.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/Coordinate/FrameRate.html"><abbr title="FFMpeg\Coordinate\FrameRate">FrameRate</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getGOP"> |
| <div class="location">at line 56</div> |
| <code> public Integer |
| <strong>getGOP</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the GOP size.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>Integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>See also</h4> |
| |
| <table> |
| <tr> |
| <td>https://wikipedia.org/wiki/Group_of_pictures</td> |
| <td></td> |
| </tr> |
| </table> |
| |
| </div> |
| </div> |
| |
| <h3 id="method_apply"> |
| <div class="location">at line 64</div> |
| <code> public array |
| <strong>apply</strong>(<a href="../../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a> $video, <a href="../../../FFMpeg/Format/VideoInterface.html"><abbr title="FFMpeg\Format\VideoInterface">VideoInterface</abbr></a> $format)</code> |
| </h3> |
| <div class="details"> |
| <p>Applies the filter on the the Video media given an format.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a></td> |
| <td>$video</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../../../FFMpeg/Format/VideoInterface.html"><abbr title="FFMpeg\Format\VideoInterface">VideoInterface</abbr></a></td> |
| <td>$format</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td>An array of arguments</td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div id="footer"> |
| Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>. |
| </div> |
| </body> |
| </html> |
| /vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/Filters/Video/ResizeFilter.html |
|---|
| @@ -0,0 +1,343 @@ |
|---|
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="robots" content="index, follow, all" /> |
| <title>FFMpeg\Filters\Video\ResizeFilter | PHP-FFMpeg API</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css"> |
| </head> |
| <body id="class"> |
| <div class="header"> |
| <ul> |
| <li><a href="../../../classes.html">Classes</a></li> |
| <li><a href="../../../namespaces.html">Namespaces</a></li> |
| <li><a href="../../../interfaces.html">Interfaces</a></li> |
| <li><a href="../../../traits.html">Traits</a></li> |
| <li><a href="../../../doc-index.html">Index</a></li> |
| |
| </ul> |
| |
| <div id="title">PHP-FFMpeg API</div> |
| |
| <div class="type">Class</div> |
| <h1><a href="../../../FFMpeg/Filters/Video.html">FFMpeg\Filters\Video</a>\ResizeFilter</h1> |
| </div> |
| <div class="content"> |
| <p> class |
| <strong>ResizeFilter</strong> implements |
| <a href="../../../FFMpeg/Filters/Video/VideoFilterInterface.html"><abbr title="FFMpeg\Filters\Video\VideoFilterInterface">VideoFilterInterface</abbr></a></p> |
| |
| |
| <h2>Constants</h2> |
| |
| <table> |
| <tr> |
| <td>RESIZEMODE_FIT</td> |
| <td class="last"> |
| <p><em>fits to the dimensions, might introduce anamorphosis</em></p> |
| <p> |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td>RESIZEMODE_INSET</td> |
| <td class="last"> |
| <p><em>resizes the video inside the given dimension, no anamorphosis</em></p> |
| <p> |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td>RESIZEMODE_SCALE_WIDTH</td> |
| <td class="last"> |
| <p><em>resizes the video to fit the dimension width, no anamorphosis</em></p> |
| <p> |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td>RESIZEMODE_SCALE_HEIGHT</td> |
| <td class="last"> |
| <p><em>resizes the video to fit the dimension height, no anamorphosis</em></p> |
| <p> |
| </p> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h2>Methods</h2> |
| |
| <table> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method___construct">__construct</a>(<a href="../../../FFMpeg/Coordinate/Dimension.html"><abbr title="FFMpeg\Coordinate\Dimension">Dimension</abbr></a> $dimension, $mode = self::RESIZEMODE_FIT, $forceStandards = true, $priority) |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getPriority">getPriority</a>() |
| <p>Returns the priority of the filter.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../../FFMpeg/Coordinate/Dimension.html"><abbr title="FFMpeg\Coordinate\Dimension">Dimension</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getDimension">getDimension</a>() |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getMode">getMode</a>() |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| Boolean |
| </td> |
| <td class="last"> |
| <a href="#method_areStandardsForced">areStandardsForced</a>() |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_apply">apply</a>(<a href="../../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a> $video, <a href="../../../FFMpeg/Format/VideoInterface.html"><abbr title="FFMpeg\Format\VideoInterface">VideoInterface</abbr></a> $format) |
| <p>Applies the filter on the the Video media given an format.</p> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| <h2>Details</h2> |
| |
| <h3 id="method___construct"> |
| <div class="location">at line 39</div> |
| <code> public |
| <strong>__construct</strong>(<a href="../../../FFMpeg/Coordinate/Dimension.html"><abbr title="FFMpeg\Coordinate\Dimension">Dimension</abbr></a> $dimension, $mode = self::RESIZEMODE_FIT, $forceStandards = true, $priority)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/Coordinate/Dimension.html"><abbr title="FFMpeg\Coordinate\Dimension">Dimension</abbr></a></td> |
| <td>$dimension</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$mode</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$forceStandards</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$priority</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getPriority"> |
| <div class="location">at line 50</div> |
| <code> public integer |
| <strong>getPriority</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the priority of the filter.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getDimension"> |
| <div class="location">at line 58</div> |
| <code> public <a href="../../../FFMpeg/Coordinate/Dimension.html"><abbr title="FFMpeg\Coordinate\Dimension">Dimension</abbr></a> |
| <strong>getDimension</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/Coordinate/Dimension.html"><abbr title="FFMpeg\Coordinate\Dimension">Dimension</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getMode"> |
| <div class="location">at line 66</div> |
| <code> public string |
| <strong>getMode</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_areStandardsForced"> |
| <div class="location">at line 74</div> |
| <code> public Boolean |
| <strong>areStandardsForced</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>Boolean</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_apply"> |
| <div class="location">at line 82</div> |
| <code> public array |
| <strong>apply</strong>(<a href="../../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a> $video, <a href="../../../FFMpeg/Format/VideoInterface.html"><abbr title="FFMpeg\Format\VideoInterface">VideoInterface</abbr></a> $format)</code> |
| </h3> |
| <div class="details"> |
| <p>Applies the filter on the the Video media given an format.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a></td> |
| <td>$video</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../../../FFMpeg/Format/VideoInterface.html"><abbr title="FFMpeg\Format\VideoInterface">VideoInterface</abbr></a></td> |
| <td>$format</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td>An array of arguments</td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div id="footer"> |
| Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>. |
| </div> |
| </body> |
| </html> |
| /vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/Filters/Video/RotateFilter.html |
|---|
| @@ -0,0 +1,250 @@ |
|---|
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="robots" content="index, follow, all" /> |
| <title>FFMpeg\Filters\Video\RotateFilter | PHP-FFMpeg API</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css"> |
| </head> |
| <body id="class"> |
| <div class="header"> |
| <ul> |
| <li><a href="../../../classes.html">Classes</a></li> |
| <li><a href="../../../namespaces.html">Namespaces</a></li> |
| <li><a href="../../../interfaces.html">Interfaces</a></li> |
| <li><a href="../../../traits.html">Traits</a></li> |
| <li><a href="../../../doc-index.html">Index</a></li> |
| |
| </ul> |
| |
| <div id="title">PHP-FFMpeg API</div> |
| |
| <div class="type">Class</div> |
| <h1><a href="../../../FFMpeg/Filters/Video.html">FFMpeg\Filters\Video</a>\RotateFilter</h1> |
| </div> |
| <div class="content"> |
| <p> class |
| <strong>RotateFilter</strong> implements |
| <a href="../../../FFMpeg/Filters/Video/VideoFilterInterface.html"><abbr title="FFMpeg\Filters\Video\VideoFilterInterface">VideoFilterInterface</abbr></a></p> |
| |
| |
| <h2>Constants</h2> |
| |
| <table> |
| <tr> |
| <td>ROTATE_90</td> |
| <td class="last"> |
| <p><em> |
| </em></p> |
| <p> |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td>ROTATE_180</td> |
| <td class="last"> |
| <p><em> |
| </em></p> |
| <p> |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td>ROTATE_270</td> |
| <td class="last"> |
| <p><em> |
| </em></p> |
| <p> |
| </p> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h2>Methods</h2> |
| |
| <table> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method___construct">__construct</a>($angle, $priority) |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getPriority">getPriority</a>() |
| <p>Returns the priority of the filter.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../../FFMpeg/Coordinate/Dimension.html"><abbr title="FFMpeg\Coordinate\Dimension">Dimension</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getAngle">getAngle</a>() |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_apply">apply</a>(<a href="../../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a> $video, <a href="../../../FFMpeg/Format/VideoInterface.html"><abbr title="FFMpeg\Format\VideoInterface">VideoInterface</abbr></a> $format) |
| <p>Applies the filter on the the Video media given an format.</p> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| <h2>Details</h2> |
| |
| <h3 id="method___construct"> |
| <div class="location">at line 30</div> |
| <code> public |
| <strong>__construct</strong>($angle, $priority)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td></td> |
| <td>$angle</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$priority</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getPriority"> |
| <div class="location">at line 39</div> |
| <code> public integer |
| <strong>getPriority</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the priority of the filter.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAngle"> |
| <div class="location">at line 47</div> |
| <code> public <a href="../../../FFMpeg/Coordinate/Dimension.html"><abbr title="FFMpeg\Coordinate\Dimension">Dimension</abbr></a> |
| <strong>getAngle</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/Coordinate/Dimension.html"><abbr title="FFMpeg\Coordinate\Dimension">Dimension</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_apply"> |
| <div class="location">at line 55</div> |
| <code> public array |
| <strong>apply</strong>(<a href="../../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a> $video, <a href="../../../FFMpeg/Format/VideoInterface.html"><abbr title="FFMpeg\Format\VideoInterface">VideoInterface</abbr></a> $format)</code> |
| </h3> |
| <div class="details"> |
| <p>Applies the filter on the the Video media given an format.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a></td> |
| <td>$video</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../../../FFMpeg/Format/VideoInterface.html"><abbr title="FFMpeg\Format\VideoInterface">VideoInterface</abbr></a></td> |
| <td>$format</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td>An array of arguments</td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div id="footer"> |
| Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>. |
| </div> |
| </body> |
| </html> |
| /vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/Filters/Video/SynchronizeFilter.html |
|---|
| @@ -0,0 +1,179 @@ |
|---|
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="robots" content="index, follow, all" /> |
| <title>FFMpeg\Filters\Video\SynchronizeFilter | PHP-FFMpeg API</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css"> |
| </head> |
| <body id="class"> |
| <div class="header"> |
| <ul> |
| <li><a href="../../../classes.html">Classes</a></li> |
| <li><a href="../../../namespaces.html">Namespaces</a></li> |
| <li><a href="../../../interfaces.html">Interfaces</a></li> |
| <li><a href="../../../traits.html">Traits</a></li> |
| <li><a href="../../../doc-index.html">Index</a></li> |
| |
| </ul> |
| |
| <div id="title">PHP-FFMpeg API</div> |
| |
| <div class="type">Class</div> |
| <h1><a href="../../../FFMpeg/Filters/Video.html">FFMpeg\Filters\Video</a>\SynchronizeFilter</h1> |
| </div> |
| <div class="content"> |
| <p> class |
| <strong>SynchronizeFilter</strong> implements |
| <a href="../../../FFMpeg/Filters/Video/VideoFilterInterface.html"><abbr title="FFMpeg\Filters\Video\VideoFilterInterface">VideoFilterInterface</abbr></a></p> |
| |
| <div class="description"> |
| <p>Synchronizes audio and video in case of desynchronized movies.</p> |
| <p> |
| </p> |
| </div> |
| |
| |
| |
| <h2>Methods</h2> |
| |
| <table> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method___construct">__construct</a>($priority = 12) |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getPriority">getPriority</a>() |
| <p>Returns the priority of the filter.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_apply">apply</a>(<a href="../../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a> $video, <a href="../../../FFMpeg/Format/VideoInterface.html"><abbr title="FFMpeg\Format\VideoInterface">VideoInterface</abbr></a> $format) |
| <p>Applies the filter on the the Video media given an format.</p> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| <h2>Details</h2> |
| |
| <h3 id="method___construct"> |
| <div class="location">at line 24</div> |
| <code> public |
| <strong>__construct</strong>($priority = 12)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td></td> |
| <td>$priority</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getPriority"> |
| <div class="location">at line 32</div> |
| <code> public integer |
| <strong>getPriority</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the priority of the filter.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_apply"> |
| <div class="location">at line 40</div> |
| <code> public array |
| <strong>apply</strong>(<a href="../../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a> $video, <a href="../../../FFMpeg/Format/VideoInterface.html"><abbr title="FFMpeg\Format\VideoInterface">VideoInterface</abbr></a> $format)</code> |
| </h3> |
| <div class="details"> |
| <p>Applies the filter on the the Video media given an format.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a></td> |
| <td>$video</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../../../FFMpeg/Format/VideoInterface.html"><abbr title="FFMpeg\Format\VideoInterface">VideoInterface</abbr></a></td> |
| <td>$format</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td>An array of arguments</td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div id="footer"> |
| Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>. |
| </div> |
| </body> |
| </html> |
| /vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/Filters/Video/VideoFilters.html |
|---|
| @@ -0,0 +1,474 @@ |
|---|
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="robots" content="index, follow, all" /> |
| <title>FFMpeg\Filters\Video\VideoFilters | PHP-FFMpeg API</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css"> |
| </head> |
| <body id="class"> |
| <div class="header"> |
| <ul> |
| <li><a href="../../../classes.html">Classes</a></li> |
| <li><a href="../../../namespaces.html">Namespaces</a></li> |
| <li><a href="../../../interfaces.html">Interfaces</a></li> |
| <li><a href="../../../traits.html">Traits</a></li> |
| <li><a href="../../../doc-index.html">Index</a></li> |
| |
| </ul> |
| |
| <div id="title">PHP-FFMpeg API</div> |
| |
| <div class="type">Class</div> |
| <h1><a href="../../../FFMpeg/Filters/Video.html">FFMpeg\Filters\Video</a>\VideoFilters</h1> |
| </div> |
| <div class="content"> |
| <p> class |
| <strong>VideoFilters</strong> extends <a href="../../../FFMpeg/Filters/Audio/AudioFilters.html"><abbr title="FFMpeg\Filters\Audio\AudioFilters">AudioFilters</abbr></a></p> |
| |
| |
| |
| |
| <h2>Methods</h2> |
| |
| <table> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method___construct">__construct</a>(<a href="../../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a> $media) |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../../FFMpeg/Filters/Audio/AudioFilters.html"><abbr title="FFMpeg\Filters\Audio\AudioFilters">AudioFilters</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_resample">resample</a>(Integer $rate) |
| <p>Resamples the audio file.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Filters/Audio/AudioFilters.html#method_resample"><abbr title="FFMpeg\Filters\Audio\AudioFilters">AudioFilters</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../../FFMpeg/Filters/Video/VideoFilters.html"><abbr title="FFMpeg\Filters\Video\VideoFilters">VideoFilters</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_resize">resize</a>(<a href="../../../FFMpeg/Coordinate/Dimension.html"><abbr title="FFMpeg\Coordinate\Dimension">Dimension</abbr></a> $dimension, string $mode = ResizeFilter::RESIZEMODE_FIT, Boolean $forceStandards = true) |
| <p>Resizes a video to a given dimension.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../../FFMpeg/Filters/Video/VideoFilters.html"><abbr title="FFMpeg\Filters\Video\VideoFilters">VideoFilters</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_framerate">framerate</a>(<a href="../../../FFMpeg/Coordinate/FrameRate.html"><abbr title="FFMpeg\Coordinate\FrameRate">FrameRate</abbr></a> $framerate, <abbr title="FFMpeg\Filters\Video\type">type</abbr> $gop) |
| <p>Changes the video framerate.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../../FFMpeg/Filters/Video/VideoFilters.html"><abbr title="FFMpeg\Filters\Video\VideoFilters">VideoFilters</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_synchronize">synchronize</a>() |
| <p>Synchronizes audio and video.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../../FFMpeg/Filters/Video/VideoFilters.html"><abbr title="FFMpeg\Filters\Video\VideoFilters">VideoFilters</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_clip">clip</a>(<a href="../../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a> $start, <a href="../../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a> $duration = null) |
| <p>Clips (cuts) the video.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../../FFMpeg/Filters/Audio/AudioFilters.html"><abbr title="FFMpeg\Filters\Audio\AudioFilters">AudioFilters</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_audioResample">audioResample</a>(Integer $rate) |
| <p>Resamples the audio file.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_rotate">rotate</a>($angle) |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <abbr title="FFMpeg\Filters\Video\$this">$this</abbr> |
| </td> |
| <td class="last"> |
| <a href="#method_watermark">watermark</a>(string $imagePath, array $coordinates = array()) |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| <h2>Details</h2> |
| |
| <h3 id="method___construct"> |
| <div class="location">at line 23</div> |
| <code> public |
| <strong>__construct</strong>(<a href="../../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a> $media)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a></td> |
| <td>$media</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_resample"> |
| <div class="location">in <a href="../../../FFMpeg/Filters/Audio/AudioFilters.html#method_resample"><abbr title="FFMpeg\Filters\Audio\AudioFilters">AudioFilters</abbr></a> at line 23</div> |
| <code> public <a href="../../../FFMpeg/Filters/Audio/AudioFilters.html"><abbr title="FFMpeg\Filters\Audio\AudioFilters">AudioFilters</abbr></a> |
| <strong>resample</strong>(Integer $rate)</code> |
| </h3> |
| <div class="details"> |
| <p>Resamples the audio file.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>Integer</td> |
| <td>$rate</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/Filters/Audio/AudioFilters.html"><abbr title="FFMpeg\Filters\Audio\AudioFilters">AudioFilters</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_resize"> |
| <div class="location">at line 37</div> |
| <code> public <a href="../../../FFMpeg/Filters/Video/VideoFilters.html"><abbr title="FFMpeg\Filters\Video\VideoFilters">VideoFilters</abbr></a> |
| <strong>resize</strong>(<a href="../../../FFMpeg/Coordinate/Dimension.html"><abbr title="FFMpeg\Coordinate\Dimension">Dimension</abbr></a> $dimension, string $mode = ResizeFilter::RESIZEMODE_FIT, Boolean $forceStandards = true)</code> |
| </h3> |
| <div class="details"> |
| <p>Resizes a video to a given dimension.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/Coordinate/Dimension.html"><abbr title="FFMpeg\Coordinate\Dimension">Dimension</abbr></a></td> |
| <td>$dimension</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td>string</td> |
| <td>$mode</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td>Boolean</td> |
| <td>$forceStandards</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/Filters/Video/VideoFilters.html"><abbr title="FFMpeg\Filters\Video\VideoFilters">VideoFilters</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_framerate"> |
| <div class="location">at line 52</div> |
| <code> public <a href="../../../FFMpeg/Filters/Video/VideoFilters.html"><abbr title="FFMpeg\Filters\Video\VideoFilters">VideoFilters</abbr></a> |
| <strong>framerate</strong>(<a href="../../../FFMpeg/Coordinate/FrameRate.html"><abbr title="FFMpeg\Coordinate\FrameRate">FrameRate</abbr></a> $framerate, <abbr title="FFMpeg\Filters\Video\type">type</abbr> $gop)</code> |
| </h3> |
| <div class="details"> |
| <p>Changes the video framerate.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/Coordinate/FrameRate.html"><abbr title="FFMpeg\Coordinate\FrameRate">FrameRate</abbr></a></td> |
| <td>$framerate</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><abbr title="FFMpeg\Filters\Video\type">type</abbr></td> |
| <td>$gop</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/Filters/Video/VideoFilters.html"><abbr title="FFMpeg\Filters\Video\VideoFilters">VideoFilters</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_synchronize"> |
| <div class="location">at line 64</div> |
| <code> public <a href="../../../FFMpeg/Filters/Video/VideoFilters.html"><abbr title="FFMpeg\Filters\Video\VideoFilters">VideoFilters</abbr></a> |
| <strong>synchronize</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Synchronizes audio and video.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/Filters/Video/VideoFilters.html"><abbr title="FFMpeg\Filters\Video\VideoFilters">VideoFilters</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_clip"> |
| <div class="location">at line 79</div> |
| <code> public <a href="../../../FFMpeg/Filters/Video/VideoFilters.html"><abbr title="FFMpeg\Filters\Video\VideoFilters">VideoFilters</abbr></a> |
| <strong>clip</strong>(<a href="../../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a> $start, <a href="../../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a> $duration = null)</code> |
| </h3> |
| <div class="details"> |
| <p>Clips (cuts) the video.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a></td> |
| <td>$start</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a></td> |
| <td>$duration</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/Filters/Video/VideoFilters.html"><abbr title="FFMpeg\Filters\Video\VideoFilters">VideoFilters</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_audioResample"> |
| <div class="location">at line 93</div> |
| <code> public <a href="../../../FFMpeg/Filters/Audio/AudioFilters.html"><abbr title="FFMpeg\Filters\Audio\AudioFilters">AudioFilters</abbr></a> |
| <strong>audioResample</strong>(Integer $rate)</code> |
| </h3> |
| <div class="details"> |
| <p>Resamples the audio file.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>Integer</td> |
| <td>$rate</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/Filters/Audio/AudioFilters.html"><abbr title="FFMpeg\Filters\Audio\AudioFilters">AudioFilters</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_rotate"> |
| <div class="location">at line 100</div> |
| <code> public |
| <strong>rotate</strong>($angle)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td></td> |
| <td>$angle</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_watermark"> |
| <div class="location">at line 113</div> |
| <code> public <abbr title="FFMpeg\Filters\Video\$this">$this</abbr> |
| <strong>watermark</strong>(string $imagePath, array $coordinates = array())</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td>$imagePath</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td>array</td> |
| <td>$coordinates</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><abbr title="FFMpeg\Filters\Video\$this">$this</abbr></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div id="footer"> |
| Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>. |
| </div> |
| </body> |
| </html> |
| /vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/Filters/Video/WatermarkFilter.html |
|---|
| @@ -0,0 +1,186 @@ |
|---|
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="robots" content="index, follow, all" /> |
| <title>FFMpeg\Filters\Video\WatermarkFilter | PHP-FFMpeg API</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css"> |
| </head> |
| <body id="class"> |
| <div class="header"> |
| <ul> |
| <li><a href="../../../classes.html">Classes</a></li> |
| <li><a href="../../../namespaces.html">Namespaces</a></li> |
| <li><a href="../../../interfaces.html">Interfaces</a></li> |
| <li><a href="../../../traits.html">Traits</a></li> |
| <li><a href="../../../doc-index.html">Index</a></li> |
| |
| </ul> |
| |
| <div id="title">PHP-FFMpeg API</div> |
| |
| <div class="type">Class</div> |
| <h1><a href="../../../FFMpeg/Filters/Video.html">FFMpeg\Filters\Video</a>\WatermarkFilter</h1> |
| </div> |
| <div class="content"> |
| <p> class |
| <strong>WatermarkFilter</strong> implements |
| <a href="../../../FFMpeg/Filters/Video/VideoFilterInterface.html"><abbr title="FFMpeg\Filters\Video\VideoFilterInterface">VideoFilterInterface</abbr></a></p> |
| |
| |
| |
| |
| <h2>Methods</h2> |
| |
| <table> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method___construct">__construct</a>($watermarkPath, array $coordinates = array(), $priority) |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getPriority">getPriority</a>() |
| <p>Returns the priority of the filter.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_apply">apply</a>(<a href="../../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a> $video, <a href="../../../FFMpeg/Format/VideoInterface.html"><abbr title="FFMpeg\Format\VideoInterface">VideoInterface</abbr></a> $format) |
| <p>Applies the filter on the the Video media given an format.</p> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| <h2>Details</h2> |
| |
| <h3 id="method___construct"> |
| <div class="location">at line 26</div> |
| <code> public |
| <strong>__construct</strong>($watermarkPath, array $coordinates = array(), $priority)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td></td> |
| <td>$watermarkPath</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td>array</td> |
| <td>$coordinates</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$priority</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getPriority"> |
| <div class="location">at line 36</div> |
| <code> public integer |
| <strong>getPriority</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the priority of the filter.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_apply"> |
| <div class="location">at line 44</div> |
| <code> public array |
| <strong>apply</strong>(<a href="../../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a> $video, <a href="../../../FFMpeg/Format/VideoInterface.html"><abbr title="FFMpeg\Format\VideoInterface">VideoInterface</abbr></a> $format)</code> |
| </h3> |
| <div class="details"> |
| <p>Applies the filter on the the Video media given an format.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a></td> |
| <td>$video</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../../../FFMpeg/Format/VideoInterface.html"><abbr title="FFMpeg\Format\VideoInterface">VideoInterface</abbr></a></td> |
| <td>$format</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td>An array of arguments</td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div id="footer"> |
| Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>. |
| </div> |
| </body> |
| </html> |
| /vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/Format/Audio/Aac.html |
|---|
| @@ -0,0 +1,498 @@ |
|---|
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="robots" content="index, follow, all" /> |
| <title>FFMpeg\Format\Audio\Aac | PHP-FFMpeg API</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css"> |
| </head> |
| <body id="class"> |
| <div class="header"> |
| <ul> |
| <li><a href="../../../classes.html">Classes</a></li> |
| <li><a href="../../../namespaces.html">Namespaces</a></li> |
| <li><a href="../../../interfaces.html">Interfaces</a></li> |
| <li><a href="../../../traits.html">Traits</a></li> |
| <li><a href="../../../doc-index.html">Index</a></li> |
| |
| </ul> |
| |
| <div id="title">PHP-FFMpeg API</div> |
| |
| <div class="type">Class</div> |
| <h1><a href="../../../FFMpeg/Format/Audio.html">FFMpeg\Format\Audio</a>\Aac</h1> |
| </div> |
| <div class="content"> |
| <p> class |
| <strong>Aac</strong> extends <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></p> |
| |
| <div class="description"> |
| <p>The AAC audio format</p> |
| <p> |
| </p> |
| </div> |
| |
| |
| |
| <h2>Methods</h2> |
| |
| <table> |
| <tr> |
| <td class="type"> |
| <abbr title="FFMpeg\Format\array()">array()</abbr> |
| </td> |
| <td class="last"> |
| <a href="#method_getExtraParams">getExtraParams</a>() |
| <p>Returns an array of extra parameters to add to ffmpeg commandline.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getExtraParams"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioCodec">getAudioCodec</a>() |
| <p>Returns the audio codec.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setAudioCodec">setAudioCodec</a>(string $audioCodec) |
| <p>Sets the audio codec, Should be in the available ones, otherwise an exception is thrown.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioKiloBitrate">getAudioKiloBitrate</a>() |
| <p>Gets the audio kiloBitrate value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setAudioKiloBitrate">setAudioKiloBitrate</a>(integer $kiloBitrate) |
| <p>Sets the kiloBitrate value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioChannels">getAudioChannels</a>() |
| <p>Gets the audio channels value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setAudioChannels">setAudioChannels</a>(integer $channels) |
| <p>Sets the channels value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_createProgressListener">createProgressListener</a>(<a href="../../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> $media, <a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe, Integer $pass, Integer $total) |
| <p>Creates the progress listener.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_createProgressListener"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getPasses">getPasses</a>() |
| <p>Returns the number of passes.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getPasses"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method___construct">__construct</a>() |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_getAvailableAudioCodecs">getAvailableAudioCodecs</a>() |
| <p>Returns the list of available audio codecs for this format.</p> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| <h2>Details</h2> |
| |
| <h3 id="method_getExtraParams"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getExtraParams"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 36</div> |
| <code> public <abbr title="FFMpeg\Format\array()">array()</abbr> |
| <strong>getExtraParams</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns an array of extra parameters to add to ffmpeg commandline.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><abbr title="FFMpeg\Format\array()">array()</abbr></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioCodec"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 44</div> |
| <code> public string |
| <strong>getAudioCodec</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the audio codec.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setAudioCodec"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 57</div> |
| <code> public |
| <strong>setAudioCodec</strong>(string $audioCodec)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the audio codec, Should be in the available ones, otherwise an exception is thrown.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td>$audioCodec</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioKiloBitrate"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 74</div> |
| <code> public integer |
| <strong>getAudioKiloBitrate</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Gets the audio kiloBitrate value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setAudioKiloBitrate"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 85</div> |
| <code> public |
| <strong>setAudioKiloBitrate</strong>(integer $kiloBitrate)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the kiloBitrate value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td>$kiloBitrate</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioChannels"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 99</div> |
| <code> public integer |
| <strong>getAudioChannels</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Gets the audio channels value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setAudioChannels"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 110</div> |
| <code> public |
| <strong>setAudioChannels</strong>(integer $channels)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the channels value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td>$channels</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_createProgressListener"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_createProgressListener"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 124</div> |
| <code> public array |
| <strong>createProgressListener</strong>(<a href="../../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> $media, <a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe, Integer $pass, Integer $total)</code> |
| </h3> |
| <div class="details"> |
| <p>Creates the progress listener.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td> |
| <td>$media</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td>$ffprobe</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td>Integer</td> |
| <td>$pass</td> |
| <td>The current pas snumber</td> |
| </tr> |
| <tr> |
| <td>Integer</td> |
| <td>$total</td> |
| <td>The total pass number</td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td>An array of listeners</td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getPasses"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getPasses"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 138</div> |
| <code> public string |
| <strong>getPasses</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the number of passes.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method___construct"> |
| <div class="location">at line 19</div> |
| <code> public |
| <strong>__construct</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAvailableAudioCodecs"> |
| <div class="location">at line 27</div> |
| <code> public array |
| <strong>getAvailableAudioCodecs</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the list of available audio codecs for this format.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div id="footer"> |
| Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>. |
| </div> |
| </body> |
| </html> |
| /vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/Format/Audio/DefaultAudio.html |
|---|
| @@ -0,0 +1,430 @@ |
|---|
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="robots" content="index, follow, all" /> |
| <title>FFMpeg\Format\Audio\DefaultAudio | PHP-FFMpeg API</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css"> |
| </head> |
| <body id="class"> |
| <div class="header"> |
| <ul> |
| <li><a href="../../../classes.html">Classes</a></li> |
| <li><a href="../../../namespaces.html">Namespaces</a></li> |
| <li><a href="../../../interfaces.html">Interfaces</a></li> |
| <li><a href="../../../traits.html">Traits</a></li> |
| <li><a href="../../../doc-index.html">Index</a></li> |
| |
| </ul> |
| |
| <div id="title">PHP-FFMpeg API</div> |
| |
| <div class="type">Class</div> |
| <h1><a href="../../../FFMpeg/Format/Audio.html">FFMpeg\Format\Audio</a>\DefaultAudio</h1> |
| </div> |
| <div class="content"> |
| <p>abstract class |
| <strong>DefaultAudio</strong> extends <abbr title="Evenement\EventEmitter">EventEmitter</abbr> implements |
| <a href="../../../FFMpeg/Format/AudioInterface.html"><abbr title="FFMpeg\Format\AudioInterface">AudioInterface</abbr></a>, <a href="../../../FFMpeg/Format/ProgressableInterface.html"><abbr title="FFMpeg\Format\ProgressableInterface">ProgressableInterface</abbr></a></p> |
| |
| |
| |
| |
| <h2>Methods</h2> |
| |
| <table> |
| <tr> |
| <td class="type"> |
| <abbr title="FFMpeg\Format\array()">array()</abbr> |
| </td> |
| <td class="last"> |
| <a href="#method_getExtraParams">getExtraParams</a>() |
| <p>Returns an array of extra parameters to add to ffmpeg commandline.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioCodec">getAudioCodec</a>() |
| <p>Returns the audio codec.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setAudioCodec">setAudioCodec</a>(string $audioCodec) |
| <p>Sets the audio codec, Should be in the available ones, otherwise an exception is thrown.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioKiloBitrate">getAudioKiloBitrate</a>() |
| <p>Gets the audio kiloBitrate value.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setAudioKiloBitrate">setAudioKiloBitrate</a>(integer $kiloBitrate) |
| <p>Sets the kiloBitrate value.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioChannels">getAudioChannels</a>() |
| <p>Gets the audio channels value.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setAudioChannels">setAudioChannels</a>(integer $channels) |
| <p>Sets the channels value.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_createProgressListener">createProgressListener</a>(<a href="../../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> $media, <a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe, Integer $pass, Integer $total) |
| <p>Creates the progress listener.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getPasses">getPasses</a>() |
| <p>Returns the number of passes.</p> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| <h2>Details</h2> |
| |
| <h3 id="method_getExtraParams"> |
| <div class="location">at line 36</div> |
| <code> public <abbr title="FFMpeg\Format\array()">array()</abbr> |
| <strong>getExtraParams</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns an array of extra parameters to add to ffmpeg commandline.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><abbr title="FFMpeg\Format\array()">array()</abbr></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioCodec"> |
| <div class="location">at line 44</div> |
| <code> public string |
| <strong>getAudioCodec</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the audio codec.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setAudioCodec"> |
| <div class="location">at line 57</div> |
| <code> public |
| <strong>setAudioCodec</strong>(string $audioCodec)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the audio codec, Should be in the available ones, otherwise an exception is thrown.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td>$audioCodec</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioKiloBitrate"> |
| <div class="location">at line 74</div> |
| <code> public integer |
| <strong>getAudioKiloBitrate</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Gets the audio kiloBitrate value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setAudioKiloBitrate"> |
| <div class="location">at line 85</div> |
| <code> public |
| <strong>setAudioKiloBitrate</strong>(integer $kiloBitrate)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the kiloBitrate value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td>$kiloBitrate</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioChannels"> |
| <div class="location">at line 99</div> |
| <code> public integer |
| <strong>getAudioChannels</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Gets the audio channels value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setAudioChannels"> |
| <div class="location">at line 110</div> |
| <code> public |
| <strong>setAudioChannels</strong>(integer $channels)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the channels value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td>$channels</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_createProgressListener"> |
| <div class="location">at line 124</div> |
| <code> public array |
| <strong>createProgressListener</strong>(<a href="../../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> $media, <a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe, Integer $pass, Integer $total)</code> |
| </h3> |
| <div class="details"> |
| <p>Creates the progress listener.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td> |
| <td>$media</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td>$ffprobe</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td>Integer</td> |
| <td>$pass</td> |
| <td>The current pas snumber</td> |
| </tr> |
| <tr> |
| <td>Integer</td> |
| <td>$total</td> |
| <td>The total pass number</td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td>An array of listeners</td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getPasses"> |
| <div class="location">at line 138</div> |
| <code> public string |
| <strong>getPasses</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the number of passes.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div id="footer"> |
| Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>. |
| </div> |
| </body> |
| </html> |
| /vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/Format/Audio/Flac.html |
|---|
| @@ -0,0 +1,498 @@ |
|---|
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="robots" content="index, follow, all" /> |
| <title>FFMpeg\Format\Audio\Flac | PHP-FFMpeg API</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css"> |
| </head> |
| <body id="class"> |
| <div class="header"> |
| <ul> |
| <li><a href="../../../classes.html">Classes</a></li> |
| <li><a href="../../../namespaces.html">Namespaces</a></li> |
| <li><a href="../../../interfaces.html">Interfaces</a></li> |
| <li><a href="../../../traits.html">Traits</a></li> |
| <li><a href="../../../doc-index.html">Index</a></li> |
| |
| </ul> |
| |
| <div id="title">PHP-FFMpeg API</div> |
| |
| <div class="type">Class</div> |
| <h1><a href="../../../FFMpeg/Format/Audio.html">FFMpeg\Format\Audio</a>\Flac</h1> |
| </div> |
| <div class="content"> |
| <p> class |
| <strong>Flac</strong> extends <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></p> |
| |
| <div class="description"> |
| <p>The Flac audio format</p> |
| <p> |
| </p> |
| </div> |
| |
| |
| |
| <h2>Methods</h2> |
| |
| <table> |
| <tr> |
| <td class="type"> |
| <abbr title="FFMpeg\Format\array()">array()</abbr> |
| </td> |
| <td class="last"> |
| <a href="#method_getExtraParams">getExtraParams</a>() |
| <p>Returns an array of extra parameters to add to ffmpeg commandline.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getExtraParams"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioCodec">getAudioCodec</a>() |
| <p>Returns the audio codec.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setAudioCodec">setAudioCodec</a>(string $audioCodec) |
| <p>Sets the audio codec, Should be in the available ones, otherwise an exception is thrown.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioKiloBitrate">getAudioKiloBitrate</a>() |
| <p>Gets the audio kiloBitrate value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setAudioKiloBitrate">setAudioKiloBitrate</a>(integer $kiloBitrate) |
| <p>Sets the kiloBitrate value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioChannels">getAudioChannels</a>() |
| <p>Gets the audio channels value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setAudioChannels">setAudioChannels</a>(integer $channels) |
| <p>Sets the channels value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_createProgressListener">createProgressListener</a>(<a href="../../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> $media, <a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe, Integer $pass, Integer $total) |
| <p>Creates the progress listener.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_createProgressListener"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getPasses">getPasses</a>() |
| <p>Returns the number of passes.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getPasses"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method___construct">__construct</a>() |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_getAvailableAudioCodecs">getAvailableAudioCodecs</a>() |
| <p>Returns the list of available audio codecs for this format.</p> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| <h2>Details</h2> |
| |
| <h3 id="method_getExtraParams"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getExtraParams"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 36</div> |
| <code> public <abbr title="FFMpeg\Format\array()">array()</abbr> |
| <strong>getExtraParams</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns an array of extra parameters to add to ffmpeg commandline.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><abbr title="FFMpeg\Format\array()">array()</abbr></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioCodec"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 44</div> |
| <code> public string |
| <strong>getAudioCodec</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the audio codec.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setAudioCodec"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 57</div> |
| <code> public |
| <strong>setAudioCodec</strong>(string $audioCodec)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the audio codec, Should be in the available ones, otherwise an exception is thrown.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td>$audioCodec</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioKiloBitrate"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 74</div> |
| <code> public integer |
| <strong>getAudioKiloBitrate</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Gets the audio kiloBitrate value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setAudioKiloBitrate"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 85</div> |
| <code> public |
| <strong>setAudioKiloBitrate</strong>(integer $kiloBitrate)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the kiloBitrate value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td>$kiloBitrate</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioChannels"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 99</div> |
| <code> public integer |
| <strong>getAudioChannels</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Gets the audio channels value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setAudioChannels"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 110</div> |
| <code> public |
| <strong>setAudioChannels</strong>(integer $channels)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the channels value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td>$channels</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_createProgressListener"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_createProgressListener"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 124</div> |
| <code> public array |
| <strong>createProgressListener</strong>(<a href="../../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> $media, <a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe, Integer $pass, Integer $total)</code> |
| </h3> |
| <div class="details"> |
| <p>Creates the progress listener.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td> |
| <td>$media</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td>$ffprobe</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td>Integer</td> |
| <td>$pass</td> |
| <td>The current pas snumber</td> |
| </tr> |
| <tr> |
| <td>Integer</td> |
| <td>$total</td> |
| <td>The total pass number</td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td>An array of listeners</td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getPasses"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getPasses"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 138</div> |
| <code> public string |
| <strong>getPasses</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the number of passes.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method___construct"> |
| <div class="location">at line 19</div> |
| <code> public |
| <strong>__construct</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAvailableAudioCodecs"> |
| <div class="location">at line 27</div> |
| <code> public array |
| <strong>getAvailableAudioCodecs</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the list of available audio codecs for this format.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div id="footer"> |
| Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>. |
| </div> |
| </body> |
| </html> |
| /vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/Format/Audio/Mp3.html |
|---|
| @@ -0,0 +1,498 @@ |
|---|
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="robots" content="index, follow, all" /> |
| <title>FFMpeg\Format\Audio\Mp3 | PHP-FFMpeg API</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css"> |
| </head> |
| <body id="class"> |
| <div class="header"> |
| <ul> |
| <li><a href="../../../classes.html">Classes</a></li> |
| <li><a href="../../../namespaces.html">Namespaces</a></li> |
| <li><a href="../../../interfaces.html">Interfaces</a></li> |
| <li><a href="../../../traits.html">Traits</a></li> |
| <li><a href="../../../doc-index.html">Index</a></li> |
| |
| </ul> |
| |
| <div id="title">PHP-FFMpeg API</div> |
| |
| <div class="type">Class</div> |
| <h1><a href="../../../FFMpeg/Format/Audio.html">FFMpeg\Format\Audio</a>\Mp3</h1> |
| </div> |
| <div class="content"> |
| <p> class |
| <strong>Mp3</strong> extends <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></p> |
| |
| <div class="description"> |
| <p>The MP3 audio format</p> |
| <p> |
| </p> |
| </div> |
| |
| |
| |
| <h2>Methods</h2> |
| |
| <table> |
| <tr> |
| <td class="type"> |
| <abbr title="FFMpeg\Format\array()">array()</abbr> |
| </td> |
| <td class="last"> |
| <a href="#method_getExtraParams">getExtraParams</a>() |
| <p>Returns an array of extra parameters to add to ffmpeg commandline.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getExtraParams"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioCodec">getAudioCodec</a>() |
| <p>Returns the audio codec.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setAudioCodec">setAudioCodec</a>(string $audioCodec) |
| <p>Sets the audio codec, Should be in the available ones, otherwise an exception is thrown.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioKiloBitrate">getAudioKiloBitrate</a>() |
| <p>Gets the audio kiloBitrate value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setAudioKiloBitrate">setAudioKiloBitrate</a>(integer $kiloBitrate) |
| <p>Sets the kiloBitrate value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioChannels">getAudioChannels</a>() |
| <p>Gets the audio channels value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setAudioChannels">setAudioChannels</a>(integer $channels) |
| <p>Sets the channels value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_createProgressListener">createProgressListener</a>(<a href="../../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> $media, <a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe, Integer $pass, Integer $total) |
| <p>Creates the progress listener.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_createProgressListener"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getPasses">getPasses</a>() |
| <p>Returns the number of passes.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getPasses"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method___construct">__construct</a>() |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_getAvailableAudioCodecs">getAvailableAudioCodecs</a>() |
| <p>Returns the list of available audio codecs for this format.</p> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| <h2>Details</h2> |
| |
| <h3 id="method_getExtraParams"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getExtraParams"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 36</div> |
| <code> public <abbr title="FFMpeg\Format\array()">array()</abbr> |
| <strong>getExtraParams</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns an array of extra parameters to add to ffmpeg commandline.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><abbr title="FFMpeg\Format\array()">array()</abbr></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioCodec"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 44</div> |
| <code> public string |
| <strong>getAudioCodec</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the audio codec.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setAudioCodec"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 57</div> |
| <code> public |
| <strong>setAudioCodec</strong>(string $audioCodec)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the audio codec, Should be in the available ones, otherwise an exception is thrown.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td>$audioCodec</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioKiloBitrate"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 74</div> |
| <code> public integer |
| <strong>getAudioKiloBitrate</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Gets the audio kiloBitrate value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setAudioKiloBitrate"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 85</div> |
| <code> public |
| <strong>setAudioKiloBitrate</strong>(integer $kiloBitrate)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the kiloBitrate value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td>$kiloBitrate</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioChannels"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 99</div> |
| <code> public integer |
| <strong>getAudioChannels</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Gets the audio channels value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setAudioChannels"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 110</div> |
| <code> public |
| <strong>setAudioChannels</strong>(integer $channels)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the channels value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td>$channels</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_createProgressListener"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_createProgressListener"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 124</div> |
| <code> public array |
| <strong>createProgressListener</strong>(<a href="../../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> $media, <a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe, Integer $pass, Integer $total)</code> |
| </h3> |
| <div class="details"> |
| <p>Creates the progress listener.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td> |
| <td>$media</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td>$ffprobe</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td>Integer</td> |
| <td>$pass</td> |
| <td>The current pas snumber</td> |
| </tr> |
| <tr> |
| <td>Integer</td> |
| <td>$total</td> |
| <td>The total pass number</td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td>An array of listeners</td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getPasses"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getPasses"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 138</div> |
| <code> public string |
| <strong>getPasses</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the number of passes.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method___construct"> |
| <div class="location">at line 19</div> |
| <code> public |
| <strong>__construct</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAvailableAudioCodecs"> |
| <div class="location">at line 27</div> |
| <code> public array |
| <strong>getAvailableAudioCodecs</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the list of available audio codecs for this format.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div id="footer"> |
| Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>. |
| </div> |
| </body> |
| </html> |
| /vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/Format/Audio/Vorbis.html |
|---|
| @@ -0,0 +1,498 @@ |
|---|
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="robots" content="index, follow, all" /> |
| <title>FFMpeg\Format\Audio\Vorbis | PHP-FFMpeg API</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css"> |
| </head> |
| <body id="class"> |
| <div class="header"> |
| <ul> |
| <li><a href="../../../classes.html">Classes</a></li> |
| <li><a href="../../../namespaces.html">Namespaces</a></li> |
| <li><a href="../../../interfaces.html">Interfaces</a></li> |
| <li><a href="../../../traits.html">Traits</a></li> |
| <li><a href="../../../doc-index.html">Index</a></li> |
| |
| </ul> |
| |
| <div id="title">PHP-FFMpeg API</div> |
| |
| <div class="type">Class</div> |
| <h1><a href="../../../FFMpeg/Format/Audio.html">FFMpeg\Format\Audio</a>\Vorbis</h1> |
| </div> |
| <div class="content"> |
| <p> class |
| <strong>Vorbis</strong> extends <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></p> |
| |
| <div class="description"> |
| <p>The Vorbis audio format</p> |
| <p> |
| </p> |
| </div> |
| |
| |
| |
| <h2>Methods</h2> |
| |
| <table> |
| <tr> |
| <td class="type"> |
| <abbr title="FFMpeg\Format\array()">array()</abbr> |
| </td> |
| <td class="last"> |
| <a href="#method_getExtraParams">getExtraParams</a>() |
| <p>Returns an array of extra parameters to add to ffmpeg commandline.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioCodec">getAudioCodec</a>() |
| <p>Returns the audio codec.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setAudioCodec">setAudioCodec</a>(string $audioCodec) |
| <p>Sets the audio codec, Should be in the available ones, otherwise an exception is thrown.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioKiloBitrate">getAudioKiloBitrate</a>() |
| <p>Gets the audio kiloBitrate value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setAudioKiloBitrate">setAudioKiloBitrate</a>(integer $kiloBitrate) |
| <p>Sets the kiloBitrate value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioChannels">getAudioChannels</a>() |
| <p>Gets the audio channels value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setAudioChannels">setAudioChannels</a>(integer $channels) |
| <p>Sets the channels value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_createProgressListener">createProgressListener</a>(<a href="../../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> $media, <a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe, Integer $pass, Integer $total) |
| <p>Creates the progress listener.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_createProgressListener"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getPasses">getPasses</a>() |
| <p>Returns the number of passes.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getPasses"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method___construct">__construct</a>() |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_getAvailableAudioCodecs">getAvailableAudioCodecs</a>() |
| <p>Returns the list of available audio codecs for this format.</p> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| <h2>Details</h2> |
| |
| <h3 id="method_getExtraParams"> |
| <div class="location">at line 27</div> |
| <code> public <abbr title="FFMpeg\Format\array()">array()</abbr> |
| <strong>getExtraParams</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns an array of extra parameters to add to ffmpeg commandline.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><abbr title="FFMpeg\Format\array()">array()</abbr></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioCodec"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 44</div> |
| <code> public string |
| <strong>getAudioCodec</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the audio codec.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setAudioCodec"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 57</div> |
| <code> public |
| <strong>setAudioCodec</strong>(string $audioCodec)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the audio codec, Should be in the available ones, otherwise an exception is thrown.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td>$audioCodec</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioKiloBitrate"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 74</div> |
| <code> public integer |
| <strong>getAudioKiloBitrate</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Gets the audio kiloBitrate value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setAudioKiloBitrate"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 85</div> |
| <code> public |
| <strong>setAudioKiloBitrate</strong>(integer $kiloBitrate)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the kiloBitrate value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td>$kiloBitrate</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioChannels"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 99</div> |
| <code> public integer |
| <strong>getAudioChannels</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Gets the audio channels value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setAudioChannels"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 110</div> |
| <code> public |
| <strong>setAudioChannels</strong>(integer $channels)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the channels value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td>$channels</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_createProgressListener"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_createProgressListener"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 124</div> |
| <code> public array |
| <strong>createProgressListener</strong>(<a href="../../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> $media, <a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe, Integer $pass, Integer $total)</code> |
| </h3> |
| <div class="details"> |
| <p>Creates the progress listener.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td> |
| <td>$media</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td>$ffprobe</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td>Integer</td> |
| <td>$pass</td> |
| <td>The current pas snumber</td> |
| </tr> |
| <tr> |
| <td>Integer</td> |
| <td>$total</td> |
| <td>The total pass number</td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td>An array of listeners</td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getPasses"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getPasses"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 138</div> |
| <code> public string |
| <strong>getPasses</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the number of passes.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method___construct"> |
| <div class="location">at line 19</div> |
| <code> public |
| <strong>__construct</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAvailableAudioCodecs"> |
| <div class="location">at line 35</div> |
| <code> public array |
| <strong>getAvailableAudioCodecs</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the list of available audio codecs for this format.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div id="footer"> |
| Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>. |
| </div> |
| </body> |
| </html> |
| /vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/Format/Audio/Wav.html |
|---|
| @@ -0,0 +1,498 @@ |
|---|
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="robots" content="index, follow, all" /> |
| <title>FFMpeg\Format\Audio\Wav | PHP-FFMpeg API</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css"> |
| </head> |
| <body id="class"> |
| <div class="header"> |
| <ul> |
| <li><a href="../../../classes.html">Classes</a></li> |
| <li><a href="../../../namespaces.html">Namespaces</a></li> |
| <li><a href="../../../interfaces.html">Interfaces</a></li> |
| <li><a href="../../../traits.html">Traits</a></li> |
| <li><a href="../../../doc-index.html">Index</a></li> |
| |
| </ul> |
| |
| <div id="title">PHP-FFMpeg API</div> |
| |
| <div class="type">Class</div> |
| <h1><a href="../../../FFMpeg/Format/Audio.html">FFMpeg\Format\Audio</a>\Wav</h1> |
| </div> |
| <div class="content"> |
| <p> class |
| <strong>Wav</strong> extends <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></p> |
| |
| <div class="description"> |
| <p>The WAV audio format</p> |
| <p> |
| </p> |
| </div> |
| |
| |
| |
| <h2>Methods</h2> |
| |
| <table> |
| <tr> |
| <td class="type"> |
| <abbr title="FFMpeg\Format\array()">array()</abbr> |
| </td> |
| <td class="last"> |
| <a href="#method_getExtraParams">getExtraParams</a>() |
| <p>Returns an array of extra parameters to add to ffmpeg commandline.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getExtraParams"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioCodec">getAudioCodec</a>() |
| <p>Returns the audio codec.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setAudioCodec">setAudioCodec</a>(string $audioCodec) |
| <p>Sets the audio codec, Should be in the available ones, otherwise an exception is thrown.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioKiloBitrate">getAudioKiloBitrate</a>() |
| <p>Gets the audio kiloBitrate value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setAudioKiloBitrate">setAudioKiloBitrate</a>(integer $kiloBitrate) |
| <p>Sets the kiloBitrate value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioChannels">getAudioChannels</a>() |
| <p>Gets the audio channels value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setAudioChannels">setAudioChannels</a>(integer $channels) |
| <p>Sets the channels value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_createProgressListener">createProgressListener</a>(<a href="../../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> $media, <a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe, Integer $pass, Integer $total) |
| <p>Creates the progress listener.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_createProgressListener"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getPasses">getPasses</a>() |
| <p>Returns the number of passes.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getPasses"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method___construct">__construct</a>() |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_getAvailableAudioCodecs">getAvailableAudioCodecs</a>() |
| <p>Returns the list of available audio codecs for this format.</p> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| <h2>Details</h2> |
| |
| <h3 id="method_getExtraParams"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getExtraParams"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 36</div> |
| <code> public <abbr title="FFMpeg\Format\array()">array()</abbr> |
| <strong>getExtraParams</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns an array of extra parameters to add to ffmpeg commandline.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><abbr title="FFMpeg\Format\array()">array()</abbr></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioCodec"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 44</div> |
| <code> public string |
| <strong>getAudioCodec</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the audio codec.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setAudioCodec"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 57</div> |
| <code> public |
| <strong>setAudioCodec</strong>(string $audioCodec)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the audio codec, Should be in the available ones, otherwise an exception is thrown.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td>$audioCodec</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioKiloBitrate"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 74</div> |
| <code> public integer |
| <strong>getAudioKiloBitrate</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Gets the audio kiloBitrate value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setAudioKiloBitrate"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 85</div> |
| <code> public |
| <strong>setAudioKiloBitrate</strong>(integer $kiloBitrate)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the kiloBitrate value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td>$kiloBitrate</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioChannels"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 99</div> |
| <code> public integer |
| <strong>getAudioChannels</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Gets the audio channels value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setAudioChannels"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 110</div> |
| <code> public |
| <strong>setAudioChannels</strong>(integer $channels)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the channels value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td>$channels</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_createProgressListener"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_createProgressListener"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 124</div> |
| <code> public array |
| <strong>createProgressListener</strong>(<a href="../../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> $media, <a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe, Integer $pass, Integer $total)</code> |
| </h3> |
| <div class="details"> |
| <p>Creates the progress listener.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td> |
| <td>$media</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td>$ffprobe</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td>Integer</td> |
| <td>$pass</td> |
| <td>The current pas snumber</td> |
| </tr> |
| <tr> |
| <td>Integer</td> |
| <td>$total</td> |
| <td>The total pass number</td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td>An array of listeners</td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getPasses"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getPasses"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 138</div> |
| <code> public string |
| <strong>getPasses</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the number of passes.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method___construct"> |
| <div class="location">at line 19</div> |
| <code> public |
| <strong>__construct</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAvailableAudioCodecs"> |
| <div class="location">at line 27</div> |
| <code> public array |
| <strong>getAvailableAudioCodecs</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the list of available audio codecs for this format.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div id="footer"> |
| Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>. |
| </div> |
| </body> |
| </html> |
| /vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/Format/AudioInterface.html |
|---|
| @@ -0,0 +1,263 @@ |
|---|
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="robots" content="index, follow, all" /> |
| <title>FFMpeg\Format\AudioInterface | PHP-FFMpeg API</title> |
| <link rel="stylesheet" type="text/css" href="../../stylesheet.css"> |
| </head> |
| <body id="class"> |
| <div class="header"> |
| <ul> |
| <li><a href="../../classes.html">Classes</a></li> |
| <li><a href="../../namespaces.html">Namespaces</a></li> |
| <li><a href="../../interfaces.html">Interfaces</a></li> |
| <li><a href="../../traits.html">Traits</a></li> |
| <li><a href="../../doc-index.html">Index</a></li> |
| |
| </ul> |
| |
| <div id="title">PHP-FFMpeg API</div> |
| |
| <div class="type">Interface</div> |
| <h1><a href="../../FFMpeg/Format.html">FFMpeg\Format</a>\AudioInterface</h1> |
| </div> |
| <div class="content"> |
| <p> interface |
| <strong>AudioInterface</strong> implements |
| <a href="../../FFMpeg/Format/FormatInterface.html"><abbr title="FFMpeg\Format\FormatInterface">FormatInterface</abbr></a></p> |
| |
| |
| |
| |
| <h2>Methods</h2> |
| |
| <table> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getPasses">getPasses</a>() |
| <p>Returns the number of passes.</p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Format/FormatInterface.html#method_getPasses"><abbr title="FFMpeg\Format\FormatInterface">FormatInterface</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <abbr title="FFMpeg\Format\array()">array()</abbr> |
| </td> |
| <td class="last"> |
| <a href="#method_getExtraParams">getExtraParams</a>() |
| <p>Returns an array of extra parameters to add to ffmpeg commandline.</p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Format/FormatInterface.html#method_getExtraParams"><abbr title="FFMpeg\Format\FormatInterface">FormatInterface</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioKiloBitrate">getAudioKiloBitrate</a>() |
| <p>Gets the audio kiloBitrate value.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioChannels">getAudioChannels</a>() |
| <p>Gets the audio channels value.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioCodec">getAudioCodec</a>() |
| <p>Returns the audio codec.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_getAvailableAudioCodecs">getAvailableAudioCodecs</a>() |
| <p>Returns the list of available audio codecs for this format.</p> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| <h2>Details</h2> |
| |
| <h3 id="method_getPasses"> |
| <div class="location">in <a href="../../FFMpeg/Format/FormatInterface.html#method_getPasses"><abbr title="FFMpeg\Format\FormatInterface">FormatInterface</abbr></a> at line 20</div> |
| <code> public string |
| <strong>getPasses</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the number of passes.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getExtraParams"> |
| <div class="location">in <a href="../../FFMpeg/Format/FormatInterface.html#method_getExtraParams"><abbr title="FFMpeg\Format\FormatInterface">FormatInterface</abbr></a> at line 27</div> |
| <code> public <abbr title="FFMpeg\Format\array()">array()</abbr> |
| <strong>getExtraParams</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns an array of extra parameters to add to ffmpeg commandline.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><abbr title="FFMpeg\Format\array()">array()</abbr></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioKiloBitrate"> |
| <div class="location">at line 20</div> |
| <code> public integer |
| <strong>getAudioKiloBitrate</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Gets the audio kiloBitrate value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioChannels"> |
| <div class="location">at line 27</div> |
| <code> public integer |
| <strong>getAudioChannels</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Gets the audio channels value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioCodec"> |
| <div class="location">at line 34</div> |
| <code> public string |
| <strong>getAudioCodec</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the audio codec.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAvailableAudioCodecs"> |
| <div class="location">at line 41</div> |
| <code> public array |
| <strong>getAvailableAudioCodecs</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the list of available audio codecs for this format.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div id="footer"> |
| Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>. |
| </div> |
| </body> |
| </html> |
| /vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/Format/ProgressListener/AbstractProgressListener.html |
|---|
| @@ -0,0 +1,333 @@ |
|---|
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="robots" content="index, follow, all" /> |
| <title>FFMpeg\Format\ProgressListener\AbstractProgressListener | PHP-FFMpeg API</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css"> |
| </head> |
| <body id="class"> |
| <div class="header"> |
| <ul> |
| <li><a href="../../../classes.html">Classes</a></li> |
| <li><a href="../../../namespaces.html">Namespaces</a></li> |
| <li><a href="../../../interfaces.html">Interfaces</a></li> |
| <li><a href="../../../traits.html">Traits</a></li> |
| <li><a href="../../../doc-index.html">Index</a></li> |
| |
| </ul> |
| |
| <div id="title">PHP-FFMpeg API</div> |
| |
| <div class="type">Class</div> |
| <h1><a href="../../../FFMpeg/Format/ProgressListener.html">FFMpeg\Format\ProgressListener</a>\AbstractProgressListener</h1> |
| </div> |
| <div class="content"> |
| <p>abstract class |
| <strong>AbstractProgressListener</strong> extends <abbr title="Evenement\EventEmitter">EventEmitter</abbr> implements |
| <abbr title="Alchemy\BinaryDriver\Listeners\ListenerInterface">ListenerInterface</abbr></p> |
| |
| |
| |
| |
| <h2>Methods</h2> |
| |
| <table> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method___construct">__construct</a>(<a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe, string $pathfile, integer $currentPass, integer $totalPass) |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getFFProbe">getFFProbe</a>() |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getPathfile">getPathfile</a>() |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getCurrentPass">getCurrentPass</a>() |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getTotalPass">getTotalPass</a>() |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_handle">handle</a>($type, $data) |
| <p>{@inheritdoc}</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_forwardedEvents">forwardedEvents</a>() |
| <p>{@inheritdoc}</p> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| <h2>Details</h2> |
| |
| <h3 id="method___construct"> |
| <div class="location">at line 83</div> |
| <code> public |
| <strong>__construct</strong>(<a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe, string $pathfile, integer $currentPass, integer $totalPass)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td>$ffprobe</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td>string</td> |
| <td>$pathfile</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td>integer</td> |
| <td>$currentPass</td> |
| <td>The cureent pass number</td> |
| </tr> |
| <tr> |
| <td>integer</td> |
| <td>$totalPass</td> |
| <td>The total number of passes</td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/RuntimeException"><abbr title="RuntimeException">RuntimeException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getFFProbe"> |
| <div class="location">at line 94</div> |
| <code> public <a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> |
| <strong>getFFProbe</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getPathfile"> |
| <div class="location">at line 102</div> |
| <code> public string |
| <strong>getPathfile</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getCurrentPass"> |
| <div class="location">at line 110</div> |
| <code> public integer |
| <strong>getCurrentPass</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getTotalPass"> |
| <div class="location">at line 118</div> |
| <code> public integer |
| <strong>getTotalPass</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_handle"> |
| <div class="location">at line 126</div> |
| <code> public |
| <strong>handle</strong>($type, $data)</code> |
| </h3> |
| <div class="details"> |
| <p>{@inheritdoc}</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td></td> |
| <td>$type</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$data</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_forwardedEvents"> |
| <div class="location">at line 136</div> |
| <code> public |
| <strong>forwardedEvents</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>{@inheritdoc}</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div id="footer"> |
| Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>. |
| </div> |
| </body> |
| </html> |
| /vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/Format/ProgressListener/AudioProgressListener.html |
|---|
| @@ -0,0 +1,369 @@ |
|---|
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="robots" content="index, follow, all" /> |
| <title>FFMpeg\Format\ProgressListener\AudioProgressListener | PHP-FFMpeg API</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css"> |
| </head> |
| <body id="class"> |
| <div class="header"> |
| <ul> |
| <li><a href="../../../classes.html">Classes</a></li> |
| <li><a href="../../../namespaces.html">Namespaces</a></li> |
| <li><a href="../../../interfaces.html">Interfaces</a></li> |
| <li><a href="../../../traits.html">Traits</a></li> |
| <li><a href="../../../doc-index.html">Index</a></li> |
| |
| </ul> |
| |
| <div id="title">PHP-FFMpeg API</div> |
| |
| <div class="type">Class</div> |
| <h1><a href="../../../FFMpeg/Format/ProgressListener.html">FFMpeg\Format\ProgressListener</a>\AudioProgressListener</h1> |
| </div> |
| <div class="content"> |
| <p> class |
| <strong>AudioProgressListener</strong> extends <a href="../../../FFMpeg/Format/ProgressListener/AbstractProgressListener.html"><abbr title="FFMpeg\Format\ProgressListener\AbstractProgressListener">AbstractProgressListener</abbr></a></p> |
| |
| <div class="description"> |
| <p>Parses ffmpeg stderr progress information.</p> |
| <p>An example:</p> |
| |
| <pre> |
| size= 3552kB time=00:03:47.29 bitrate= 128.0kbits/s |
| </pre> |
| </p> |
| </div> |
| |
| |
| |
| <h2>Methods</h2> |
| |
| <table> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method___construct">__construct</a>(<a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe, string $pathfile, integer $currentPass, integer $totalPass) |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/ProgressListener/AbstractProgressListener.html#method___construct"><abbr title="FFMpeg\Format\ProgressListener\AbstractProgressListener">AbstractProgressListener</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getFFProbe">getFFProbe</a>() |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/ProgressListener/AbstractProgressListener.html#method_getFFProbe"><abbr title="FFMpeg\Format\ProgressListener\AbstractProgressListener">AbstractProgressListener</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getPathfile">getPathfile</a>() |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/ProgressListener/AbstractProgressListener.html#method_getPathfile"><abbr title="FFMpeg\Format\ProgressListener\AbstractProgressListener">AbstractProgressListener</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getCurrentPass">getCurrentPass</a>() |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/ProgressListener/AbstractProgressListener.html#method_getCurrentPass"><abbr title="FFMpeg\Format\ProgressListener\AbstractProgressListener">AbstractProgressListener</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getTotalPass">getTotalPass</a>() |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/ProgressListener/AbstractProgressListener.html#method_getTotalPass"><abbr title="FFMpeg\Format\ProgressListener\AbstractProgressListener">AbstractProgressListener</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_handle">handle</a>($type, $data) |
| <p>{@inheritdoc}</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/ProgressListener/AbstractProgressListener.html#method_handle"><abbr title="FFMpeg\Format\ProgressListener\AbstractProgressListener">AbstractProgressListener</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_forwardedEvents">forwardedEvents</a>() |
| <p>{@inheritdoc}</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/ProgressListener/AbstractProgressListener.html#method_forwardedEvents"><abbr title="FFMpeg\Format\ProgressListener\AbstractProgressListener">AbstractProgressListener</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_getPattern">getPattern</a>() |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| <h2>Details</h2> |
| |
| <h3 id="method___construct"> |
| <div class="location">in <a href="../../../FFMpeg/Format/ProgressListener/AbstractProgressListener.html#method___construct"><abbr title="FFMpeg\Format\ProgressListener\AbstractProgressListener">AbstractProgressListener</abbr></a> at line 83</div> |
| <code> public |
| <strong>__construct</strong>(<a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe, string $pathfile, integer $currentPass, integer $totalPass)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td>$ffprobe</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td>string</td> |
| <td>$pathfile</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td>integer</td> |
| <td>$currentPass</td> |
| <td>The cureent pass number</td> |
| </tr> |
| <tr> |
| <td>integer</td> |
| <td>$totalPass</td> |
| <td>The total number of passes</td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/RuntimeException"><abbr title="RuntimeException">RuntimeException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getFFProbe"> |
| <div class="location">in <a href="../../../FFMpeg/Format/ProgressListener/AbstractProgressListener.html#method_getFFProbe"><abbr title="FFMpeg\Format\ProgressListener\AbstractProgressListener">AbstractProgressListener</abbr></a> at line 94</div> |
| <code> public <a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> |
| <strong>getFFProbe</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getPathfile"> |
| <div class="location">in <a href="../../../FFMpeg/Format/ProgressListener/AbstractProgressListener.html#method_getPathfile"><abbr title="FFMpeg\Format\ProgressListener\AbstractProgressListener">AbstractProgressListener</abbr></a> at line 102</div> |
| <code> public string |
| <strong>getPathfile</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getCurrentPass"> |
| <div class="location">in <a href="../../../FFMpeg/Format/ProgressListener/AbstractProgressListener.html#method_getCurrentPass"><abbr title="FFMpeg\Format\ProgressListener\AbstractProgressListener">AbstractProgressListener</abbr></a> at line 110</div> |
| <code> public integer |
| <strong>getCurrentPass</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getTotalPass"> |
| <div class="location">in <a href="../../../FFMpeg/Format/ProgressListener/AbstractProgressListener.html#method_getTotalPass"><abbr title="FFMpeg\Format\ProgressListener\AbstractProgressListener">AbstractProgressListener</abbr></a> at line 118</div> |
| <code> public integer |
| <strong>getTotalPass</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_handle"> |
| <div class="location">in <a href="../../../FFMpeg/Format/ProgressListener/AbstractProgressListener.html#method_handle"><abbr title="FFMpeg\Format\ProgressListener\AbstractProgressListener">AbstractProgressListener</abbr></a> at line 126</div> |
| <code> public |
| <strong>handle</strong>($type, $data)</code> |
| </h3> |
| <div class="details"> |
| <p>{@inheritdoc}</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td></td> |
| <td>$type</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$data</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_forwardedEvents"> |
| <div class="location">in <a href="../../../FFMpeg/Format/ProgressListener/AbstractProgressListener.html#method_forwardedEvents"><abbr title="FFMpeg\Format\ProgressListener\AbstractProgressListener">AbstractProgressListener</abbr></a> at line 136</div> |
| <code> public |
| <strong>forwardedEvents</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>{@inheritdoc}</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getPattern"> |
| <div class="location">at line 25</div> |
| <code> public |
| <strong>getPattern</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div id="footer"> |
| Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>. |
| </div> |
| </body> |
| </html> |
| /vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/Format/ProgressListener/VideoProgressListener.html |
|---|
| @@ -0,0 +1,369 @@ |
|---|
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="robots" content="index, follow, all" /> |
| <title>FFMpeg\Format\ProgressListener\VideoProgressListener | PHP-FFMpeg API</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css"> |
| </head> |
| <body id="class"> |
| <div class="header"> |
| <ul> |
| <li><a href="../../../classes.html">Classes</a></li> |
| <li><a href="../../../namespaces.html">Namespaces</a></li> |
| <li><a href="../../../interfaces.html">Interfaces</a></li> |
| <li><a href="../../../traits.html">Traits</a></li> |
| <li><a href="../../../doc-index.html">Index</a></li> |
| |
| </ul> |
| |
| <div id="title">PHP-FFMpeg API</div> |
| |
| <div class="type">Class</div> |
| <h1><a href="../../../FFMpeg/Format/ProgressListener.html">FFMpeg\Format\ProgressListener</a>\VideoProgressListener</h1> |
| </div> |
| <div class="content"> |
| <p> class |
| <strong>VideoProgressListener</strong> extends <a href="../../../FFMpeg/Format/ProgressListener/AbstractProgressListener.html"><abbr title="FFMpeg\Format\ProgressListener\AbstractProgressListener">AbstractProgressListener</abbr></a></p> |
| |
| <div class="description"> |
| <p>Parses ffmpeg stderr progress information for video files.</p> |
| <p>An example:</p> |
| |
| <pre> |
| frame= 171 fps=0.0 q=10.0 size= 18kB time=00:00:05.72 bitrate= 26.4kbits/s dup=8 drop=0 |
| </pre> |
| </p> |
| </div> |
| |
| |
| |
| <h2>Methods</h2> |
| |
| <table> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method___construct">__construct</a>(<a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe, string $pathfile, integer $currentPass, integer $totalPass) |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/ProgressListener/AbstractProgressListener.html#method___construct"><abbr title="FFMpeg\Format\ProgressListener\AbstractProgressListener">AbstractProgressListener</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getFFProbe">getFFProbe</a>() |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/ProgressListener/AbstractProgressListener.html#method_getFFProbe"><abbr title="FFMpeg\Format\ProgressListener\AbstractProgressListener">AbstractProgressListener</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getPathfile">getPathfile</a>() |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/ProgressListener/AbstractProgressListener.html#method_getPathfile"><abbr title="FFMpeg\Format\ProgressListener\AbstractProgressListener">AbstractProgressListener</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getCurrentPass">getCurrentPass</a>() |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/ProgressListener/AbstractProgressListener.html#method_getCurrentPass"><abbr title="FFMpeg\Format\ProgressListener\AbstractProgressListener">AbstractProgressListener</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getTotalPass">getTotalPass</a>() |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/ProgressListener/AbstractProgressListener.html#method_getTotalPass"><abbr title="FFMpeg\Format\ProgressListener\AbstractProgressListener">AbstractProgressListener</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_handle">handle</a>($type, $data) |
| <p>{@inheritdoc}</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/ProgressListener/AbstractProgressListener.html#method_handle"><abbr title="FFMpeg\Format\ProgressListener\AbstractProgressListener">AbstractProgressListener</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_forwardedEvents">forwardedEvents</a>() |
| <p>{@inheritdoc}</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/ProgressListener/AbstractProgressListener.html#method_forwardedEvents"><abbr title="FFMpeg\Format\ProgressListener\AbstractProgressListener">AbstractProgressListener</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_getPattern">getPattern</a>() |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| <h2>Details</h2> |
| |
| <h3 id="method___construct"> |
| <div class="location">in <a href="../../../FFMpeg/Format/ProgressListener/AbstractProgressListener.html#method___construct"><abbr title="FFMpeg\Format\ProgressListener\AbstractProgressListener">AbstractProgressListener</abbr></a> at line 83</div> |
| <code> public |
| <strong>__construct</strong>(<a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe, string $pathfile, integer $currentPass, integer $totalPass)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td>$ffprobe</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td>string</td> |
| <td>$pathfile</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td>integer</td> |
| <td>$currentPass</td> |
| <td>The cureent pass number</td> |
| </tr> |
| <tr> |
| <td>integer</td> |
| <td>$totalPass</td> |
| <td>The total number of passes</td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/RuntimeException"><abbr title="RuntimeException">RuntimeException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getFFProbe"> |
| <div class="location">in <a href="../../../FFMpeg/Format/ProgressListener/AbstractProgressListener.html#method_getFFProbe"><abbr title="FFMpeg\Format\ProgressListener\AbstractProgressListener">AbstractProgressListener</abbr></a> at line 94</div> |
| <code> public <a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> |
| <strong>getFFProbe</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getPathfile"> |
| <div class="location">in <a href="../../../FFMpeg/Format/ProgressListener/AbstractProgressListener.html#method_getPathfile"><abbr title="FFMpeg\Format\ProgressListener\AbstractProgressListener">AbstractProgressListener</abbr></a> at line 102</div> |
| <code> public string |
| <strong>getPathfile</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getCurrentPass"> |
| <div class="location">in <a href="../../../FFMpeg/Format/ProgressListener/AbstractProgressListener.html#method_getCurrentPass"><abbr title="FFMpeg\Format\ProgressListener\AbstractProgressListener">AbstractProgressListener</abbr></a> at line 110</div> |
| <code> public integer |
| <strong>getCurrentPass</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getTotalPass"> |
| <div class="location">in <a href="../../../FFMpeg/Format/ProgressListener/AbstractProgressListener.html#method_getTotalPass"><abbr title="FFMpeg\Format\ProgressListener\AbstractProgressListener">AbstractProgressListener</abbr></a> at line 118</div> |
| <code> public integer |
| <strong>getTotalPass</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_handle"> |
| <div class="location">in <a href="../../../FFMpeg/Format/ProgressListener/AbstractProgressListener.html#method_handle"><abbr title="FFMpeg\Format\ProgressListener\AbstractProgressListener">AbstractProgressListener</abbr></a> at line 126</div> |
| <code> public |
| <strong>handle</strong>($type, $data)</code> |
| </h3> |
| <div class="details"> |
| <p>{@inheritdoc}</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td></td> |
| <td>$type</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$data</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_forwardedEvents"> |
| <div class="location">in <a href="../../../FFMpeg/Format/ProgressListener/AbstractProgressListener.html#method_forwardedEvents"><abbr title="FFMpeg\Format\ProgressListener\AbstractProgressListener">AbstractProgressListener</abbr></a> at line 136</div> |
| <code> public |
| <strong>forwardedEvents</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>{@inheritdoc}</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getPattern"> |
| <div class="location">at line 25</div> |
| <code> public |
| <strong>getPattern</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div id="footer"> |
| Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>. |
| </div> |
| </body> |
| </html> |
| /vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/Format/Video/DefaultVideo.html |
|---|
| @@ -0,0 +1,639 @@ |
|---|
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="robots" content="index, follow, all" /> |
| <title>FFMpeg\Format\Video\DefaultVideo | PHP-FFMpeg API</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css"> |
| </head> |
| <body id="class"> |
| <div class="header"> |
| <ul> |
| <li><a href="../../../classes.html">Classes</a></li> |
| <li><a href="../../../namespaces.html">Namespaces</a></li> |
| <li><a href="../../../interfaces.html">Interfaces</a></li> |
| <li><a href="../../../traits.html">Traits</a></li> |
| <li><a href="../../../doc-index.html">Index</a></li> |
| |
| </ul> |
| |
| <div id="title">PHP-FFMpeg API</div> |
| |
| <div class="type">Class</div> |
| <h1><a href="../../../FFMpeg/Format/Video.html">FFMpeg\Format\Video</a>\DefaultVideo</h1> |
| </div> |
| <div class="content"> |
| <p>abstract class |
| <strong>DefaultVideo</strong> extends <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> implements |
| <a href="../../../FFMpeg/Format/VideoInterface.html"><abbr title="FFMpeg\Format\VideoInterface">VideoInterface</abbr></a></p> |
| |
| <div class="description"> |
| <p>The abstract default Video format</p> |
| <p> |
| </p> |
| </div> |
| |
| |
| |
| <h2>Methods</h2> |
| |
| <table> |
| <tr> |
| <td class="type"> |
| <abbr title="FFMpeg\Format\array()">array()</abbr> |
| </td> |
| <td class="last"> |
| <a href="#method_getExtraParams">getExtraParams</a>() |
| <p>Returns an array of extra parameters to add to ffmpeg commandline.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getExtraParams"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioCodec">getAudioCodec</a>() |
| <p>Returns the audio codec.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setAudioCodec">setAudioCodec</a>(string $audioCodec) |
| <p>Sets the audio codec, Should be in the available ones, otherwise an exception is thrown.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioKiloBitrate">getAudioKiloBitrate</a>() |
| <p>Gets the audio kiloBitrate value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setAudioKiloBitrate">setAudioKiloBitrate</a>(integer $kiloBitrate) |
| <p>Sets the kiloBitrate value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioChannels">getAudioChannels</a>() |
| <p>Gets the audio channels value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setAudioChannels">setAudioChannels</a>(integer $channels) |
| <p>Sets the channels value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_createProgressListener">createProgressListener</a>(<a href="../../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> $media, <a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe, Integer $pass, Integer $total) |
| <p>Creates the progress listener.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getPasses">getPasses</a>() |
| <p>Returns the number of passes.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getPasses"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getKiloBitrate">getKiloBitrate</a>() |
| <p>Gets the kiloBitrate value.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setKiloBitrate">setKiloBitrate</a>(integer $kiloBitrate) |
| <p>Sets the kiloBitrate value.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getVideoCodec">getVideoCodec</a>() |
| <p>Returns the video codec.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setVideoCodec">setVideoCodec</a>(string $videoCodec) |
| <p>Sets the video codec, Should be in the available ones, otherwise an exception is thrown.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getModulus">getModulus</a>() |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| <h2>Details</h2> |
| |
| <h3 id="method_getExtraParams"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getExtraParams"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 36</div> |
| <code> public <abbr title="FFMpeg\Format\array()">array()</abbr> |
| <strong>getExtraParams</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns an array of extra parameters to add to ffmpeg commandline.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><abbr title="FFMpeg\Format\array()">array()</abbr></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioCodec"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 44</div> |
| <code> public string |
| <strong>getAudioCodec</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the audio codec.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setAudioCodec"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 57</div> |
| <code> public |
| <strong>setAudioCodec</strong>(string $audioCodec)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the audio codec, Should be in the available ones, otherwise an exception is thrown.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td>$audioCodec</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioKiloBitrate"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 74</div> |
| <code> public integer |
| <strong>getAudioKiloBitrate</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Gets the audio kiloBitrate value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setAudioKiloBitrate"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 85</div> |
| <code> public |
| <strong>setAudioKiloBitrate</strong>(integer $kiloBitrate)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the kiloBitrate value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td>$kiloBitrate</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioChannels"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 99</div> |
| <code> public integer |
| <strong>getAudioChannels</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Gets the audio channels value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setAudioChannels"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 110</div> |
| <code> public |
| <strong>setAudioChannels</strong>(integer $channels)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the channels value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td>$channels</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_createProgressListener"> |
| <div class="location">at line 100</div> |
| <code> public array |
| <strong>createProgressListener</strong>(<a href="../../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> $media, <a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe, Integer $pass, Integer $total)</code> |
| </h3> |
| <div class="details"> |
| <p>Creates the progress listener.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td> |
| <td>$media</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td>$ffprobe</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td>Integer</td> |
| <td>$pass</td> |
| <td>The current pas snumber</td> |
| </tr> |
| <tr> |
| <td>Integer</td> |
| <td>$total</td> |
| <td>The total pass number</td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td>An array of listeners</td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getPasses"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getPasses"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 138</div> |
| <code> public string |
| <strong>getPasses</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the number of passes.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getKiloBitrate"> |
| <div class="location">at line 38</div> |
| <code> public integer |
| <strong>getKiloBitrate</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Gets the kiloBitrate value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setKiloBitrate"> |
| <div class="location">at line 49</div> |
| <code> public |
| <strong>setKiloBitrate</strong>(integer $kiloBitrate)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the kiloBitrate value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td>$kiloBitrate</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getVideoCodec"> |
| <div class="location">at line 63</div> |
| <code> public string |
| <strong>getVideoCodec</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the video codec.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setVideoCodec"> |
| <div class="location">at line 75</div> |
| <code> public |
| <strong>setVideoCodec</strong>(string $videoCodec)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the video codec, Should be in the available ones, otherwise an exception is thrown.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td>$videoCodec</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getModulus"> |
| <div class="location">at line 92</div> |
| <code> public integer |
| <strong>getModulus</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div id="footer"> |
| Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>. |
| </div> |
| </body> |
| </html> |
| /vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/Format/Video/Ogg.html |
|---|
| @@ -0,0 +1,791 @@ |
|---|
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="robots" content="index, follow, all" /> |
| <title>FFMpeg\Format\Video\Ogg | PHP-FFMpeg API</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css"> |
| </head> |
| <body id="class"> |
| <div class="header"> |
| <ul> |
| <li><a href="../../../classes.html">Classes</a></li> |
| <li><a href="../../../namespaces.html">Namespaces</a></li> |
| <li><a href="../../../interfaces.html">Interfaces</a></li> |
| <li><a href="../../../traits.html">Traits</a></li> |
| <li><a href="../../../doc-index.html">Index</a></li> |
| |
| </ul> |
| |
| <div id="title">PHP-FFMpeg API</div> |
| |
| <div class="type">Class</div> |
| <h1><a href="../../../FFMpeg/Format/Video.html">FFMpeg\Format\Video</a>\Ogg</h1> |
| </div> |
| <div class="content"> |
| <p> class |
| <strong>Ogg</strong> extends <a href="../../../FFMpeg/Format/Video/DefaultVideo.html"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></p> |
| |
| <div class="description"> |
| <p>The Ogg video format</p> |
| <p> |
| </p> |
| </div> |
| |
| |
| |
| <h2>Methods</h2> |
| |
| <table> |
| <tr> |
| <td class="type"> |
| <abbr title="FFMpeg\Format\array()">array()</abbr> |
| </td> |
| <td class="last"> |
| <a href="#method_getExtraParams">getExtraParams</a>() |
| <p>Returns an array of extra parameters to add to ffmpeg commandline.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getExtraParams"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioCodec">getAudioCodec</a>() |
| <p>Returns the audio codec.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setAudioCodec">setAudioCodec</a>(string $audioCodec) |
| <p>Sets the audio codec, Should be in the available ones, otherwise an exception is thrown.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioKiloBitrate">getAudioKiloBitrate</a>() |
| <p>Gets the audio kiloBitrate value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setAudioKiloBitrate">setAudioKiloBitrate</a>(integer $kiloBitrate) |
| <p>Sets the kiloBitrate value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioChannels">getAudioChannels</a>() |
| <p>Gets the audio channels value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setAudioChannels">setAudioChannels</a>(integer $channels) |
| <p>Sets the channels value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_createProgressListener">createProgressListener</a>(<a href="../../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> $media, <a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe, Integer $pass, Integer $total) |
| <p>Creates the progress listener.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_createProgressListener"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getPasses">getPasses</a>() |
| <p>Returns the number of passes.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getPasses"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getKiloBitrate">getKiloBitrate</a>() |
| <p>Gets the kiloBitrate value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getKiloBitrate"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setKiloBitrate">setKiloBitrate</a>(integer $kiloBitrate) |
| <p>Sets the kiloBitrate value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setKiloBitrate"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getVideoCodec">getVideoCodec</a>() |
| <p>Returns the video codec.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setVideoCodec">setVideoCodec</a>(string $videoCodec) |
| <p>Sets the video codec, Should be in the available ones, otherwise an exception is thrown.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getModulus">getModulus</a>() |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getModulus"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method___construct">__construct</a>($audioCodec = 'libvorbis', $videoCodec = 'libtheora') |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| Boolean |
| </td> |
| <td class="last"> |
| <a href="#method_supportBFrames">supportBFrames</a>() |
| <p>Returns true if the current format supports B-Frames.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_getAvailableAudioCodecs">getAvailableAudioCodecs</a>() |
| <p>Returns the list of available audio codecs for this format.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_getAvailableVideoCodecs">getAvailableVideoCodecs</a>() |
| <p>Returns the list of available video codecs for this format.</p> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| <h2>Details</h2> |
| |
| <h3 id="method_getExtraParams"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getExtraParams"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 36</div> |
| <code> public <abbr title="FFMpeg\Format\array()">array()</abbr> |
| <strong>getExtraParams</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns an array of extra parameters to add to ffmpeg commandline.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><abbr title="FFMpeg\Format\array()">array()</abbr></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioCodec"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 44</div> |
| <code> public string |
| <strong>getAudioCodec</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the audio codec.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setAudioCodec"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 57</div> |
| <code> public |
| <strong>setAudioCodec</strong>(string $audioCodec)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the audio codec, Should be in the available ones, otherwise an exception is thrown.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td>$audioCodec</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioKiloBitrate"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 74</div> |
| <code> public integer |
| <strong>getAudioKiloBitrate</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Gets the audio kiloBitrate value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setAudioKiloBitrate"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 85</div> |
| <code> public |
| <strong>setAudioKiloBitrate</strong>(integer $kiloBitrate)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the kiloBitrate value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td>$kiloBitrate</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioChannels"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 99</div> |
| <code> public integer |
| <strong>getAudioChannels</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Gets the audio channels value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setAudioChannels"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 110</div> |
| <code> public |
| <strong>setAudioChannels</strong>(integer $channels)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the channels value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td>$channels</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_createProgressListener"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_createProgressListener"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 100</div> |
| <code> public array |
| <strong>createProgressListener</strong>(<a href="../../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> $media, <a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe, Integer $pass, Integer $total)</code> |
| </h3> |
| <div class="details"> |
| <p>Creates the progress listener.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td> |
| <td>$media</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td>$ffprobe</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td>Integer</td> |
| <td>$pass</td> |
| <td>The current pas snumber</td> |
| </tr> |
| <tr> |
| <td>Integer</td> |
| <td>$total</td> |
| <td>The total pass number</td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td>An array of listeners</td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getPasses"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getPasses"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 138</div> |
| <code> public string |
| <strong>getPasses</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the number of passes.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getKiloBitrate"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getKiloBitrate"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 38</div> |
| <code> public integer |
| <strong>getKiloBitrate</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Gets the kiloBitrate value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setKiloBitrate"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setKiloBitrate"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 49</div> |
| <code> public |
| <strong>setKiloBitrate</strong>(integer $kiloBitrate)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the kiloBitrate value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td>$kiloBitrate</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getVideoCodec"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 63</div> |
| <code> public string |
| <strong>getVideoCodec</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the video codec.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setVideoCodec"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 75</div> |
| <code> public |
| <strong>setVideoCodec</strong>(string $videoCodec)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the video codec, Should be in the available ones, otherwise an exception is thrown.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td>$videoCodec</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getModulus"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getModulus"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 92</div> |
| <code> public integer |
| <strong>getModulus</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method___construct"> |
| <div class="location">at line 19</div> |
| <code> public |
| <strong>__construct</strong>($audioCodec = 'libvorbis', $videoCodec = 'libtheora')</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td></td> |
| <td>$audioCodec</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$videoCodec</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_supportBFrames"> |
| <div class="location">at line 29</div> |
| <code> public Boolean |
| <strong>supportBFrames</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns true if the current format supports B-Frames.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>Boolean</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAvailableAudioCodecs"> |
| <div class="location">at line 37</div> |
| <code> public array |
| <strong>getAvailableAudioCodecs</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the list of available audio codecs for this format.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAvailableVideoCodecs"> |
| <div class="location">at line 45</div> |
| <code> public array |
| <strong>getAvailableVideoCodecs</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the list of available video codecs for this format.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div id="footer"> |
| Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>. |
| </div> |
| </body> |
| </html> |
| /vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/Format/Video/WMV.html |
|---|
| @@ -0,0 +1,791 @@ |
|---|
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="robots" content="index, follow, all" /> |
| <title>FFMpeg\Format\Video\WMV | PHP-FFMpeg API</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css"> |
| </head> |
| <body id="class"> |
| <div class="header"> |
| <ul> |
| <li><a href="../../../classes.html">Classes</a></li> |
| <li><a href="../../../namespaces.html">Namespaces</a></li> |
| <li><a href="../../../interfaces.html">Interfaces</a></li> |
| <li><a href="../../../traits.html">Traits</a></li> |
| <li><a href="../../../doc-index.html">Index</a></li> |
| |
| </ul> |
| |
| <div id="title">PHP-FFMpeg API</div> |
| |
| <div class="type">Class</div> |
| <h1><a href="../../../FFMpeg/Format/Video.html">FFMpeg\Format\Video</a>\WMV</h1> |
| </div> |
| <div class="content"> |
| <p> class |
| <strong>WMV</strong> extends <a href="../../../FFMpeg/Format/Video/DefaultVideo.html"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></p> |
| |
| <div class="description"> |
| <p>The WMV video format</p> |
| <p> |
| </p> |
| </div> |
| |
| |
| |
| <h2>Methods</h2> |
| |
| <table> |
| <tr> |
| <td class="type"> |
| <abbr title="FFMpeg\Format\array()">array()</abbr> |
| </td> |
| <td class="last"> |
| <a href="#method_getExtraParams">getExtraParams</a>() |
| <p>Returns an array of extra parameters to add to ffmpeg commandline.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getExtraParams"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioCodec">getAudioCodec</a>() |
| <p>Returns the audio codec.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setAudioCodec">setAudioCodec</a>(string $audioCodec) |
| <p>Sets the audio codec, Should be in the available ones, otherwise an exception is thrown.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioKiloBitrate">getAudioKiloBitrate</a>() |
| <p>Gets the audio kiloBitrate value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setAudioKiloBitrate">setAudioKiloBitrate</a>(integer $kiloBitrate) |
| <p>Sets the kiloBitrate value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioChannels">getAudioChannels</a>() |
| <p>Gets the audio channels value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setAudioChannels">setAudioChannels</a>(integer $channels) |
| <p>Sets the channels value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_createProgressListener">createProgressListener</a>(<a href="../../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> $media, <a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe, Integer $pass, Integer $total) |
| <p>Creates the progress listener.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_createProgressListener"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getPasses">getPasses</a>() |
| <p>Returns the number of passes.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getPasses"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getKiloBitrate">getKiloBitrate</a>() |
| <p>Gets the kiloBitrate value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getKiloBitrate"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setKiloBitrate">setKiloBitrate</a>(integer $kiloBitrate) |
| <p>Sets the kiloBitrate value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setKiloBitrate"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getVideoCodec">getVideoCodec</a>() |
| <p>Returns the video codec.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setVideoCodec">setVideoCodec</a>(string $videoCodec) |
| <p>Sets the video codec, Should be in the available ones, otherwise an exception is thrown.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getModulus">getModulus</a>() |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getModulus"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method___construct">__construct</a>($audioCodec = 'wmav2', $videoCodec = 'wmv2') |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| Boolean |
| </td> |
| <td class="last"> |
| <a href="#method_supportBFrames">supportBFrames</a>() |
| <p>Returns true if the current format supports B-Frames.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_getAvailableAudioCodecs">getAvailableAudioCodecs</a>() |
| <p>Returns the list of available audio codecs for this format.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_getAvailableVideoCodecs">getAvailableVideoCodecs</a>() |
| <p>Returns the list of available video codecs for this format.</p> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| <h2>Details</h2> |
| |
| <h3 id="method_getExtraParams"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getExtraParams"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 36</div> |
| <code> public <abbr title="FFMpeg\Format\array()">array()</abbr> |
| <strong>getExtraParams</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns an array of extra parameters to add to ffmpeg commandline.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><abbr title="FFMpeg\Format\array()">array()</abbr></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioCodec"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 44</div> |
| <code> public string |
| <strong>getAudioCodec</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the audio codec.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setAudioCodec"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 57</div> |
| <code> public |
| <strong>setAudioCodec</strong>(string $audioCodec)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the audio codec, Should be in the available ones, otherwise an exception is thrown.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td>$audioCodec</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioKiloBitrate"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 74</div> |
| <code> public integer |
| <strong>getAudioKiloBitrate</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Gets the audio kiloBitrate value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setAudioKiloBitrate"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 85</div> |
| <code> public |
| <strong>setAudioKiloBitrate</strong>(integer $kiloBitrate)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the kiloBitrate value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td>$kiloBitrate</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioChannels"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 99</div> |
| <code> public integer |
| <strong>getAudioChannels</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Gets the audio channels value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setAudioChannels"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 110</div> |
| <code> public |
| <strong>setAudioChannels</strong>(integer $channels)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the channels value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td>$channels</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_createProgressListener"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_createProgressListener"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 100</div> |
| <code> public array |
| <strong>createProgressListener</strong>(<a href="../../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> $media, <a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe, Integer $pass, Integer $total)</code> |
| </h3> |
| <div class="details"> |
| <p>Creates the progress listener.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td> |
| <td>$media</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td>$ffprobe</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td>Integer</td> |
| <td>$pass</td> |
| <td>The current pas snumber</td> |
| </tr> |
| <tr> |
| <td>Integer</td> |
| <td>$total</td> |
| <td>The total pass number</td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td>An array of listeners</td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getPasses"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getPasses"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 138</div> |
| <code> public string |
| <strong>getPasses</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the number of passes.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getKiloBitrate"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getKiloBitrate"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 38</div> |
| <code> public integer |
| <strong>getKiloBitrate</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Gets the kiloBitrate value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setKiloBitrate"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setKiloBitrate"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 49</div> |
| <code> public |
| <strong>setKiloBitrate</strong>(integer $kiloBitrate)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the kiloBitrate value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td>$kiloBitrate</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getVideoCodec"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 63</div> |
| <code> public string |
| <strong>getVideoCodec</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the video codec.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setVideoCodec"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 75</div> |
| <code> public |
| <strong>setVideoCodec</strong>(string $videoCodec)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the video codec, Should be in the available ones, otherwise an exception is thrown.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td>$videoCodec</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getModulus"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getModulus"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 92</div> |
| <code> public integer |
| <strong>getModulus</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method___construct"> |
| <div class="location">at line 19</div> |
| <code> public |
| <strong>__construct</strong>($audioCodec = 'wmav2', $videoCodec = 'wmv2')</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td></td> |
| <td>$audioCodec</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$videoCodec</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_supportBFrames"> |
| <div class="location">at line 29</div> |
| <code> public Boolean |
| <strong>supportBFrames</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns true if the current format supports B-Frames.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>Boolean</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAvailableAudioCodecs"> |
| <div class="location">at line 37</div> |
| <code> public array |
| <strong>getAvailableAudioCodecs</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the list of available audio codecs for this format.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAvailableVideoCodecs"> |
| <div class="location">at line 45</div> |
| <code> public array |
| <strong>getAvailableVideoCodecs</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the list of available video codecs for this format.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div id="footer"> |
| Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>. |
| </div> |
| </body> |
| </html> |
| /vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/Format/Video/WMV3.html |
|---|
| @@ -0,0 +1,791 @@ |
|---|
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="robots" content="index, follow, all" /> |
| <title>FFMpeg\Format\Video\WMV3 | PHP-FFMpeg API</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css"> |
| </head> |
| <body id="class"> |
| <div class="header"> |
| <ul> |
| <li><a href="../../../classes.html">Classes</a></li> |
| <li><a href="../../../namespaces.html">Namespaces</a></li> |
| <li><a href="../../../interfaces.html">Interfaces</a></li> |
| <li><a href="../../../traits.html">Traits</a></li> |
| <li><a href="../../../doc-index.html">Index</a></li> |
| |
| </ul> |
| |
| <div id="title">PHP-FFMpeg API</div> |
| |
| <div class="type">Class</div> |
| <h1><a href="../../../FFMpeg/Format/Video.html">FFMpeg\Format\Video</a>\WMV3</h1> |
| </div> |
| <div class="content"> |
| <p> class |
| <strong>WMV3</strong> extends <a href="../../../FFMpeg/Format/Video/DefaultVideo.html"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></p> |
| |
| <div class="description"> |
| <p>The WMV video format</p> |
| <p> |
| </p> |
| </div> |
| |
| |
| |
| <h2>Methods</h2> |
| |
| <table> |
| <tr> |
| <td class="type"> |
| <abbr title="FFMpeg\Format\array()">array()</abbr> |
| </td> |
| <td class="last"> |
| <a href="#method_getExtraParams">getExtraParams</a>() |
| <p>Returns an array of extra parameters to add to ffmpeg commandline.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getExtraParams"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioCodec">getAudioCodec</a>() |
| <p>Returns the audio codec.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setAudioCodec">setAudioCodec</a>(string $audioCodec) |
| <p>Sets the audio codec, Should be in the available ones, otherwise an exception is thrown.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioKiloBitrate">getAudioKiloBitrate</a>() |
| <p>Gets the audio kiloBitrate value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setAudioKiloBitrate">setAudioKiloBitrate</a>(integer $kiloBitrate) |
| <p>Sets the kiloBitrate value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioChannels">getAudioChannels</a>() |
| <p>Gets the audio channels value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setAudioChannels">setAudioChannels</a>(integer $channels) |
| <p>Sets the channels value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_createProgressListener">createProgressListener</a>(<a href="../../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> $media, <a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe, Integer $pass, Integer $total) |
| <p>Creates the progress listener.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_createProgressListener"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getPasses">getPasses</a>() |
| <p>Returns the number of passes.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getPasses"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getKiloBitrate">getKiloBitrate</a>() |
| <p>Gets the kiloBitrate value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getKiloBitrate"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setKiloBitrate">setKiloBitrate</a>(integer $kiloBitrate) |
| <p>Sets the kiloBitrate value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setKiloBitrate"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getVideoCodec">getVideoCodec</a>() |
| <p>Returns the video codec.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setVideoCodec">setVideoCodec</a>(string $videoCodec) |
| <p>Sets the video codec, Should be in the available ones, otherwise an exception is thrown.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getModulus">getModulus</a>() |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getModulus"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method___construct">__construct</a>($audioCodec = 'wmav3', $videoCodec = 'wmv3') |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| Boolean |
| </td> |
| <td class="last"> |
| <a href="#method_supportBFrames">supportBFrames</a>() |
| <p>Returns true if the current format supports B-Frames.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_getAvailableAudioCodecs">getAvailableAudioCodecs</a>() |
| <p>Returns the list of available audio codecs for this format.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_getAvailableVideoCodecs">getAvailableVideoCodecs</a>() |
| <p>Returns the list of available video codecs for this format.</p> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| <h2>Details</h2> |
| |
| <h3 id="method_getExtraParams"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getExtraParams"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 36</div> |
| <code> public <abbr title="FFMpeg\Format\array()">array()</abbr> |
| <strong>getExtraParams</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns an array of extra parameters to add to ffmpeg commandline.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><abbr title="FFMpeg\Format\array()">array()</abbr></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioCodec"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 44</div> |
| <code> public string |
| <strong>getAudioCodec</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the audio codec.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setAudioCodec"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 57</div> |
| <code> public |
| <strong>setAudioCodec</strong>(string $audioCodec)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the audio codec, Should be in the available ones, otherwise an exception is thrown.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td>$audioCodec</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioKiloBitrate"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 74</div> |
| <code> public integer |
| <strong>getAudioKiloBitrate</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Gets the audio kiloBitrate value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setAudioKiloBitrate"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 85</div> |
| <code> public |
| <strong>setAudioKiloBitrate</strong>(integer $kiloBitrate)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the kiloBitrate value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td>$kiloBitrate</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioChannels"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 99</div> |
| <code> public integer |
| <strong>getAudioChannels</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Gets the audio channels value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setAudioChannels"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 110</div> |
| <code> public |
| <strong>setAudioChannels</strong>(integer $channels)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the channels value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td>$channels</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_createProgressListener"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_createProgressListener"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 100</div> |
| <code> public array |
| <strong>createProgressListener</strong>(<a href="../../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> $media, <a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe, Integer $pass, Integer $total)</code> |
| </h3> |
| <div class="details"> |
| <p>Creates the progress listener.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td> |
| <td>$media</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td>$ffprobe</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td>Integer</td> |
| <td>$pass</td> |
| <td>The current pas snumber</td> |
| </tr> |
| <tr> |
| <td>Integer</td> |
| <td>$total</td> |
| <td>The total pass number</td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td>An array of listeners</td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getPasses"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getPasses"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 138</div> |
| <code> public string |
| <strong>getPasses</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the number of passes.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getKiloBitrate"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getKiloBitrate"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 38</div> |
| <code> public integer |
| <strong>getKiloBitrate</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Gets the kiloBitrate value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setKiloBitrate"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setKiloBitrate"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 49</div> |
| <code> public |
| <strong>setKiloBitrate</strong>(integer $kiloBitrate)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the kiloBitrate value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td>$kiloBitrate</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getVideoCodec"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 63</div> |
| <code> public string |
| <strong>getVideoCodec</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the video codec.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setVideoCodec"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 75</div> |
| <code> public |
| <strong>setVideoCodec</strong>(string $videoCodec)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the video codec, Should be in the available ones, otherwise an exception is thrown.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td>$videoCodec</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getModulus"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getModulus"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 92</div> |
| <code> public integer |
| <strong>getModulus</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method___construct"> |
| <div class="location">at line 19</div> |
| <code> public |
| <strong>__construct</strong>($audioCodec = 'wmav3', $videoCodec = 'wmv3')</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td></td> |
| <td>$audioCodec</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$videoCodec</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_supportBFrames"> |
| <div class="location">at line 29</div> |
| <code> public Boolean |
| <strong>supportBFrames</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns true if the current format supports B-Frames.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>Boolean</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAvailableAudioCodecs"> |
| <div class="location">at line 37</div> |
| <code> public array |
| <strong>getAvailableAudioCodecs</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the list of available audio codecs for this format.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAvailableVideoCodecs"> |
| <div class="location">at line 45</div> |
| <code> public array |
| <strong>getAvailableVideoCodecs</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the list of available video codecs for this format.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div id="footer"> |
| Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>. |
| </div> |
| </body> |
| </html> |
| /vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/Format/Video/WebM.html |
|---|
| @@ -0,0 +1,791 @@ |
|---|
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="robots" content="index, follow, all" /> |
| <title>FFMpeg\Format\Video\WebM | PHP-FFMpeg API</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css"> |
| </head> |
| <body id="class"> |
| <div class="header"> |
| <ul> |
| <li><a href="../../../classes.html">Classes</a></li> |
| <li><a href="../../../namespaces.html">Namespaces</a></li> |
| <li><a href="../../../interfaces.html">Interfaces</a></li> |
| <li><a href="../../../traits.html">Traits</a></li> |
| <li><a href="../../../doc-index.html">Index</a></li> |
| |
| </ul> |
| |
| <div id="title">PHP-FFMpeg API</div> |
| |
| <div class="type">Class</div> |
| <h1><a href="../../../FFMpeg/Format/Video.html">FFMpeg\Format\Video</a>\WebM</h1> |
| </div> |
| <div class="content"> |
| <p> class |
| <strong>WebM</strong> extends <a href="../../../FFMpeg/Format/Video/DefaultVideo.html"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></p> |
| |
| <div class="description"> |
| <p>The WebM video format</p> |
| <p> |
| </p> |
| </div> |
| |
| |
| |
| <h2>Methods</h2> |
| |
| <table> |
| <tr> |
| <td class="type"> |
| <abbr title="FFMpeg\Format\array()">array()</abbr> |
| </td> |
| <td class="last"> |
| <a href="#method_getExtraParams">getExtraParams</a>() |
| <p>Returns an array of extra parameters to add to ffmpeg commandline.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioCodec">getAudioCodec</a>() |
| <p>Returns the audio codec.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setAudioCodec">setAudioCodec</a>(string $audioCodec) |
| <p>Sets the audio codec, Should be in the available ones, otherwise an exception is thrown.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioKiloBitrate">getAudioKiloBitrate</a>() |
| <p>Gets the audio kiloBitrate value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setAudioKiloBitrate">setAudioKiloBitrate</a>(integer $kiloBitrate) |
| <p>Sets the kiloBitrate value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioChannels">getAudioChannels</a>() |
| <p>Gets the audio channels value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setAudioChannels">setAudioChannels</a>(integer $channels) |
| <p>Sets the channels value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_createProgressListener">createProgressListener</a>(<a href="../../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> $media, <a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe, Integer $pass, Integer $total) |
| <p>Creates the progress listener.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_createProgressListener"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getPasses">getPasses</a>() |
| <p>Returns the number of passes.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getPasses"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getKiloBitrate">getKiloBitrate</a>() |
| <p>Gets the kiloBitrate value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getKiloBitrate"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setKiloBitrate">setKiloBitrate</a>(integer $kiloBitrate) |
| <p>Sets the kiloBitrate value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setKiloBitrate"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getVideoCodec">getVideoCodec</a>() |
| <p>Returns the video codec.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setVideoCodec">setVideoCodec</a>(string $videoCodec) |
| <p>Sets the video codec, Should be in the available ones, otherwise an exception is thrown.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getModulus">getModulus</a>() |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getModulus"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method___construct">__construct</a>($audioCodec = 'libvorbis', $videoCodec = 'libvpx') |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| Boolean |
| </td> |
| <td class="last"> |
| <a href="#method_supportBFrames">supportBFrames</a>() |
| <p>Returns true if the current format supports B-Frames.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_getAvailableAudioCodecs">getAvailableAudioCodecs</a>() |
| <p>Returns the list of available audio codecs for this format.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_getAvailableVideoCodecs">getAvailableVideoCodecs</a>() |
| <p>Returns the list of available video codecs for this format.</p> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| <h2>Details</h2> |
| |
| <h3 id="method_getExtraParams"> |
| <div class="location">at line 37</div> |
| <code> public <abbr title="FFMpeg\Format\array()">array()</abbr> |
| <strong>getExtraParams</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns an array of extra parameters to add to ffmpeg commandline.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><abbr title="FFMpeg\Format\array()">array()</abbr></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioCodec"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 44</div> |
| <code> public string |
| <strong>getAudioCodec</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the audio codec.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setAudioCodec"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 57</div> |
| <code> public |
| <strong>setAudioCodec</strong>(string $audioCodec)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the audio codec, Should be in the available ones, otherwise an exception is thrown.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td>$audioCodec</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioKiloBitrate"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 74</div> |
| <code> public integer |
| <strong>getAudioKiloBitrate</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Gets the audio kiloBitrate value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setAudioKiloBitrate"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 85</div> |
| <code> public |
| <strong>setAudioKiloBitrate</strong>(integer $kiloBitrate)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the kiloBitrate value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td>$kiloBitrate</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioChannels"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 99</div> |
| <code> public integer |
| <strong>getAudioChannels</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Gets the audio channels value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setAudioChannels"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 110</div> |
| <code> public |
| <strong>setAudioChannels</strong>(integer $channels)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the channels value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td>$channels</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_createProgressListener"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_createProgressListener"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 100</div> |
| <code> public array |
| <strong>createProgressListener</strong>(<a href="../../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> $media, <a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe, Integer $pass, Integer $total)</code> |
| </h3> |
| <div class="details"> |
| <p>Creates the progress listener.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td> |
| <td>$media</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td>$ffprobe</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td>Integer</td> |
| <td>$pass</td> |
| <td>The current pas snumber</td> |
| </tr> |
| <tr> |
| <td>Integer</td> |
| <td>$total</td> |
| <td>The total pass number</td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td>An array of listeners</td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getPasses"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getPasses"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 138</div> |
| <code> public string |
| <strong>getPasses</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the number of passes.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getKiloBitrate"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getKiloBitrate"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 38</div> |
| <code> public integer |
| <strong>getKiloBitrate</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Gets the kiloBitrate value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setKiloBitrate"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setKiloBitrate"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 49</div> |
| <code> public |
| <strong>setKiloBitrate</strong>(integer $kiloBitrate)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the kiloBitrate value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td>$kiloBitrate</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getVideoCodec"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 63</div> |
| <code> public string |
| <strong>getVideoCodec</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the video codec.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setVideoCodec"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 75</div> |
| <code> public |
| <strong>setVideoCodec</strong>(string $videoCodec)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the video codec, Should be in the available ones, otherwise an exception is thrown.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td>$videoCodec</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getModulus"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getModulus"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 92</div> |
| <code> public integer |
| <strong>getModulus</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method___construct"> |
| <div class="location">at line 19</div> |
| <code> public |
| <strong>__construct</strong>($audioCodec = 'libvorbis', $videoCodec = 'libvpx')</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td></td> |
| <td>$audioCodec</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$videoCodec</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_supportBFrames"> |
| <div class="location">at line 29</div> |
| <code> public Boolean |
| <strong>supportBFrames</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns true if the current format supports B-Frames.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>Boolean</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAvailableAudioCodecs"> |
| <div class="location">at line 45</div> |
| <code> public array |
| <strong>getAvailableAudioCodecs</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the list of available audio codecs for this format.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAvailableVideoCodecs"> |
| <div class="location">at line 53</div> |
| <code> public array |
| <strong>getAvailableVideoCodecs</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the list of available video codecs for this format.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div id="footer"> |
| Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>. |
| </div> |
| </body> |
| </html> |
| /vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/Format/Video/X264.html |
|---|
| @@ -0,0 +1,875 @@ |
|---|
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="robots" content="index, follow, all" /> |
| <title>FFMpeg\Format\Video\X264 | PHP-FFMpeg API</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css"> |
| </head> |
| <body id="class"> |
| <div class="header"> |
| <ul> |
| <li><a href="../../../classes.html">Classes</a></li> |
| <li><a href="../../../namespaces.html">Namespaces</a></li> |
| <li><a href="../../../interfaces.html">Interfaces</a></li> |
| <li><a href="../../../traits.html">Traits</a></li> |
| <li><a href="../../../doc-index.html">Index</a></li> |
| |
| </ul> |
| |
| <div id="title">PHP-FFMpeg API</div> |
| |
| <div class="type">Class</div> |
| <h1><a href="../../../FFMpeg/Format/Video.html">FFMpeg\Format\Video</a>\X264</h1> |
| </div> |
| <div class="content"> |
| <p> class |
| <strong>X264</strong> extends <a href="../../../FFMpeg/Format/Video/DefaultVideo.html"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></p> |
| |
| <div class="description"> |
| <p>The X264 video format</p> |
| <p> |
| </p> |
| </div> |
| |
| |
| |
| <h2>Methods</h2> |
| |
| <table> |
| <tr> |
| <td class="type"> |
| <abbr title="FFMpeg\Format\array()">array()</abbr> |
| </td> |
| <td class="last"> |
| <a href="#method_getExtraParams">getExtraParams</a>() |
| <p>Returns an array of extra parameters to add to ffmpeg commandline.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getExtraParams"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioCodec">getAudioCodec</a>() |
| <p>Returns the audio codec.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setAudioCodec">setAudioCodec</a>(string $audioCodec) |
| <p>Sets the audio codec, Should be in the available ones, otherwise an exception is thrown.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioKiloBitrate">getAudioKiloBitrate</a>() |
| <p>Gets the audio kiloBitrate value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setAudioKiloBitrate">setAudioKiloBitrate</a>(integer $kiloBitrate) |
| <p>Sets the kiloBitrate value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioChannels">getAudioChannels</a>() |
| <p>Gets the audio channels value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setAudioChannels">setAudioChannels</a>(integer $channels) |
| <p>Sets the channels value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_createProgressListener">createProgressListener</a>(<a href="../../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> $media, <a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe, Integer $pass, Integer $total) |
| <p>Creates the progress listener.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_createProgressListener"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_setPasses">setPasses</a>(integer $passes) |
| <p>Sets the number of passes.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getPasses">getPasses</a>() |
| <p>Returns the number of passes.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getKiloBitrate">getKiloBitrate</a>() |
| <p>Gets the kiloBitrate value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getKiloBitrate"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setKiloBitrate">setKiloBitrate</a>(integer $kiloBitrate) |
| <p>Sets the kiloBitrate value.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setKiloBitrate"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getVideoCodec">getVideoCodec</a>() |
| <p>Returns the video codec.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method_setVideoCodec">setVideoCodec</a>(string $videoCodec) |
| <p>Sets the video codec, Should be in the available ones, otherwise an exception is thrown.</p> |
| </td> |
| <td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| int |
| </td> |
| <td class="last"> |
| <a href="#method_getModulus">getModulus</a>() |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method___construct">__construct</a>($audioCodec = 'libfaac', $videoCodec = 'libx264') |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| Boolean |
| </td> |
| <td class="last"> |
| <a href="#method_supportBFrames">supportBFrames</a>() |
| <p>Returns true if the current format supports B-Frames.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../../FFMpeg/Format/Video/X264.html"><abbr title="FFMpeg\Format\Video\X264">X264</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_setBFramesSupport">setBFramesSupport</a>(<abbr title="FFMpeg\Format\Video\$support">$support</abbr> $support) |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_getAvailableAudioCodecs">getAvailableAudioCodecs</a>() |
| <p>Returns the list of available audio codecs for this format.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_getAvailableVideoCodecs">getAvailableVideoCodecs</a>() |
| <p>Returns the list of available video codecs for this format.</p> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| <h2>Details</h2> |
| |
| <h3 id="method_getExtraParams"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getExtraParams"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 36</div> |
| <code> public <abbr title="FFMpeg\Format\array()">array()</abbr> |
| <strong>getExtraParams</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns an array of extra parameters to add to ffmpeg commandline.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><abbr title="FFMpeg\Format\array()">array()</abbr></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioCodec"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 44</div> |
| <code> public string |
| <strong>getAudioCodec</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the audio codec.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setAudioCodec"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 57</div> |
| <code> public |
| <strong>setAudioCodec</strong>(string $audioCodec)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the audio codec, Should be in the available ones, otherwise an exception is thrown.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td>$audioCodec</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioKiloBitrate"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 74</div> |
| <code> public integer |
| <strong>getAudioKiloBitrate</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Gets the audio kiloBitrate value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setAudioKiloBitrate"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 85</div> |
| <code> public |
| <strong>setAudioKiloBitrate</strong>(integer $kiloBitrate)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the kiloBitrate value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td>$kiloBitrate</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioChannels"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 99</div> |
| <code> public integer |
| <strong>getAudioChannels</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Gets the audio channels value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setAudioChannels"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioChannels"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 110</div> |
| <code> public |
| <strong>setAudioChannels</strong>(integer $channels)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the channels value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td>$channels</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_createProgressListener"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_createProgressListener"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 100</div> |
| <code> public array |
| <strong>createProgressListener</strong>(<a href="../../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> $media, <a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe, Integer $pass, Integer $total)</code> |
| </h3> |
| <div class="details"> |
| <p>Creates the progress listener.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td> |
| <td>$media</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td>$ffprobe</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td>Integer</td> |
| <td>$pass</td> |
| <td>The current pas snumber</td> |
| </tr> |
| <tr> |
| <td>Integer</td> |
| <td>$total</td> |
| <td>The total pass number</td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td>An array of listeners</td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setPasses"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Video/X264.html#method_setPasses"><abbr title="FFMpeg\Format\Video\X264">X264</abbr></a> at line 68</div> |
| <code> public integer |
| <strong>setPasses</strong>(integer $passes)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the number of passes.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td>$passes</td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getPasses"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Video/X264.html#method_getPasses"><abbr title="FFMpeg\Format\Video\X264">X264</abbr></a> at line 79</div> |
| <code> public integer |
| <strong>getPasses</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the number of passes.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getKiloBitrate"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getKiloBitrate"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 38</div> |
| <code> public integer |
| <strong>getKiloBitrate</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Gets the kiloBitrate value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setKiloBitrate"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setKiloBitrate"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 49</div> |
| <code> public |
| <strong>setKiloBitrate</strong>(integer $kiloBitrate)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the kiloBitrate value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td>$kiloBitrate</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getVideoCodec"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 63</div> |
| <code> public string |
| <strong>getVideoCodec</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the video codec.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setVideoCodec"> |
| <div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 75</div> |
| <code> public |
| <strong>setVideoCodec</strong>(string $videoCodec)</code> |
| </h3> |
| <div class="details"> |
| <p>Sets the video codec, Should be in the available ones, otherwise an exception is thrown.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td>$videoCodec</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getModulus"> |
| <div class="location">at line 76</div> |
| <code> public int |
| <strong>getModulus</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>int</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method___construct"> |
| <div class="location">at line 22</div> |
| <code> public |
| <strong>__construct</strong>($audioCodec = 'libfaac', $videoCodec = 'libx264')</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td></td> |
| <td>$audioCodec</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$videoCodec</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_supportBFrames"> |
| <div class="location">at line 32</div> |
| <code> public Boolean |
| <strong>supportBFrames</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns true if the current format supports B-Frames.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>Boolean</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setBFramesSupport"> |
| <div class="location">at line 42</div> |
| <code> public <a href="../../../FFMpeg/Format/Video/X264.html"><abbr title="FFMpeg\Format\Video\X264">X264</abbr></a> |
| <strong>setBFramesSupport</strong>(<abbr title="FFMpeg\Format\Video\$support">$support</abbr> $support)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><abbr title="FFMpeg\Format\Video\$support">$support</abbr></td> |
| <td>$support</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../../FFMpeg/Format/Video/X264.html"><abbr title="FFMpeg\Format\Video\X264">X264</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAvailableAudioCodecs"> |
| <div class="location">at line 52</div> |
| <code> public array |
| <strong>getAvailableAudioCodecs</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the list of available audio codecs for this format.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAvailableVideoCodecs"> |
| <div class="location">at line 60</div> |
| <code> public array |
| <strong>getAvailableVideoCodecs</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the list of available video codecs for this format.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div id="footer"> |
| Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>. |
| </div> |
| </body> |
| </html> |
| /vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/Format/VideoInterface.html |
|---|
| @@ -0,0 +1,461 @@ |
|---|
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="robots" content="index, follow, all" /> |
| <title>FFMpeg\Format\VideoInterface | PHP-FFMpeg API</title> |
| <link rel="stylesheet" type="text/css" href="../../stylesheet.css"> |
| </head> |
| <body id="class"> |
| <div class="header"> |
| <ul> |
| <li><a href="../../classes.html">Classes</a></li> |
| <li><a href="../../namespaces.html">Namespaces</a></li> |
| <li><a href="../../interfaces.html">Interfaces</a></li> |
| <li><a href="../../traits.html">Traits</a></li> |
| <li><a href="../../doc-index.html">Index</a></li> |
| |
| </ul> |
| |
| <div id="title">PHP-FFMpeg API</div> |
| |
| <div class="type">Interface</div> |
| <h1><a href="../../FFMpeg/Format.html">FFMpeg\Format</a>\VideoInterface</h1> |
| </div> |
| <div class="content"> |
| <p> interface |
| <strong>VideoInterface</strong> implements |
| <a href="../../FFMpeg/Format/AudioInterface.html"><abbr title="FFMpeg\Format\AudioInterface">AudioInterface</abbr></a></p> |
| |
| |
| |
| |
| <h2>Methods</h2> |
| |
| <table> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getPasses">getPasses</a>() |
| <p>Returns the number of passes.</p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Format/FormatInterface.html#method_getPasses"><abbr title="FFMpeg\Format\FormatInterface">FormatInterface</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <abbr title="FFMpeg\Format\array()">array()</abbr> |
| </td> |
| <td class="last"> |
| <a href="#method_getExtraParams">getExtraParams</a>() |
| <p>Returns an array of extra parameters to add to ffmpeg commandline.</p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Format/FormatInterface.html#method_getExtraParams"><abbr title="FFMpeg\Format\FormatInterface">FormatInterface</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioKiloBitrate">getAudioKiloBitrate</a>() |
| <p>Gets the audio kiloBitrate value.</p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Format/AudioInterface.html#method_getAudioKiloBitrate"><abbr title="FFMpeg\Format\AudioInterface">AudioInterface</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioChannels">getAudioChannels</a>() |
| <p>Gets the audio channels value.</p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Format/AudioInterface.html#method_getAudioChannels"><abbr title="FFMpeg\Format\AudioInterface">AudioInterface</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getAudioCodec">getAudioCodec</a>() |
| <p>Returns the audio codec.</p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Format/AudioInterface.html#method_getAudioCodec"><abbr title="FFMpeg\Format\AudioInterface">AudioInterface</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_getAvailableAudioCodecs">getAvailableAudioCodecs</a>() |
| <p>Returns the list of available audio codecs for this format.</p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Format/AudioInterface.html#method_getAvailableAudioCodecs"><abbr title="FFMpeg\Format\AudioInterface">AudioInterface</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getKiloBitrate">getKiloBitrate</a>() |
| <p>Gets the kiloBitrate value.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| integer |
| </td> |
| <td class="last"> |
| <a href="#method_getModulus">getModulus</a>() |
| <p>Returns the modulus used by the Resizable video.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getVideoCodec">getVideoCodec</a>() |
| <p>Returns the video codec.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| Boolean |
| </td> |
| <td class="last"> |
| <a href="#method_supportBFrames">supportBFrames</a>() |
| <p>Returns true if the current format supports B-Frames.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| array |
| </td> |
| <td class="last"> |
| <a href="#method_getAvailableVideoCodecs">getAvailableVideoCodecs</a>() |
| <p>Returns the list of available video codecs for this format.</p> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| <h2>Details</h2> |
| |
| <h3 id="method_getPasses"> |
| <div class="location">in <a href="../../FFMpeg/Format/FormatInterface.html#method_getPasses"><abbr title="FFMpeg\Format\FormatInterface">FormatInterface</abbr></a> at line 20</div> |
| <code> public string |
| <strong>getPasses</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the number of passes.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getExtraParams"> |
| <div class="location">in <a href="../../FFMpeg/Format/FormatInterface.html#method_getExtraParams"><abbr title="FFMpeg\Format\FormatInterface">FormatInterface</abbr></a> at line 27</div> |
| <code> public <abbr title="FFMpeg\Format\array()">array()</abbr> |
| <strong>getExtraParams</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns an array of extra parameters to add to ffmpeg commandline.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><abbr title="FFMpeg\Format\array()">array()</abbr></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioKiloBitrate"> |
| <div class="location">in <a href="../../FFMpeg/Format/AudioInterface.html#method_getAudioKiloBitrate"><abbr title="FFMpeg\Format\AudioInterface">AudioInterface</abbr></a> at line 20</div> |
| <code> public integer |
| <strong>getAudioKiloBitrate</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Gets the audio kiloBitrate value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioChannels"> |
| <div class="location">in <a href="../../FFMpeg/Format/AudioInterface.html#method_getAudioChannels"><abbr title="FFMpeg\Format\AudioInterface">AudioInterface</abbr></a> at line 27</div> |
| <code> public integer |
| <strong>getAudioChannels</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Gets the audio channels value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAudioCodec"> |
| <div class="location">in <a href="../../FFMpeg/Format/AudioInterface.html#method_getAudioCodec"><abbr title="FFMpeg\Format\AudioInterface">AudioInterface</abbr></a> at line 34</div> |
| <code> public string |
| <strong>getAudioCodec</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the audio codec.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAvailableAudioCodecs"> |
| <div class="location">in <a href="../../FFMpeg/Format/AudioInterface.html#method_getAvailableAudioCodecs"><abbr title="FFMpeg\Format\AudioInterface">AudioInterface</abbr></a> at line 41</div> |
| <code> public array |
| <strong>getAvailableAudioCodecs</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the list of available audio codecs for this format.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getKiloBitrate"> |
| <div class="location">at line 21</div> |
| <code> public integer |
| <strong>getKiloBitrate</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Gets the kiloBitrate value.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getModulus"> |
| <div class="location">at line 33</div> |
| <code> public integer |
| <strong>getModulus</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the modulus used by the Resizable video.</p> |
| <p>This used to calculate the target dimensions while maintaining the best |
| aspect ratio.</p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>integer</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>See also</h4> |
| |
| <table> |
| <tr> |
| <td>http://www.undeadborn.net/tools/rescalculator.php</td> |
| <td></td> |
| </tr> |
| </table> |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getVideoCodec"> |
| <div class="location">at line 40</div> |
| <code> public string |
| <strong>getVideoCodec</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the video codec.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_supportBFrames"> |
| <div class="location">at line 49</div> |
| <code> public Boolean |
| <strong>supportBFrames</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns true if the current format supports B-Frames.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>Boolean</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| <h4>See also</h4> |
| |
| <table> |
| <tr> |
| <td>https://wikipedia.org/wiki/Video_compression_picture_types</td> |
| <td></td> |
| </tr> |
| </table> |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getAvailableVideoCodecs"> |
| <div class="location">at line 56</div> |
| <code> public array |
| <strong>getAvailableVideoCodecs</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the list of available video codecs for this format.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>array</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div id="footer"> |
| Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>. |
| </div> |
| </body> |
| </html> |
| /vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/Media/AbstractMediaType.html |
|---|
| @@ -0,0 +1,397 @@ |
|---|
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="robots" content="index, follow, all" /> |
| <title>FFMpeg\Media\AbstractMediaType | PHP-FFMpeg API</title> |
| <link rel="stylesheet" type="text/css" href="../../stylesheet.css"> |
| </head> |
| <body id="class"> |
| <div class="header"> |
| <ul> |
| <li><a href="../../classes.html">Classes</a></li> |
| <li><a href="../../namespaces.html">Namespaces</a></li> |
| <li><a href="../../interfaces.html">Interfaces</a></li> |
| <li><a href="../../traits.html">Traits</a></li> |
| <li><a href="../../doc-index.html">Index</a></li> |
| |
| </ul> |
| |
| <div id="title">PHP-FFMpeg API</div> |
| |
| <div class="type">Class</div> |
| <h1><a href="../../FFMpeg/Media.html">FFMpeg\Media</a>\AbstractMediaType</h1> |
| </div> |
| <div class="content"> |
| <p>abstract class |
| <strong>AbstractMediaType</strong> implements |
| <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></p> |
| |
| |
| |
| |
| <h2>Methods</h2> |
| |
| <table> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method___construct">__construct</a>($pathfile, <a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> $driver, <a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe) |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getFFMpegDriver">getFFMpegDriver</a>() |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_setFFMpegDriver">setFFMpegDriver</a>(<a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> $driver) |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getFFProbe">getFFProbe</a>() |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_setFFProbe">setFFProbe</a>(<a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe) |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getPathfile">getPathfile</a>() |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_setFiltersCollection">setFiltersCollection</a>(<a href="../../FFMpeg/Filters/FiltersCollection.html"><abbr title="FFMpeg\Filters\FiltersCollection">FiltersCollection</abbr></a> $filters) |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getFiltersCollection">getFiltersCollection</a>() |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| <h2>Details</h2> |
| |
| <h3 id="method___construct"> |
| <div class="location">at line 29</div> |
| <code> public |
| <strong>__construct</strong>($pathfile, <a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> $driver, <a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td></td> |
| <td>$pathfile</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a></td> |
| <td>$driver</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td>$ffprobe</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getFFMpegDriver"> |
| <div class="location">at line 40</div> |
| <code> public <a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> |
| <strong>getFFMpegDriver</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setFFMpegDriver"> |
| <div class="location">at line 50</div> |
| <code> public <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| <strong>setFFMpegDriver</strong>(<a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> $driver)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a></td> |
| <td>$driver</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getFFProbe"> |
| <div class="location">at line 60</div> |
| <code> public <a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> |
| <strong>getFFProbe</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setFFProbe"> |
| <div class="location">at line 70</div> |
| <code> public <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| <strong>setFFProbe</strong>(<a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td>$ffprobe</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getPathfile"> |
| <div class="location">at line 80</div> |
| <code> public string |
| <strong>getPathfile</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setFiltersCollection"> |
| <div class="location">at line 90</div> |
| <code> public <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| <strong>setFiltersCollection</strong>(<a href="../../FFMpeg/Filters/FiltersCollection.html"><abbr title="FFMpeg\Filters\FiltersCollection">FiltersCollection</abbr></a> $filters)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Filters/FiltersCollection.html"><abbr title="FFMpeg\Filters\FiltersCollection">FiltersCollection</abbr></a></td> |
| <td>$filters</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getFiltersCollection"> |
| <div class="location">at line 100</div> |
| <code> public <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| <strong>getFiltersCollection</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div id="footer"> |
| Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>. |
| </div> |
| </body> |
| </html> |
| /vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/Media/AbstractStreamableMedia.html |
|---|
| @@ -0,0 +1,472 @@ |
|---|
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="robots" content="index, follow, all" /> |
| <title>FFMpeg\Media\AbstractStreamableMedia | PHP-FFMpeg API</title> |
| <link rel="stylesheet" type="text/css" href="../../stylesheet.css"> |
| </head> |
| <body id="class"> |
| <div class="header"> |
| <ul> |
| <li><a href="../../classes.html">Classes</a></li> |
| <li><a href="../../namespaces.html">Namespaces</a></li> |
| <li><a href="../../interfaces.html">Interfaces</a></li> |
| <li><a href="../../traits.html">Traits</a></li> |
| <li><a href="../../doc-index.html">Index</a></li> |
| |
| </ul> |
| |
| <div id="title">PHP-FFMpeg API</div> |
| |
| <div class="type">Class</div> |
| <h1><a href="../../FFMpeg/Media.html">FFMpeg\Media</a>\AbstractStreamableMedia</h1> |
| </div> |
| <div class="content"> |
| <p>abstract class |
| <strong>AbstractStreamableMedia</strong> extends <a href="../../FFMpeg/Media/AbstractMediaType.html"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></p> |
| |
| |
| |
| |
| <h2>Methods</h2> |
| |
| <table> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method___construct">__construct</a>($pathfile, <a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> $driver, <a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe) |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method___construct"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getFFMpegDriver">getFFMpegDriver</a>() |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFFMpegDriver"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_setFFMpegDriver">setFFMpegDriver</a>(<a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> $driver) |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFFMpegDriver"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getFFProbe">getFFProbe</a>() |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFFProbe"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_setFFProbe">setFFProbe</a>(<a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe) |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFFProbe"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getPathfile">getPathfile</a>() |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getPathfile"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_setFiltersCollection">setFiltersCollection</a>(<a href="../../FFMpeg/Filters/FiltersCollection.html"><abbr title="FFMpeg\Filters\FiltersCollection">FiltersCollection</abbr></a> $filters) |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFiltersCollection"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getFiltersCollection">getFiltersCollection</a>() |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFiltersCollection"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/FFProbe/DataMapping/StreamCollection.html"><abbr title="FFMpeg\FFProbe\DataMapping\StreamCollection">StreamCollection</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getStreams">getStreams</a>() |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/FFProbe/DataMapping/Stream.html"><abbr title="FFMpeg\FFProbe\DataMapping\Stream">Stream</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getFormat">getFormat</a>() |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| <h2>Details</h2> |
| |
| <h3 id="method___construct"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method___construct"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 29</div> |
| <code> public |
| <strong>__construct</strong>($pathfile, <a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> $driver, <a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td></td> |
| <td>$pathfile</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a></td> |
| <td>$driver</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td>$ffprobe</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getFFMpegDriver"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFFMpegDriver"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 40</div> |
| <code> public <a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> |
| <strong>getFFMpegDriver</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setFFMpegDriver"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFFMpegDriver"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 50</div> |
| <code> public <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| <strong>setFFMpegDriver</strong>(<a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> $driver)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a></td> |
| <td>$driver</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getFFProbe"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFFProbe"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 60</div> |
| <code> public <a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> |
| <strong>getFFProbe</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setFFProbe"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFFProbe"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 70</div> |
| <code> public <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| <strong>setFFProbe</strong>(<a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td>$ffprobe</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getPathfile"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getPathfile"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 80</div> |
| <code> public string |
| <strong>getPathfile</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setFiltersCollection"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFiltersCollection"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 90</div> |
| <code> public <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| <strong>setFiltersCollection</strong>(<a href="../../FFMpeg/Filters/FiltersCollection.html"><abbr title="FFMpeg\Filters\FiltersCollection">FiltersCollection</abbr></a> $filters)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Filters/FiltersCollection.html"><abbr title="FFMpeg\Filters\FiltersCollection">FiltersCollection</abbr></a></td> |
| <td>$filters</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getFiltersCollection"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFiltersCollection"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 100</div> |
| <code> public <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| <strong>getFiltersCollection</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getStreams"> |
| <div class="location">at line 24</div> |
| <code> public <a href="../../FFMpeg/FFProbe/DataMapping/StreamCollection.html"><abbr title="FFMpeg\FFProbe\DataMapping\StreamCollection">StreamCollection</abbr></a> |
| <strong>getStreams</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/FFProbe/DataMapping/StreamCollection.html"><abbr title="FFMpeg\FFProbe\DataMapping\StreamCollection">StreamCollection</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getFormat"> |
| <div class="location">at line 36</div> |
| <code> public <a href="../../FFMpeg/FFProbe/DataMapping/Stream.html"><abbr title="FFMpeg\FFProbe\DataMapping\Stream">Stream</abbr></a> |
| <strong>getFormat</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/FFProbe/DataMapping/Stream.html"><abbr title="FFMpeg\FFProbe\DataMapping\Stream">Stream</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div id="footer"> |
| Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>. |
| </div> |
| </body> |
| </html> |
| /vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/Media/Audio.html |
|---|
| @@ -0,0 +1,681 @@ |
|---|
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="robots" content="index, follow, all" /> |
| <title>FFMpeg\Media\Audio | PHP-FFMpeg API</title> |
| <link rel="stylesheet" type="text/css" href="../../stylesheet.css"> |
| </head> |
| <body id="class"> |
| <div class="header"> |
| <ul> |
| <li><a href="../../classes.html">Classes</a></li> |
| <li><a href="../../namespaces.html">Namespaces</a></li> |
| <li><a href="../../interfaces.html">Interfaces</a></li> |
| <li><a href="../../traits.html">Traits</a></li> |
| <li><a href="../../doc-index.html">Index</a></li> |
| |
| </ul> |
| |
| <div id="title">PHP-FFMpeg API</div> |
| |
| <div class="type">Class</div> |
| <h1><a href="../../FFMpeg/Media.html">FFMpeg\Media</a>\Audio</h1> |
| </div> |
| <div class="content"> |
| <p> class |
| <strong>Audio</strong> extends <a href="../../FFMpeg/Media/AbstractStreamableMedia.html"><abbr title="FFMpeg\Media\AbstractStreamableMedia">AbstractStreamableMedia</abbr></a></p> |
| |
| |
| |
| |
| <h2>Methods</h2> |
| |
| <table> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method___construct">__construct</a>($pathfile, <a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> $driver, <a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe) |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method___construct"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getFFMpegDriver">getFFMpegDriver</a>() |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFFMpegDriver"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_setFFMpegDriver">setFFMpegDriver</a>(<a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> $driver) |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFFMpegDriver"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getFFProbe">getFFProbe</a>() |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFFProbe"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_setFFProbe">setFFProbe</a>(<a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe) |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFFProbe"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getPathfile">getPathfile</a>() |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getPathfile"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_setFiltersCollection">setFiltersCollection</a>(<a href="../../FFMpeg/Filters/FiltersCollection.html"><abbr title="FFMpeg\Filters\FiltersCollection">FiltersCollection</abbr></a> $filters) |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFiltersCollection"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getFiltersCollection">getFiltersCollection</a>() |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFiltersCollection"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/FFProbe/DataMapping/StreamCollection.html"><abbr title="FFMpeg\FFProbe\DataMapping\StreamCollection">StreamCollection</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getStreams">getStreams</a>() |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractStreamableMedia.html#method_getStreams"><abbr title="FFMpeg\Media\AbstractStreamableMedia">AbstractStreamableMedia</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/FFProbe/DataMapping/Stream.html"><abbr title="FFMpeg\FFProbe\DataMapping\Stream">Stream</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getFormat">getFormat</a>() |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractStreamableMedia.html#method_getFormat"><abbr title="FFMpeg\Media\AbstractStreamableMedia">AbstractStreamableMedia</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Filters/Audio/AudioFilters.html"><abbr title="FFMpeg\Filters\Audio\AudioFilters">AudioFilters</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_filters">filters</a>() |
| <p>Returns the available filters.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Media/Audio.html"><abbr title="FFMpeg\Media\Audio">Audio</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_addFilter">addFilter</a>(<a href="../../FFMpeg/Filters/FilterInterface.html"><abbr title="FFMpeg\Filters\FilterInterface">FilterInterface</abbr></a> $filter) |
| <p>{@inheritdoc}</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Media/Audio.html"><abbr title="FFMpeg\Media\Audio">Audio</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_save">save</a>(<a href="../../FFMpeg/Format/FormatInterface.html"><abbr title="FFMpeg\Format\FormatInterface">FormatInterface</abbr></a> $format, string $outputPathfile) |
| <p>Exports the audio in the desired format, applies registered filters.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Media/Waveform.html"><abbr title="FFMpeg\Media\Audio">Audio</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_waveform">waveform</a>(integer $width, integer $height) |
| <p>Generates an image file representing the waveform of the audio file.</p> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| <h2>Details</h2> |
| |
| <h3 id="method___construct"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method___construct"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 29</div> |
| <code> public |
| <strong>__construct</strong>($pathfile, <a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> $driver, <a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td></td> |
| <td>$pathfile</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a></td> |
| <td>$driver</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td>$ffprobe</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getFFMpegDriver"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFFMpegDriver"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 40</div> |
| <code> public <a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> |
| <strong>getFFMpegDriver</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setFFMpegDriver"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFFMpegDriver"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 50</div> |
| <code> public <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| <strong>setFFMpegDriver</strong>(<a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> $driver)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a></td> |
| <td>$driver</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getFFProbe"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFFProbe"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 60</div> |
| <code> public <a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> |
| <strong>getFFProbe</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setFFProbe"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFFProbe"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 70</div> |
| <code> public <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| <strong>setFFProbe</strong>(<a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td>$ffprobe</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getPathfile"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getPathfile"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 80</div> |
| <code> public string |
| <strong>getPathfile</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setFiltersCollection"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFiltersCollection"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 90</div> |
| <code> public <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| <strong>setFiltersCollection</strong>(<a href="../../FFMpeg/Filters/FiltersCollection.html"><abbr title="FFMpeg\Filters\FiltersCollection">FiltersCollection</abbr></a> $filters)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Filters/FiltersCollection.html"><abbr title="FFMpeg\Filters\FiltersCollection">FiltersCollection</abbr></a></td> |
| <td>$filters</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getFiltersCollection"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFiltersCollection"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 100</div> |
| <code> public <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| <strong>getFiltersCollection</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getStreams"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractStreamableMedia.html#method_getStreams"><abbr title="FFMpeg\Media\AbstractStreamableMedia">AbstractStreamableMedia</abbr></a> at line 24</div> |
| <code> public <a href="../../FFMpeg/FFProbe/DataMapping/StreamCollection.html"><abbr title="FFMpeg\FFProbe\DataMapping\StreamCollection">StreamCollection</abbr></a> |
| <strong>getStreams</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/FFProbe/DataMapping/StreamCollection.html"><abbr title="FFMpeg\FFProbe\DataMapping\StreamCollection">StreamCollection</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getFormat"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractStreamableMedia.html#method_getFormat"><abbr title="FFMpeg\Media\AbstractStreamableMedia">AbstractStreamableMedia</abbr></a> at line 36</div> |
| <code> public <a href="../../FFMpeg/FFProbe/DataMapping/Stream.html"><abbr title="FFMpeg\FFProbe\DataMapping\Stream">Stream</abbr></a> |
| <strong>getFormat</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/FFProbe/DataMapping/Stream.html"><abbr title="FFMpeg\FFProbe\DataMapping\Stream">Stream</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_filters"> |
| <div class="location">at line 31</div> |
| <code> public <a href="../../FFMpeg/Filters/Audio/AudioFilters.html"><abbr title="FFMpeg\Filters\Audio\AudioFilters">AudioFilters</abbr></a> |
| <strong>filters</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the available filters.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Filters/Audio/AudioFilters.html"><abbr title="FFMpeg\Filters\Audio\AudioFilters">AudioFilters</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_addFilter"> |
| <div class="location">at line 41</div> |
| <code> public <a href="../../FFMpeg/Media/Audio.html"><abbr title="FFMpeg\Media\Audio">Audio</abbr></a> |
| <strong>addFilter</strong>(<a href="../../FFMpeg/Filters/FilterInterface.html"><abbr title="FFMpeg\Filters\FilterInterface">FilterInterface</abbr></a> $filter)</code> |
| </h3> |
| <div class="details"> |
| <p>{@inheritdoc}</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Filters/FilterInterface.html"><abbr title="FFMpeg\Filters\FilterInterface">FilterInterface</abbr></a></td> |
| <td>$filter</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Media/Audio.html"><abbr title="FFMpeg\Media\Audio">Audio</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_save"> |
| <div class="location">at line 62</div> |
| <code> public <a href="../../FFMpeg/Media/Audio.html"><abbr title="FFMpeg\Media\Audio">Audio</abbr></a> |
| <strong>save</strong>(<a href="../../FFMpeg/Format/FormatInterface.html"><abbr title="FFMpeg\Format\FormatInterface">FormatInterface</abbr></a> $format, string $outputPathfile)</code> |
| </h3> |
| <div class="details"> |
| <p>Exports the audio in the desired format, applies registered filters.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Format/FormatInterface.html"><abbr title="FFMpeg\Format\FormatInterface">FormatInterface</abbr></a></td> |
| <td>$format</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td>string</td> |
| <td>$outputPathfile</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Media/Audio.html"><abbr title="FFMpeg\Media\Audio">Audio</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/RuntimeException"><abbr title="RuntimeException">RuntimeException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_waveform"> |
| <div class="location">at line 113</div> |
| <code> public <a href="../../FFMpeg/Media/Waveform.html"><abbr title="FFMpeg\Media\Audio">Audio</abbr></a> |
| <strong>save</strong>(<a href="../../FFMpeg/Format/FormatInterface.html"><abbr title="FFMpeg\Format\FormatInterface">FormatInterface</abbr></a> $format, string $outputPathfile)</code> |
| </h3> |
| <div class="details"> |
| <p>Exports the audio in the desired format, applies registered filters.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Format/FormatInterface.html"><abbr title="FFMpeg\Format\FormatInterface">FormatInterface</abbr></a></td> |
| <td>$format</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td>string</td> |
| <td>$outputPathfile</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Media/Audio.html"><abbr title="FFMpeg\Media\Audio">Audio</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/RuntimeException"><abbr title="RuntimeException">RuntimeException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div id="footer"> |
| Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>. |
| </div> |
| </body> |
| </html> |
| /vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/Media/Frame.html |
|---|
| @@ -0,0 +1,621 @@ |
|---|
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="robots" content="index, follow, all" /> |
| <title>FFMpeg\Media\Frame | PHP-FFMpeg API</title> |
| <link rel="stylesheet" type="text/css" href="../../stylesheet.css"> |
| </head> |
| <body id="class"> |
| <div class="header"> |
| <ul> |
| <li><a href="../../classes.html">Classes</a></li> |
| <li><a href="../../namespaces.html">Namespaces</a></li> |
| <li><a href="../../interfaces.html">Interfaces</a></li> |
| <li><a href="../../traits.html">Traits</a></li> |
| <li><a href="../../doc-index.html">Index</a></li> |
| |
| </ul> |
| |
| <div id="title">PHP-FFMpeg API</div> |
| |
| <div class="type">Class</div> |
| <h1><a href="../../FFMpeg/Media.html">FFMpeg\Media</a>\Frame</h1> |
| </div> |
| <div class="content"> |
| <p> class |
| <strong>Frame</strong> extends <a href="../../FFMpeg/Media/AbstractMediaType.html"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></p> |
| |
| |
| |
| |
| <h2>Methods</h2> |
| |
| <table> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method___construct">__construct</a>(<a href="../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a> $video, <a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> $driver, <a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe, <a href="../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a> $timecode) |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getFFMpegDriver">getFFMpegDriver</a>() |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFFMpegDriver"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_setFFMpegDriver">setFFMpegDriver</a>(<a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> $driver) |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFFMpegDriver"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getFFProbe">getFFProbe</a>() |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFFProbe"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_setFFProbe">setFFProbe</a>(<a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe) |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFFProbe"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getPathfile">getPathfile</a>() |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getPathfile"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_setFiltersCollection">setFiltersCollection</a>(<a href="../../FFMpeg/Filters/FiltersCollection.html"><abbr title="FFMpeg\Filters\FiltersCollection">FiltersCollection</abbr></a> $filters) |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFiltersCollection"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getFiltersCollection">getFiltersCollection</a>() |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFiltersCollection"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getVideo">getVideo</a>() |
| <p>Returns the video related to the frame.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Filters/Frame/FrameFilters.html"><abbr title="FFMpeg\Filters\Frame\FrameFilters">FrameFilters</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_filters">filters</a>() |
| <p>Returns the available filters.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Media/Frame.html"><abbr title="FFMpeg\Media\Frame">Frame</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_addFilter">addFilter</a>(<a href="../../FFMpeg/Filters/Frame/FrameFilterInterface.html"><abbr title="FFMpeg\Filters\Frame\FrameFilterInterface">FrameFilterInterface</abbr></a> $filter) |
| <p>{@inheritdoc}</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getTimeCode">getTimeCode</a>() |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Media/Frame.html"><abbr title="FFMpeg\Media\Frame">Frame</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_save">save</a>(string $pathfile, Boolean $accurate = false) |
| <p>Saves the frame in the given filename.</p> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| <h2>Details</h2> |
| |
| <h3 id="method___construct"> |
| <div class="location">at line 29</div> |
| <code> public |
| <strong>__construct</strong>(<a href="../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a> $video, <a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> $driver, <a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe, <a href="../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a> $timecode)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a></td> |
| <td>$video</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a></td> |
| <td>$driver</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td>$ffprobe</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a></td> |
| <td>$timecode</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getFFMpegDriver"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFFMpegDriver"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 40</div> |
| <code> public <a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> |
| <strong>getFFMpegDriver</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setFFMpegDriver"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFFMpegDriver"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 50</div> |
| <code> public <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| <strong>setFFMpegDriver</strong>(<a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> $driver)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a></td> |
| <td>$driver</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getFFProbe"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFFProbe"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 60</div> |
| <code> public <a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> |
| <strong>getFFProbe</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setFFProbe"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFFProbe"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 70</div> |
| <code> public <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| <strong>setFFProbe</strong>(<a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td>$ffprobe</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getPathfile"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getPathfile"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 80</div> |
| <code> public string |
| <strong>getPathfile</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setFiltersCollection"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFiltersCollection"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 90</div> |
| <code> public <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| <strong>setFiltersCollection</strong>(<a href="../../FFMpeg/Filters/FiltersCollection.html"><abbr title="FFMpeg\Filters\FiltersCollection">FiltersCollection</abbr></a> $filters)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Filters/FiltersCollection.html"><abbr title="FFMpeg\Filters\FiltersCollection">FiltersCollection</abbr></a></td> |
| <td>$filters</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getFiltersCollection"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFiltersCollection"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 100</div> |
| <code> public <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| <strong>getFiltersCollection</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getVideo"> |
| <div class="location">at line 41</div> |
| <code> public <a href="../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a> |
| <strong>getVideo</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the video related to the frame.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_filters"> |
| <div class="location">at line 51</div> |
| <code> public <a href="../../FFMpeg/Filters/Frame/FrameFilters.html"><abbr title="FFMpeg\Filters\Frame\FrameFilters">FrameFilters</abbr></a> |
| <strong>filters</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the available filters.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Filters/Frame/FrameFilters.html"><abbr title="FFMpeg\Filters\Frame\FrameFilters">FrameFilters</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_addFilter"> |
| <div class="location">at line 61</div> |
| <code> public <a href="../../FFMpeg/Media/Frame.html"><abbr title="FFMpeg\Media\Frame">Frame</abbr></a> |
| <strong>addFilter</strong>(<a href="../../FFMpeg/Filters/Frame/FrameFilterInterface.html"><abbr title="FFMpeg\Filters\Frame\FrameFilterInterface">FrameFilterInterface</abbr></a> $filter)</code> |
| </h3> |
| <div class="details"> |
| <p>{@inheritdoc}</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Filters/Frame/FrameFilterInterface.html"><abbr title="FFMpeg\Filters\Frame\FrameFilterInterface">FrameFilterInterface</abbr></a></td> |
| <td>$filter</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Media/Frame.html"><abbr title="FFMpeg\Media\Frame">Frame</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getTimeCode"> |
| <div class="location">at line 71</div> |
| <code> public <a href="../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a> |
| <strong>getTimeCode</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_save"> |
| <div class="location">at line 88</div> |
| <code> public <a href="../../FFMpeg/Media/Frame.html"><abbr title="FFMpeg\Media\Frame">Frame</abbr></a> |
| <strong>save</strong>(string $pathfile, Boolean $accurate = false)</code> |
| </h3> |
| <div class="details"> |
| <p>Saves the frame in the given filename.</p> |
| <p>Uses the <code>unaccurate method by default.</code></p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td>$pathfile</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td>Boolean</td> |
| <td>$accurate</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Media/Frame.html"><abbr title="FFMpeg\Media\Frame">Frame</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/RuntimeException"><abbr title="RuntimeException">RuntimeException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div id="footer"> |
| Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>. |
| </div> |
| </body> |
| </html> |
| /vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/Media/Video.html |
|---|
| @@ -0,0 +1,665 @@ |
|---|
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="robots" content="index, follow, all" /> |
| <title>FFMpeg\Media\Video | PHP-FFMpeg API</title> |
| <link rel="stylesheet" type="text/css" href="../../stylesheet.css"> |
| </head> |
| <body id="class"> |
| <div class="header"> |
| <ul> |
| <li><a href="../../classes.html">Classes</a></li> |
| <li><a href="../../namespaces.html">Namespaces</a></li> |
| <li><a href="../../interfaces.html">Interfaces</a></li> |
| <li><a href="../../traits.html">Traits</a></li> |
| <li><a href="../../doc-index.html">Index</a></li> |
| |
| </ul> |
| |
| <div id="title">PHP-FFMpeg API</div> |
| |
| <div class="type">Class</div> |
| <h1><a href="../../FFMpeg/Media.html">FFMpeg\Media</a>\Video</h1> |
| </div> |
| <div class="content"> |
| <p> class |
| <strong>Video</strong> extends <a href="../../FFMpeg/Media/Audio.html"><abbr title="FFMpeg\Media\Audio">Audio</abbr></a></p> |
| |
| |
| |
| |
| <h2>Methods</h2> |
| |
| <table> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method___construct">__construct</a>($pathfile, <a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> $driver, <a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe) |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method___construct"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getFFMpegDriver">getFFMpegDriver</a>() |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFFMpegDriver"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_setFFMpegDriver">setFFMpegDriver</a>(<a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> $driver) |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFFMpegDriver"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getFFProbe">getFFProbe</a>() |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFFProbe"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_setFFProbe">setFFProbe</a>(<a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe) |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFFProbe"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getPathfile">getPathfile</a>() |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getPathfile"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_setFiltersCollection">setFiltersCollection</a>(<a href="../../FFMpeg/Filters/FiltersCollection.html"><abbr title="FFMpeg\Filters\FiltersCollection">FiltersCollection</abbr></a> $filters) |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFiltersCollection"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getFiltersCollection">getFiltersCollection</a>() |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFiltersCollection"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/FFProbe/DataMapping/StreamCollection.html"><abbr title="FFMpeg\FFProbe\DataMapping\StreamCollection">StreamCollection</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getStreams">getStreams</a>() |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractStreamableMedia.html#method_getStreams"><abbr title="FFMpeg\Media\AbstractStreamableMedia">AbstractStreamableMedia</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/FFProbe/DataMapping/Stream.html"><abbr title="FFMpeg\FFProbe\DataMapping\Stream">Stream</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getFormat">getFormat</a>() |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractStreamableMedia.html#method_getFormat"><abbr title="FFMpeg\Media\AbstractStreamableMedia">AbstractStreamableMedia</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Filters/Video/VideoFilters.html"><abbr title="FFMpeg\Filters\Video\VideoFilters">VideoFilters</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_filters">filters</a>() |
| <p>Returns the available filters.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_addFilter">addFilter</a>(<a href="../../FFMpeg/Filters/FilterInterface.html"><abbr title="FFMpeg\Filters\FilterInterface">FilterInterface</abbr></a> $filter) |
| <p>{@inheritdoc}</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_save">save</a>(<a href="../../FFMpeg/Format/FormatInterface.html"><abbr title="FFMpeg\Format\FormatInterface">FormatInterface</abbr></a> $format, string $outputPathfile) |
| <p>Exports the video in the desired format, applies registered filters.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Media/Frame.html"><abbr title="FFMpeg\Media\Frame">Frame</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_frame">frame</a>(<a href="../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a> $at) |
| <p>Gets the frame at timecode.</p> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| <h2>Details</h2> |
| |
| <h3 id="method___construct"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method___construct"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 29</div> |
| <code> public |
| <strong>__construct</strong>($pathfile, <a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> $driver, <a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td></td> |
| <td>$pathfile</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a></td> |
| <td>$driver</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td>$ffprobe</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getFFMpegDriver"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFFMpegDriver"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 40</div> |
| <code> public <a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> |
| <strong>getFFMpegDriver</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setFFMpegDriver"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFFMpegDriver"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 50</div> |
| <code> public <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| <strong>setFFMpegDriver</strong>(<a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> $driver)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a></td> |
| <td>$driver</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getFFProbe"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFFProbe"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 60</div> |
| <code> public <a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> |
| <strong>getFFProbe</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setFFProbe"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFFProbe"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 70</div> |
| <code> public <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| <strong>setFFProbe</strong>(<a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td>$ffprobe</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getPathfile"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getPathfile"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 80</div> |
| <code> public string |
| <strong>getPathfile</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setFiltersCollection"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFiltersCollection"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 90</div> |
| <code> public <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| <strong>setFiltersCollection</strong>(<a href="../../FFMpeg/Filters/FiltersCollection.html"><abbr title="FFMpeg\Filters\FiltersCollection">FiltersCollection</abbr></a> $filters)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Filters/FiltersCollection.html"><abbr title="FFMpeg\Filters\FiltersCollection">FiltersCollection</abbr></a></td> |
| <td>$filters</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getFiltersCollection"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFiltersCollection"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 100</div> |
| <code> public <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| <strong>getFiltersCollection</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getStreams"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractStreamableMedia.html#method_getStreams"><abbr title="FFMpeg\Media\AbstractStreamableMedia">AbstractStreamableMedia</abbr></a> at line 24</div> |
| <code> public <a href="../../FFMpeg/FFProbe/DataMapping/StreamCollection.html"><abbr title="FFMpeg\FFProbe\DataMapping\StreamCollection">StreamCollection</abbr></a> |
| <strong>getStreams</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/FFProbe/DataMapping/StreamCollection.html"><abbr title="FFMpeg\FFProbe\DataMapping\StreamCollection">StreamCollection</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getFormat"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractStreamableMedia.html#method_getFormat"><abbr title="FFMpeg\Media\AbstractStreamableMedia">AbstractStreamableMedia</abbr></a> at line 36</div> |
| <code> public <a href="../../FFMpeg/FFProbe/DataMapping/Stream.html"><abbr title="FFMpeg\FFProbe\DataMapping\Stream">Stream</abbr></a> |
| <strong>getFormat</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/FFProbe/DataMapping/Stream.html"><abbr title="FFMpeg\FFProbe\DataMapping\Stream">Stream</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_filters"> |
| <div class="location">at line 34</div> |
| <code> public <a href="../../FFMpeg/Filters/Video/VideoFilters.html"><abbr title="FFMpeg\Filters\Video\VideoFilters">VideoFilters</abbr></a> |
| <strong>filters</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the available filters.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Filters/Video/VideoFilters.html"><abbr title="FFMpeg\Filters\Video\VideoFilters">VideoFilters</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_addFilter"> |
| <div class="location">at line 44</div> |
| <code> public <a href="../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a> |
| <strong>addFilter</strong>(<a href="../../FFMpeg/Filters/FilterInterface.html"><abbr title="FFMpeg\Filters\FilterInterface">FilterInterface</abbr></a> $filter)</code> |
| </h3> |
| <div class="details"> |
| <p>{@inheritdoc}</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Filters/FilterInterface.html"><abbr title="FFMpeg\Filters\FilterInterface">FilterInterface</abbr></a></td> |
| <td>$filter</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_save"> |
| <div class="location">at line 61</div> |
| <code> public <a href="../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a> |
| <strong>save</strong>(<a href="../../FFMpeg/Format/FormatInterface.html"><abbr title="FFMpeg\Format\FormatInterface">FormatInterface</abbr></a> $format, string $outputPathfile)</code> |
| </h3> |
| <div class="details"> |
| <p>Exports the video in the desired format, applies registered filters.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Format/FormatInterface.html"><abbr title="FFMpeg\Format\FormatInterface">FormatInterface</abbr></a></td> |
| <td>$format</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td>string</td> |
| <td>$outputPathfile</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/RuntimeException"><abbr title="RuntimeException">RuntimeException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_frame"> |
| <div class="location">at line 180</div> |
| <code> public <a href="../../FFMpeg/Media/Frame.html"><abbr title="FFMpeg\Media\Frame">Frame</abbr></a> |
| <strong>frame</strong>(<a href="../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a> $at)</code> |
| </h3> |
| <div class="details"> |
| <p>Gets the frame at timecode.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a></td> |
| <td>$at</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Media/Frame.html"><abbr title="FFMpeg\Media\Frame">Frame</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div id="footer"> |
| Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>. |
| </div> |
| </body> |
| </html> |
| /vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/Media/Waveform.html |
|---|
| @@ -0,0 +1,621 @@ |
|---|
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="robots" content="index, follow, all" /> |
| <title>FFMpeg\Media\Frame | PHP-FFMpeg API</title> |
| <link rel="stylesheet" type="text/css" href="../../stylesheet.css"> |
| </head> |
| <body id="class"> |
| <div class="header"> |
| <ul> |
| <li><a href="../../classes.html">Classes</a></li> |
| <li><a href="../../namespaces.html">Namespaces</a></li> |
| <li><a href="../../interfaces.html">Interfaces</a></li> |
| <li><a href="../../traits.html">Traits</a></li> |
| <li><a href="../../doc-index.html">Index</a></li> |
| |
| </ul> |
| |
| <div id="title">PHP-FFMpeg API</div> |
| |
| <div class="type">Class</div> |
| <h1><a href="../../FFMpeg/Media.html">FFMpeg\Media</a>\Frame</h1> |
| </div> |
| <div class="content"> |
| <p> class |
| <strong>Frame</strong> extends <a href="../../FFMpeg/Media/AbstractMediaType.html"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></p> |
| |
| |
| |
| |
| <h2>Methods</h2> |
| |
| <table> |
| <tr> |
| <td class="type"> |
| |
| </td> |
| <td class="last"> |
| <a href="#method___construct">__construct</a>(<a href="../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a> $video, <a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> $driver, <a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe, <a href="../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a> $timecode) |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getFFMpegDriver">getFFMpegDriver</a>() |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFFMpegDriver"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_setFFMpegDriver">setFFMpegDriver</a>(<a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> $driver) |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFFMpegDriver"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getFFProbe">getFFProbe</a>() |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFFProbe"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_setFFProbe">setFFProbe</a>(<a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe) |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFFProbe"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| string |
| </td> |
| <td class="last"> |
| <a href="#method_getPathfile">getPathfile</a>() |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getPathfile"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_setFiltersCollection">setFiltersCollection</a>(<a href="../../FFMpeg/Filters/FiltersCollection.html"><abbr title="FFMpeg\Filters\FiltersCollection">FiltersCollection</abbr></a> $filters) |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFiltersCollection"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getFiltersCollection">getFiltersCollection</a>() |
| <p> |
| </p> |
| </td> |
| <td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFiltersCollection"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getVideo">getVideo</a>() |
| <p>Returns the video related to the frame.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Filters/Frame/FrameFilters.html"><abbr title="FFMpeg\Filters\Frame\FrameFilters">FrameFilters</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_filters">filters</a>() |
| <p>Returns the available filters.</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Media/Frame.html"><abbr title="FFMpeg\Media\Frame">Frame</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_addFilter">addFilter</a>(<a href="../../FFMpeg/Filters/Frame/FrameFilterInterface.html"><abbr title="FFMpeg\Filters\Frame\FrameFilterInterface">FrameFilterInterface</abbr></a> $filter) |
| <p>{@inheritdoc}</p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_getTimeCode">getTimeCode</a>() |
| <p> |
| </p> |
| </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> |
| <a href="../../FFMpeg/Media/Frame.html"><abbr title="FFMpeg\Media\Frame">Frame</abbr></a> |
| </td> |
| <td class="last"> |
| <a href="#method_save">save</a>(string $pathfile, Boolean $accurate = false) |
| <p>Saves the frame in the given filename.</p> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| <h2>Details</h2> |
| |
| <h3 id="method___construct"> |
| <div class="location">at line 29</div> |
| <code> public |
| <strong>__construct</strong>(<a href="../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a> $video, <a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> $driver, <a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe, <a href="../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a> $timecode)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a></td> |
| <td>$video</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a></td> |
| <td>$driver</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td>$ffprobe</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a></td> |
| <td>$timecode</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getFFMpegDriver"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFFMpegDriver"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 40</div> |
| <code> public <a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> |
| <strong>getFFMpegDriver</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setFFMpegDriver"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFFMpegDriver"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 50</div> |
| <code> public <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| <strong>setFFMpegDriver</strong>(<a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> $driver)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a></td> |
| <td>$driver</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getFFProbe"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFFProbe"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 60</div> |
| <code> public <a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> |
| <strong>getFFProbe</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setFFProbe"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFFProbe"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 70</div> |
| <code> public <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| <strong>setFFProbe</strong>(<a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
| <td>$ffprobe</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getPathfile"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getPathfile"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 80</div> |
| <code> public string |
| <strong>getPathfile</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_setFiltersCollection"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFiltersCollection"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 90</div> |
| <code> public <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| <strong>setFiltersCollection</strong>(<a href="../../FFMpeg/Filters/FiltersCollection.html"><abbr title="FFMpeg\Filters\FiltersCollection">FiltersCollection</abbr></a> $filters)</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Filters/FiltersCollection.html"><abbr title="FFMpeg\Filters\FiltersCollection">FiltersCollection</abbr></a></td> |
| <td>$filters</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getFiltersCollection"> |
| <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFiltersCollection"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 100</div> |
| <code> public <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
| <strong>getFiltersCollection</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getVideo"> |
| <div class="location">at line 41</div> |
| <code> public <a href="../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a> |
| <strong>getVideo</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the video related to the frame.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_filters"> |
| <div class="location">at line 51</div> |
| <code> public <a href="../../FFMpeg/Filters/Frame/FrameFilters.html"><abbr title="FFMpeg\Filters\Frame\FrameFilters">FrameFilters</abbr></a> |
| <strong>filters</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p>Returns the available filters.</p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Filters/Frame/FrameFilters.html"><abbr title="FFMpeg\Filters\Frame\FrameFilters">FrameFilters</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_addFilter"> |
| <div class="location">at line 61</div> |
| <code> public <a href="../../FFMpeg/Media/Frame.html"><abbr title="FFMpeg\Media\Frame">Frame</abbr></a> |
| <strong>addFilter</strong>(<a href="../../FFMpeg/Filters/Frame/FrameFilterInterface.html"><abbr title="FFMpeg\Filters\Frame\FrameFilterInterface">FrameFilterInterface</abbr></a> $filter)</code> |
| </h3> |
| <div class="details"> |
| <p>{@inheritdoc}</p> |
| <p> |
| </p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Filters/Frame/FrameFilterInterface.html"><abbr title="FFMpeg\Filters\Frame\FrameFilterInterface">FrameFilterInterface</abbr></a></td> |
| <td>$filter</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Media/Frame.html"><abbr title="FFMpeg\Media\Frame">Frame</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_getTimeCode"> |
| <div class="location">at line 71</div> |
| <code> public <a href="../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a> |
| <strong>getTimeCode</strong>()</code> |
| </h3> |
| <div class="details"> |
| <p> |
| </p> |
| <p> |
| </p> |
| <div class="tags"> |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| </div> |
| |
| <h3 id="method_save"> |
| <div class="location">at line 88</div> |
| <code> public <a href="../../FFMpeg/Media/Frame.html"><abbr title="FFMpeg\Media\Frame">Frame</abbr></a> |
| <strong>save</strong>(string $pathfile, Boolean $accurate = false)</code> |
| </h3> |
| <div class="details"> |
| <p>Saves the frame in the given filename.</p> |
| <p>Uses the <code>unaccurate method by default.</code></p> |
| <div class="tags"> |
| <h4>Parameters</h4> |
| |
| <table> |
| <tr> |
| <td>string</td> |
| <td>$pathfile</td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td>Boolean</td> |
| <td>$accurate</td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Return Value</h4> |
| |
| <table> |
| <tr> |
| <td><a href="../../FFMpeg/Media/Frame.html"><abbr title="FFMpeg\Media\Frame">Frame</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| <h4>Exceptions</h4> |
| |
| <table> |
| <tr> |
| <td><a href="http://php.net/RuntimeException"><abbr title="RuntimeException">RuntimeException</abbr></a></td> |
| <td> |
| </td> |
| </tr> |
| </table> |
| |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div id="footer"> |
| Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>. |
| </div> |
| </body> |
| </html> |
