/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> |