Add Sami API

This commit is contained in:
Romain Neutron 2012-05-29 20:49:34 +02:00
commit 557c0bc1c7
60 changed files with 8724 additions and 0 deletions

View file

@ -0,0 +1,147 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>FFMpeg\Format\AdvancedAudio | 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="../../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>\AdvancedAudio</h1>
</div>
<div class="content">
<p>interface <strong>AdvancedAudio</strong> implements
<a href="../../FFMpeg/Format/Audio.html"><abbr title="FFMpeg\Format\Audio">Audio</abbr></a></p>
<h2>Methods</h2>
<table>
<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&nbsp;<a href="../../FFMpeg/Format/Audio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\Audio">Audio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
integer
</td>
<td class="last">
<a href="#method_getKiloBitrate">getKiloBitrate</a>()
<p>Get the kiloBitrate value</p>
</td>
<td><small>from&nbsp;<a href="../../FFMpeg/Format/Audio.html#method_getKiloBitrate"><abbr title="FFMpeg\Format\Audio">Audio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
integer
</td>
<td class="last">
<a href="#method_getAudioSampleRate">getAudioSampleRate</a>()
<p>Get the audio sample rate</p>
</td>
<td></td>
</tr>
</table>
<h2>Details</h2>
<h3 id="method_getAudioCodec">
<div class="location">in <a href="../../FFMpeg/Format/Audio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\Audio">Audio</abbr></a> at line 22</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_getKiloBitrate">
<div class="location">in <a href="../../FFMpeg/Format/Audio.html#method_getKiloBitrate"><abbr title="FFMpeg\Format\Audio">Audio</abbr></a> at line 29</div>
<code> public integer
<strong>getKiloBitrate</strong>()</code>
</h3>
<div class="details">
<p>Get 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_getAudioSampleRate">
<div class="location">at line 25</div>
<code> public integer
<strong>getAudioSampleRate</strong>()</code>
</h3>
<div class="details">
<p>Get the audio sample rate</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>

View file

@ -0,0 +1,268 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>FFMpeg\Format\AdvancedVideo | 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="../../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>\AdvancedVideo</h1>
</div>
<div class="content">
<p>interface <strong>AdvancedVideo</strong> implements
<a href="../../FFMpeg/Format/Video.html"><abbr title="FFMpeg\Format\Video">Video</abbr></a></p>
<h2>Constants</h2>
<table>
<tr>
<td>RESIZEMODE_FIT</td>
<td class="last">
<p><em></em></p>
<p></p>
</td>
</tr>
<tr>
<td>RESIZEMODE_INSET</td>
<td class="last">
<p><em></em></p>
<p></p>
</td>
</tr>
</table>
<h2>Methods</h2>
<table>
<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&nbsp;<a href="../../FFMpeg/Format/Video.html#method_getVideoCodec"><abbr title="FFMpeg\Format\Video">Video</abbr></a></small></td>
</tr>
<tr>
<td class="type">
integer
</td>
<td class="last">
<a href="#method_getWidth">getWidth</a>()
<p>Returns the width</p>
</td>
<td></td>
</tr>
<tr>
<td class="type">
integer
</td>
<td class="last">
<a href="#method_getHeight">getHeight</a>()
<p>Returns the height</p>
</td>
<td></td>
</tr>
<tr>
<td class="type">
string
</td>
<td class="last">
<a href="#method_getResizeMode">getResizeMode</a>()
<p>Get the current resize mode</p>
</td>
<td></td>
</tr>
<tr>
<td class="type">
integer
</td>
<td class="last">
<a href="#method_getFrameRate">getFrameRate</a>()
<p>Returns the frame rate</p>
</td>
<td></td>
</tr>
<tr>
<td class="type">
integer
</td>
<td class="last">
<a href="#method_getGOPSize">getGOPSize</a>()
<p>Returns the GOP size</p>
</td>
<td></td>
</tr>
</table>
<h2>Details</h2>
<h3 id="method_getVideoCodec">
<div class="location">in <a href="../../FFMpeg/Format/Video.html#method_getVideoCodec"><abbr title="FFMpeg\Format\Video">Video</abbr></a> at line 25</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_getWidth">
<div class="location">at line 27</div>
<code> public integer
<strong>getWidth</strong>()</code>
</h3>
<div class="details">
<p>Returns the width</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>integer</td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_getHeight">
<div class="location">at line 34</div>
<code> public integer
<strong>getHeight</strong>()</code>
</h3>
<div class="details">
<p>Returns the height</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>integer</td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_getResizeMode">
<div class="location">at line 41</div>
<code> public string
<strong>getResizeMode</strong>()</code>
</h3>
<div class="details">
<p>Get the current resize mode</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>string</td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_getFrameRate">
<div class="location">at line 48</div>
<code> public integer
<strong>getFrameRate</strong>()</code>
</h3>
<div class="details">
<p>Returns the frame rate</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>integer</td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_getGOPSize">
<div class="location">at line 55</div>
<code> public integer
<strong>getGOPSize</strong>()</code>
</h3>
<div class="details">
<p>Returns the GOP size</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>integer</td>
<td></td>
</tr>
</table>
</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>

112
docs/build/API/FFMpeg/Format/Audio.html vendored Normal file
View file

@ -0,0 +1,112 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>FFMpeg\Format\Audio | PHP FFMpeg API</title>
<link rel="stylesheet" type="text/css" href="../../stylesheet.css">
</head>
<body id="class">
<div class="header">
<ul>
<li><a href="../../classes.html">Classes</a></li>
<li><a href="../../namespaces.html">Namespaces</a></li>
<li><a href="../../interfaces.html">Interfaces</a></li>
<li><a href="../../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>\Audio</h1>
</div>
<div class="content">
<p>interface <strong>Audio</strong></p>
<h2>Methods</h2>
<table>
<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">
integer
</td>
<td class="last">
<a href="#method_getKiloBitrate">getKiloBitrate</a>()
<p>Get the kiloBitrate value</p>
</td>
<td></td>
</tr>
</table>
<h2>Details</h2>
<h3 id="method_getAudioCodec">
<div class="location">at line 22</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_getKiloBitrate">
<div class="location">at line 29</div>
<code> public integer
<strong>getKiloBitrate</strong>()</code>
</h3>
<div class="details">
<p>Get the kiloBitrate value</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>

View file

@ -0,0 +1,323 @@
<!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="../../../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/DefaultAudio.html"><abbr title="FFMpeg\Format\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">
string
</td>
<td class="last">
<a href="#method_getExtraParams">getExtraParams</a>()
<p>Returns extra parameters for the encoding</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultAudio.html#method_getExtraParams"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_getAudioCodec">getAudioCodec</a>()
<p>{@inheritdoc}</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultAudio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setAudioCodec">setAudioCodec</a>(string $audioCodec)
<p>Set the audio codec, Should be in the available ones, otherwise an exception is thrown</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultAudio.html#method_setAudioCodec"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
integer
</td>
<td class="last">
<a href="#method_getAudioSampleRate">getAudioSampleRate</a>()
<p>Get the audio sample rate</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultAudio.html#method_getAudioSampleRate"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setAudioSampleRate">setAudioSampleRate</a>(integer $audioSampleRate)
<p>Set the audio sample rate</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultAudio.html#method_setAudioSampleRate"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_getKiloBitrate">getKiloBitrate</a>()
<p>{@inheritdoc}</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultAudio.html#method_getKiloBitrate"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setKiloBitrate">setKiloBitrate</a>(int $kiloBitrate)
<p>Set the kiloBitrate value</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultAudio.html#method_setKiloBitrate"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_getAvailableAudioCodecs">getAvailableAudioCodecs</a>()
<p>{@inheritDoc}</p>
</td>
<td></td>
</tr>
</table>
<h2>Details</h2>
<h3 id="method_getExtraParams">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultAudio.html#method_getExtraParams"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a> at line 32</div>
<code> public string
<strong>getExtraParams</strong>()</code>
</h3>
<div class="details">
<p>Returns extra parameters for the encoding</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>string</td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_getAudioCodec">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultAudio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a> at line 40</div>
<code> public
<strong>getAudioCodec</strong>()</code>
</h3>
<div class="details">
<p>{@inheritdoc}</p>
<p></p>
<div class="tags">
</div>
</div>
<h3 id="method_setAudioCodec">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultAudio.html#method_setAudioCodec"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a> at line 52</div>
<code> public
<strong>setAudioCodec</strong>(string $audioCodec)</code>
</h3>
<div class="details">
<p>Set 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_getAudioSampleRate">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultAudio.html#method_getAudioSampleRate"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a> at line 69</div>
<code> public integer
<strong>getAudioSampleRate</strong>()</code>
</h3>
<div class="details">
<p>Get the audio sample rate</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>integer</td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_setAudioSampleRate">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultAudio.html#method_setAudioSampleRate"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a> at line 80</div>
<code> public
<strong>setAudioSampleRate</strong>(integer $audioSampleRate)</code>
</h3>
<div class="details">
<p>Set the audio sample rate</p>
<p></p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td>integer</td>
<td>$audioSampleRate</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_getKiloBitrate">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultAudio.html#method_getKiloBitrate"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a> at line 94</div>
<code> public
<strong>getKiloBitrate</strong>()</code>
</h3>
<div class="details">
<p>{@inheritdoc}</p>
<p></p>
<div class="tags">
</div>
</div>
<h3 id="method_setKiloBitrate">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultAudio.html#method_setKiloBitrate"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a> at line 105</div>
<code> public
<strong>setKiloBitrate</strong>(int $kiloBitrate)</code>
</h3>
<div class="details">
<p>Set the kiloBitrate value</p>
<p></p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td>int</td>
<td>$kiloBitrate</td>
<td>integer $kiloBitrate</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_getAvailableAudioCodecs">
<div class="location">at line 28</div>
<code> public
<strong>getAvailableAudioCodecs</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>

View file

@ -0,0 +1,323 @@
<!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="../../../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/DefaultAudio.html"><abbr title="FFMpeg\Format\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">
string
</td>
<td class="last">
<a href="#method_getExtraParams">getExtraParams</a>()
<p>Returns extra parameters for the encoding</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultAudio.html#method_getExtraParams"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_getAudioCodec">getAudioCodec</a>()
<p>{@inheritdoc}</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultAudio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setAudioCodec">setAudioCodec</a>(string $audioCodec)
<p>Set the audio codec, Should be in the available ones, otherwise an exception is thrown</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultAudio.html#method_setAudioCodec"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
integer
</td>
<td class="last">
<a href="#method_getAudioSampleRate">getAudioSampleRate</a>()
<p>Get the audio sample rate</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultAudio.html#method_getAudioSampleRate"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setAudioSampleRate">setAudioSampleRate</a>(integer $audioSampleRate)
<p>Set the audio sample rate</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultAudio.html#method_setAudioSampleRate"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_getKiloBitrate">getKiloBitrate</a>()
<p>{@inheritdoc}</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultAudio.html#method_getKiloBitrate"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setKiloBitrate">setKiloBitrate</a>(int $kiloBitrate)
<p>Set the kiloBitrate value</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultAudio.html#method_setKiloBitrate"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_getAvailableAudioCodecs">getAvailableAudioCodecs</a>()
<p>{@inheritDoc}</p>
</td>
<td></td>
</tr>
</table>
<h2>Details</h2>
<h3 id="method_getExtraParams">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultAudio.html#method_getExtraParams"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a> at line 32</div>
<code> public string
<strong>getExtraParams</strong>()</code>
</h3>
<div class="details">
<p>Returns extra parameters for the encoding</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>string</td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_getAudioCodec">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultAudio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a> at line 40</div>
<code> public
<strong>getAudioCodec</strong>()</code>
</h3>
<div class="details">
<p>{@inheritdoc}</p>
<p></p>
<div class="tags">
</div>
</div>
<h3 id="method_setAudioCodec">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultAudio.html#method_setAudioCodec"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a> at line 52</div>
<code> public
<strong>setAudioCodec</strong>(string $audioCodec)</code>
</h3>
<div class="details">
<p>Set 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_getAudioSampleRate">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultAudio.html#method_getAudioSampleRate"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a> at line 69</div>
<code> public integer
<strong>getAudioSampleRate</strong>()</code>
</h3>
<div class="details">
<p>Get the audio sample rate</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>integer</td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_setAudioSampleRate">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultAudio.html#method_setAudioSampleRate"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a> at line 80</div>
<code> public
<strong>setAudioSampleRate</strong>(integer $audioSampleRate)</code>
</h3>
<div class="details">
<p>Set the audio sample rate</p>
<p></p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td>integer</td>
<td>$audioSampleRate</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_getKiloBitrate">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultAudio.html#method_getKiloBitrate"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a> at line 94</div>
<code> public
<strong>getKiloBitrate</strong>()</code>
</h3>
<div class="details">
<p>{@inheritdoc}</p>
<p></p>
<div class="tags">
</div>
</div>
<h3 id="method_setKiloBitrate">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultAudio.html#method_setKiloBitrate"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a> at line 105</div>
<code> public
<strong>setKiloBitrate</strong>(int $kiloBitrate)</code>
</h3>
<div class="details">
<p>Set the kiloBitrate value</p>
<p></p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td>int</td>
<td>$kiloBitrate</td>
<td>integer $kiloBitrate</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_getAvailableAudioCodecs">
<div class="location">at line 28</div>
<code> public
<strong>getAvailableAudioCodecs</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>

View file

@ -0,0 +1,9 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>FFMpeg\Format\Audio | PHP FFMpeg API</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
</head>
</html>

View file

@ -0,0 +1,299 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>FFMpeg\Format\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="../../doc-index.html">Index</a></li>
</ul>
<div id="title">PHP FFMpeg API</div>
<div class="type">Class</div>
<h1><a href="../../FFMpeg/Format.html">FFMpeg\Format</a>\DefaultAudio</h1>
</div>
<div class="content">
<p>abstract class <strong>DefaultAudio</strong> implements
<a href="../../FFMpeg/Format/AdvancedAudio.html"><abbr title="FFMpeg\Format\AdvancedAudio">AdvancedAudio</abbr></a>, <a href="../../FFMpeg/Format/InteractiveAudio.html"><abbr title="FFMpeg\Format\InteractiveAudio">InteractiveAudio</abbr></a></p>
<div class="description">
<p>The abstract default Audio format</p>
<p></p>
</div>
<h2>Methods</h2>
<table>
<tr>
<td class="type">
string
</td>
<td class="last">
<a href="#method_getExtraParams">getExtraParams</a>()
<p>Returns extra parameters for the encoding</p>
</td>
<td></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_getAudioCodec">getAudioCodec</a>()
<p>{@inheritdoc}</p>
</td>
<td></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setAudioCodec">setAudioCodec</a>(string $audioCodec)
<p>Set 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_getAudioSampleRate">getAudioSampleRate</a>()
<p>Get the audio sample rate</p>
</td>
<td></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setAudioSampleRate">setAudioSampleRate</a>(integer $audioSampleRate)
<p>Set the audio sample rate</p>
</td>
<td></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_getKiloBitrate">getKiloBitrate</a>()
<p>{@inheritdoc}</p>
</td>
<td></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setKiloBitrate">setKiloBitrate</a>(int $kiloBitrate)
<p>Set the kiloBitrate value</p>
</td>
<td></td>
</tr>
</table>
<h2>Details</h2>
<h3 id="method_getExtraParams">
<div class="location">at line 32</div>
<code> public string
<strong>getExtraParams</strong>()</code>
</h3>
<div class="details">
<p>Returns extra parameters for the encoding</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>string</td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_getAudioCodec">
<div class="location">at line 40</div>
<code> public
<strong>getAudioCodec</strong>()</code>
</h3>
<div class="details">
<p>{@inheritdoc}</p>
<p></p>
<div class="tags">
</div>
</div>
<h3 id="method_setAudioCodec">
<div class="location">at line 52</div>
<code> public
<strong>setAudioCodec</strong>(string $audioCodec)</code>
</h3>
<div class="details">
<p>Set 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_getAudioSampleRate">
<div class="location">at line 69</div>
<code> public integer
<strong>getAudioSampleRate</strong>()</code>
</h3>
<div class="details">
<p>Get the audio sample rate</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>integer</td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_setAudioSampleRate">
<div class="location">at line 80</div>
<code> public
<strong>setAudioSampleRate</strong>(integer $audioSampleRate)</code>
</h3>
<div class="details">
<p>Set the audio sample rate</p>
<p></p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td>integer</td>
<td>$audioSampleRate</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_getKiloBitrate">
<div class="location">at line 94</div>
<code> public
<strong>getKiloBitrate</strong>()</code>
</h3>
<div class="details">
<p>{@inheritdoc}</p>
<p></p>
<div class="tags">
</div>
</div>
<h3 id="method_setKiloBitrate">
<div class="location">at line 105</div>
<code> public
<strong>setKiloBitrate</strong>(int $kiloBitrate)</code>
</h3>
<div class="details">
<p>Set the kiloBitrate value</p>
<p></p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td>int</td>
<td>$kiloBitrate</td>
<td>integer $kiloBitrate</td>
</tr>
</table>
<h4>Exceptions</h4>
<table>
<tr>
<td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>.
</div>
</body>
</html>

View file

@ -0,0 +1,710 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>FFMpeg\Format\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="../../doc-index.html">Index</a></li>
</ul>
<div id="title">PHP FFMpeg API</div>
<div class="type">Class</div>
<h1><a href="../../FFMpeg/Format.html">FFMpeg\Format</a>\DefaultVideo</h1>
</div>
<div class="content">
<p>abstract class <strong>DefaultVideo</strong> extends <a href="../../FFMpeg/Format/DefaultAudio.html"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a> implements
<a href="../../FFMpeg/Format/InteractiveVideo.html"><abbr title="FFMpeg\Format\InteractiveVideo">InteractiveVideo</abbr></a>, <a href="../../FFMpeg/Format/AdvancedVideo.html"><abbr title="FFMpeg\Format\AdvancedVideo">AdvancedVideo</abbr></a></p>
<div class="description">
<p>The abstract default Video format</p>
<p></p>
</div>
<h2>Methods</h2>
<table>
<tr>
<td class="type">
string
</td>
<td class="last">
<a href="#method_getExtraParams">getExtraParams</a>()
<p>Returns extra parameters for the encoding</p>
</td>
<td><small>from&nbsp;<a href="../../FFMpeg/Format/DefaultAudio.html#method_getExtraParams"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_getAudioCodec">getAudioCodec</a>()
<p>{@inheritdoc}</p>
</td>
<td><small>from&nbsp;<a href="../../FFMpeg/Format/DefaultAudio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setAudioCodec">setAudioCodec</a>(string $audioCodec)
<p>Set the audio codec, Should be in the available ones, otherwise an exception is thrown</p>
</td>
<td><small>from&nbsp;<a href="../../FFMpeg/Format/DefaultAudio.html#method_setAudioCodec"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
integer
</td>
<td class="last">
<a href="#method_getAudioSampleRate">getAudioSampleRate</a>()
<p>Get the audio sample rate</p>
</td>
<td><small>from&nbsp;<a href="../../FFMpeg/Format/DefaultAudio.html#method_getAudioSampleRate"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setAudioSampleRate">setAudioSampleRate</a>(integer $audioSampleRate)
<p>Set the audio sample rate</p>
</td>
<td><small>from&nbsp;<a href="../../FFMpeg/Format/DefaultAudio.html#method_setAudioSampleRate"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_getKiloBitrate">getKiloBitrate</a>()
<p>{@inheritdoc}</p>
</td>
<td><small>from&nbsp;<a href="../../FFMpeg/Format/DefaultAudio.html#method_getKiloBitrate"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setKiloBitrate">setKiloBitrate</a>(int $kiloBitrate)
<p>Set the kiloBitrate value</p>
</td>
<td><small>from&nbsp;<a href="../../FFMpeg/Format/DefaultAudio.html#method_setKiloBitrate"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
integer
</td>
<td class="last">
<a href="#method_getWidth">getWidth</a>()
<p>Returns the width</p>
</td>
<td></td>
</tr>
<tr>
<td class="type">
integer
</td>
<td class="last">
<a href="#method_getHeight">getHeight</a>()
<p>Returns the height</p>
</td>
<td></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setDimensions">setDimensions</a>(integer $width, integer $height)
<p>Set the dimensions</p>
</td>
<td></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setResizeMode">setResizeMode</a>(string $mode)
<p>Set the resize mode</p>
</td>
<td></td>
</tr>
<tr>
<td class="type">
string
</td>
<td class="last">
<a href="#method_getResizeMode">getResizeMode</a>()
<p>Get the current resize mode</p>
</td>
<td></td>
</tr>
<tr>
<td class="type">
integer
</td>
<td class="last">
<a href="#method_getFrameRate">getFrameRate</a>()
<p>Returns the frame rate</p>
</td>
<td></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setFrameRate">setFrameRate</a>(integer $frameRate)
<p>Set the framerate</p>
</td>
<td></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_getVideoCodec">getVideoCodec</a>()
<p>{@inheritdoc}</p>
</td>
<td></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setVideoCodec">setVideoCodec</a>(string $videoCodec)
<p>Set the video codec, Should be in the available ones, otherwise an exception is thrown</p>
</td>
<td></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_getGOPsize">getGOPsize</a>()
<p>{@inheritdoc}</p>
</td>
<td></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setGOPsize">setGOPsize</a>(integer $GOPsize)
<p>Set the GOP size</p>
</td>
<td></td>
</tr>
</table>
<h2>Details</h2>
<h3 id="method_getExtraParams">
<div class="location">in <a href="../../FFMpeg/Format/DefaultAudio.html#method_getExtraParams"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a> at line 32</div>
<code> public string
<strong>getExtraParams</strong>()</code>
</h3>
<div class="details">
<p>Returns extra parameters for the encoding</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>string</td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_getAudioCodec">
<div class="location">in <a href="../../FFMpeg/Format/DefaultAudio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a> at line 40</div>
<code> public
<strong>getAudioCodec</strong>()</code>
</h3>
<div class="details">
<p>{@inheritdoc}</p>
<p></p>
<div class="tags">
</div>
</div>
<h3 id="method_setAudioCodec">
<div class="location">in <a href="../../FFMpeg/Format/DefaultAudio.html#method_setAudioCodec"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a> at line 52</div>
<code> public
<strong>setAudioCodec</strong>(string $audioCodec)</code>
</h3>
<div class="details">
<p>Set 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_getAudioSampleRate">
<div class="location">in <a href="../../FFMpeg/Format/DefaultAudio.html#method_getAudioSampleRate"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a> at line 69</div>
<code> public integer
<strong>getAudioSampleRate</strong>()</code>
</h3>
<div class="details">
<p>Get the audio sample rate</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>integer</td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_setAudioSampleRate">
<div class="location">in <a href="../../FFMpeg/Format/DefaultAudio.html#method_setAudioSampleRate"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a> at line 80</div>
<code> public
<strong>setAudioSampleRate</strong>(integer $audioSampleRate)</code>
</h3>
<div class="details">
<p>Set the audio sample rate</p>
<p></p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td>integer</td>
<td>$audioSampleRate</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_getKiloBitrate">
<div class="location">in <a href="../../FFMpeg/Format/DefaultAudio.html#method_getKiloBitrate"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a> at line 94</div>
<code> public
<strong>getKiloBitrate</strong>()</code>
</h3>
<div class="details">
<p>{@inheritdoc}</p>
<p></p>
<div class="tags">
</div>
</div>
<h3 id="method_setKiloBitrate">
<div class="location">in <a href="../../FFMpeg/Format/DefaultAudio.html#method_setKiloBitrate"><abbr title="FFMpeg\Format\DefaultAudio">DefaultAudio</abbr></a> at line 105</div>
<code> public
<strong>setKiloBitrate</strong>(int $kiloBitrate)</code>
</h3>
<div class="details">
<p>Set the kiloBitrate value</p>
<p></p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td>int</td>
<td>$kiloBitrate</td>
<td>integer $kiloBitrate</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_getWidth">
<div class="location">at line 35</div>
<code> public integer
<strong>getWidth</strong>()</code>
</h3>
<div class="details">
<p>Returns the width</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>integer</td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_getHeight">
<div class="location">at line 43</div>
<code> public integer
<strong>getHeight</strong>()</code>
</h3>
<div class="details">
<p>Returns the height</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>integer</td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_setDimensions">
<div class="location">at line 55</div>
<code> public
<strong>setDimensions</strong>(integer $width, integer $height)</code>
</h3>
<div class="details">
<p>Set the dimensions</p>
<p></p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td>integer</td>
<td>$width</td>
<td>The heigth</td>
</tr>
<tr>
<td>integer</td>
<td>$height</td>
<td>The width</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_setResizeMode">
<div class="location">at line 77</div>
<code> public
<strong>setResizeMode</strong>(string $mode)</code>
</h3>
<div class="details">
<p>Set the resize mode</p>
<p></p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td>string</td>
<td>$mode</td>
<td>The mode, one of the self::RESIZEMODE_* constants</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_getResizeMode">
<div class="location">at line 95</div>
<code> public string
<strong>getResizeMode</strong>()</code>
</h3>
<div class="details">
<p>Get the current resize mode</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>string</td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_getFrameRate">
<div class="location">at line 103</div>
<code> public integer
<strong>getFrameRate</strong>()</code>
</h3>
<div class="details">
<p>Returns the frame rate</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>integer</td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_setFrameRate">
<div class="location">at line 115</div>
<code> public
<strong>setFrameRate</strong>(integer $frameRate)</code>
</h3>
<div class="details">
<p>Set the framerate</p>
<p></p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td>integer</td>
<td>$frameRate</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 129</div>
<code> public
<strong>getVideoCodec</strong>()</code>
</h3>
<div class="details">
<p>{@inheritdoc}</p>
<p></p>
<div class="tags">
</div>
</div>
<h3 id="method_setVideoCodec">
<div class="location">at line 141</div>
<code> public
<strong>setVideoCodec</strong>(string $videoCodec)</code>
</h3>
<div class="details">
<p>Set 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_getGOPsize">
<div class="location">at line 158</div>
<code> public
<strong>getGOPsize</strong>()</code>
</h3>
<div class="details">
<p>{@inheritdoc}</p>
<p></p>
<div class="tags">
</div>
</div>
<h3 id="method_setGOPsize">
<div class="location">at line 170</div>
<code> public
<strong>setGOPsize</strong>(integer $GOPsize)</code>
</h3>
<div class="details">
<p>Set the GOP size</p>
<p></p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td>integer</td>
<td>$GOPsize</td>
<td></td>
</tr>
</table>
<h4>Exceptions</h4>
<table>
<tr>
<td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>.
</div>
</body>
</html>

View file

@ -0,0 +1,78 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>FFMpeg\Format\InteractiveAudio | 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="../../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>\InteractiveAudio</h1>
</div>
<div class="content">
<p>interface <strong>InteractiveAudio</strong></p>
<h2>Methods</h2>
<table>
<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_getAvailableAudioCodecs">
<div class="location">at line 22</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>

View file

@ -0,0 +1,78 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>FFMpeg\Format\InteractiveVideo | 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="../../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>\InteractiveVideo</h1>
</div>
<div class="content">
<p>interface <strong>InteractiveVideo</strong></p>
<h2>Methods</h2>
<table>
<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_getAvailableVideoCodecs">
<div class="location">at line 22</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>

147
docs/build/API/FFMpeg/Format/Video.html vendored Normal file
View file

@ -0,0 +1,147 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>FFMpeg\Format\Video | PHP FFMpeg API</title>
<link rel="stylesheet" type="text/css" href="../../stylesheet.css">
</head>
<body id="class">
<div class="header">
<ul>
<li><a href="../../classes.html">Classes</a></li>
<li><a href="../../namespaces.html">Namespaces</a></li>
<li><a href="../../interfaces.html">Interfaces</a></li>
<li><a href="../../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>\Video</h1>
</div>
<div class="content">
<p>interface <strong>Video</strong> implements
<a href="../../FFMpeg/Format/Audio.html"><abbr title="FFMpeg\Format\Audio">Audio</abbr></a></p>
<h2>Methods</h2>
<table>
<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&nbsp;<a href="../../FFMpeg/Format/Audio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\Audio">Audio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
integer
</td>
<td class="last">
<a href="#method_getKiloBitrate">getKiloBitrate</a>()
<p>Get the kiloBitrate value</p>
</td>
<td><small>from&nbsp;<a href="../../FFMpeg/Format/Audio.html#method_getKiloBitrate"><abbr title="FFMpeg\Format\Audio">Audio</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></td>
</tr>
</table>
<h2>Details</h2>
<h3 id="method_getAudioCodec">
<div class="location">in <a href="../../FFMpeg/Format/Audio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\Audio">Audio</abbr></a> at line 22</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_getKiloBitrate">
<div class="location">in <a href="../../FFMpeg/Format/Audio.html#method_getKiloBitrate"><abbr title="FFMpeg\Format\Audio">Audio</abbr></a> at line 29</div>
<code> public integer
<strong>getKiloBitrate</strong>()</code>
</h3>
<div class="details">
<p>Get 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_getVideoCodec">
<div class="location">at line 25</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>
</div>
<div id="footer">
Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>.
</div>
</body>
</html>

View file

@ -0,0 +1,509 @@
<!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="../../../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/DefaultVideo.html"><abbr title="FFMpeg\Format\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">
integer
</td>
<td class="last">
<a href="#method_getWidth">getWidth</a>()
<p>Returns the width</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultVideo.html#method_getWidth"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
</tr>
<tr>
<td class="type">
integer
</td>
<td class="last">
<a href="#method_getHeight">getHeight</a>()
<p>Returns the height</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultVideo.html#method_getHeight"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setDimensions">setDimensions</a>(integer $width, integer $height)
<p>Set the dimensions</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultVideo.html#method_setDimensions"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setResizeMode">setResizeMode</a>(string $mode)
<p>Set the resize mode</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultVideo.html#method_setResizeMode"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
</tr>
<tr>
<td class="type">
string
</td>
<td class="last">
<a href="#method_getResizeMode">getResizeMode</a>()
<p>Get the current resize mode</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultVideo.html#method_getResizeMode"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
</tr>
<tr>
<td class="type">
integer
</td>
<td class="last">
<a href="#method_getFrameRate">getFrameRate</a>()
<p>Returns the frame rate</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultVideo.html#method_getFrameRate"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setFrameRate">setFrameRate</a>(integer $frameRate)
<p>Set the framerate</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultVideo.html#method_setFrameRate"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_getVideoCodec">getVideoCodec</a>()
<p>{@inheritdoc}</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultVideo.html#method_getVideoCodec"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setVideoCodec">setVideoCodec</a>(string $videoCodec)
<p>Set the video codec, Should be in the available ones, otherwise an exception is thrown</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultVideo.html#method_setVideoCodec"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_getGOPsize">getGOPsize</a>()
<p>{@inheritdoc}</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultVideo.html#method_getGOPsize"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setGOPsize">setGOPsize</a>(integer $GOPsize)
<p>Set the GOP size</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultVideo.html#method_setGOPsize"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_getAvailableAudioCodecs">getAvailableAudioCodecs</a>()
<p>{@inheritDoc}</p>
</td>
<td></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_getAvailableVideoCodecs">getAvailableVideoCodecs</a>()
<p>{@inheritDoc}</p>
</td>
<td></td>
</tr>
</table>
<h2>Details</h2>
<h3 id="method_getWidth">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultVideo.html#method_getWidth"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 35</div>
<code> public integer
<strong>getWidth</strong>()</code>
</h3>
<div class="details">
<p>Returns the width</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>integer</td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_getHeight">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultVideo.html#method_getHeight"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 43</div>
<code> public integer
<strong>getHeight</strong>()</code>
</h3>
<div class="details">
<p>Returns the height</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>integer</td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_setDimensions">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultVideo.html#method_setDimensions"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 55</div>
<code> public
<strong>setDimensions</strong>(integer $width, integer $height)</code>
</h3>
<div class="details">
<p>Set the dimensions</p>
<p></p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td>integer</td>
<td>$width</td>
<td>The heigth</td>
</tr>
<tr>
<td>integer</td>
<td>$height</td>
<td>The width</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_setResizeMode">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultVideo.html#method_setResizeMode"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 77</div>
<code> public
<strong>setResizeMode</strong>(string $mode)</code>
</h3>
<div class="details">
<p>Set the resize mode</p>
<p></p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td>string</td>
<td>$mode</td>
<td>The mode, one of the self::RESIZEMODE_* constants</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_getResizeMode">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultVideo.html#method_getResizeMode"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 95</div>
<code> public string
<strong>getResizeMode</strong>()</code>
</h3>
<div class="details">
<p>Get the current resize mode</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>string</td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_getFrameRate">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultVideo.html#method_getFrameRate"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 103</div>
<code> public integer
<strong>getFrameRate</strong>()</code>
</h3>
<div class="details">
<p>Returns the frame rate</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>integer</td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_setFrameRate">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultVideo.html#method_setFrameRate"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 115</div>
<code> public
<strong>setFrameRate</strong>(integer $frameRate)</code>
</h3>
<div class="details">
<p>Set the framerate</p>
<p></p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td>integer</td>
<td>$frameRate</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/DefaultVideo.html#method_getVideoCodec"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 129</div>
<code> public
<strong>getVideoCodec</strong>()</code>
</h3>
<div class="details">
<p>{@inheritdoc}</p>
<p></p>
<div class="tags">
</div>
</div>
<h3 id="method_setVideoCodec">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultVideo.html#method_setVideoCodec"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 141</div>
<code> public
<strong>setVideoCodec</strong>(string $videoCodec)</code>
</h3>
<div class="details">
<p>Set 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_getGOPsize">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultVideo.html#method_getGOPsize"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 158</div>
<code> public
<strong>getGOPsize</strong>()</code>
</h3>
<div class="details">
<p>{@inheritdoc}</p>
<p></p>
<div class="tags">
</div>
</div>
<h3 id="method_setGOPsize">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultVideo.html#method_setGOPsize"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 170</div>
<code> public
<strong>setGOPsize</strong>(integer $GOPsize)</code>
</h3>
<div class="details">
<p>Set the GOP size</p>
<p></p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td>integer</td>
<td>$GOPsize</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_getAvailableAudioCodecs">
<div class="location">at line 29</div>
<code> public
<strong>getAvailableAudioCodecs</strong>()</code>
</h3>
<div class="details">
<p>{@inheritDoc}</p>
<p></p>
<div class="tags">
</div>
</div>
<h3 id="method_getAvailableVideoCodecs">
<div class="location">at line 37</div>
<code> public
<strong>getAvailableVideoCodecs</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>

View file

@ -0,0 +1,534 @@
<!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="../../../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/DefaultVideo.html"><abbr title="FFMpeg\Format\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">
integer
</td>
<td class="last">
<a href="#method_getWidth">getWidth</a>()
<p>Returns the width</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultVideo.html#method_getWidth"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
</tr>
<tr>
<td class="type">
integer
</td>
<td class="last">
<a href="#method_getHeight">getHeight</a>()
<p>Returns the height</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultVideo.html#method_getHeight"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setDimensions">setDimensions</a>(integer $width, integer $height)
<p>Set the dimensions</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultVideo.html#method_setDimensions"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setResizeMode">setResizeMode</a>(string $mode)
<p>Set the resize mode</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultVideo.html#method_setResizeMode"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
</tr>
<tr>
<td class="type">
string
</td>
<td class="last">
<a href="#method_getResizeMode">getResizeMode</a>()
<p>Get the current resize mode</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultVideo.html#method_getResizeMode"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
</tr>
<tr>
<td class="type">
integer
</td>
<td class="last">
<a href="#method_getFrameRate">getFrameRate</a>()
<p>Returns the frame rate</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultVideo.html#method_getFrameRate"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setFrameRate">setFrameRate</a>(integer $frameRate)
<p>Set the framerate</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultVideo.html#method_setFrameRate"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_getVideoCodec">getVideoCodec</a>()
<p>{@inheritdoc}</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultVideo.html#method_getVideoCodec"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setVideoCodec">setVideoCodec</a>(string $videoCodec)
<p>Set the video codec, Should be in the available ones, otherwise an exception is thrown</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultVideo.html#method_setVideoCodec"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_getGOPsize">getGOPsize</a>()
<p>{@inheritdoc}</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultVideo.html#method_getGOPsize"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setGOPsize">setGOPsize</a>(integer $GOPsize)
<p>Set the GOP size</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultVideo.html#method_setGOPsize"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_getExtraParams">getExtraParams</a>()
<p>{@inheritDoc}</p>
</td>
<td></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_getAvailableAudioCodecs">getAvailableAudioCodecs</a>()
<p>{@inheritDoc}</p>
</td>
<td></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_getAvailableVideoCodecs">getAvailableVideoCodecs</a>()
<p>{@inheritDoc}</p>
</td>
<td></td>
</tr>
</table>
<h2>Details</h2>
<h3 id="method_getWidth">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultVideo.html#method_getWidth"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 35</div>
<code> public integer
<strong>getWidth</strong>()</code>
</h3>
<div class="details">
<p>Returns the width</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>integer</td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_getHeight">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultVideo.html#method_getHeight"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 43</div>
<code> public integer
<strong>getHeight</strong>()</code>
</h3>
<div class="details">
<p>Returns the height</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>integer</td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_setDimensions">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultVideo.html#method_setDimensions"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 55</div>
<code> public
<strong>setDimensions</strong>(integer $width, integer $height)</code>
</h3>
<div class="details">
<p>Set the dimensions</p>
<p></p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td>integer</td>
<td>$width</td>
<td>The heigth</td>
</tr>
<tr>
<td>integer</td>
<td>$height</td>
<td>The width</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_setResizeMode">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultVideo.html#method_setResizeMode"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 77</div>
<code> public
<strong>setResizeMode</strong>(string $mode)</code>
</h3>
<div class="details">
<p>Set the resize mode</p>
<p></p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td>string</td>
<td>$mode</td>
<td>The mode, one of the self::RESIZEMODE_* constants</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_getResizeMode">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultVideo.html#method_getResizeMode"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 95</div>
<code> public string
<strong>getResizeMode</strong>()</code>
</h3>
<div class="details">
<p>Get the current resize mode</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>string</td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_getFrameRate">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultVideo.html#method_getFrameRate"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 103</div>
<code> public integer
<strong>getFrameRate</strong>()</code>
</h3>
<div class="details">
<p>Returns the frame rate</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>integer</td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_setFrameRate">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultVideo.html#method_setFrameRate"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 115</div>
<code> public
<strong>setFrameRate</strong>(integer $frameRate)</code>
</h3>
<div class="details">
<p>Set the framerate</p>
<p></p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td>integer</td>
<td>$frameRate</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/DefaultVideo.html#method_getVideoCodec"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 129</div>
<code> public
<strong>getVideoCodec</strong>()</code>
</h3>
<div class="details">
<p>{@inheritdoc}</p>
<p></p>
<div class="tags">
</div>
</div>
<h3 id="method_setVideoCodec">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultVideo.html#method_setVideoCodec"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 141</div>
<code> public
<strong>setVideoCodec</strong>(string $videoCodec)</code>
</h3>
<div class="details">
<p>Set 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_getGOPsize">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultVideo.html#method_getGOPsize"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 158</div>
<code> public
<strong>getGOPsize</strong>()</code>
</h3>
<div class="details">
<p>{@inheritdoc}</p>
<p></p>
<div class="tags">
</div>
</div>
<h3 id="method_setGOPsize">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultVideo.html#method_setGOPsize"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 170</div>
<code> public
<strong>setGOPsize</strong>(integer $GOPsize)</code>
</h3>
<div class="details">
<p>Set the GOP size</p>
<p></p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td>integer</td>
<td>$GOPsize</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_getExtraParams">
<div class="location">at line 29</div>
<code> public
<strong>getExtraParams</strong>()</code>
</h3>
<div class="details">
<p>{@inheritDoc}</p>
<p></p>
<div class="tags">
</div>
</div>
<h3 id="method_getAvailableAudioCodecs">
<div class="location">at line 37</div>
<code> public
<strong>getAvailableAudioCodecs</strong>()</code>
</h3>
<div class="details">
<p>{@inheritDoc}</p>
<p></p>
<div class="tags">
</div>
</div>
<h3 id="method_getAvailableVideoCodecs">
<div class="location">at line 45</div>
<code> public
<strong>getAvailableVideoCodecs</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>

View file

@ -0,0 +1,509 @@
<!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="../../../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/DefaultVideo.html"><abbr title="FFMpeg\Format\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">
integer
</td>
<td class="last">
<a href="#method_getWidth">getWidth</a>()
<p>Returns the width</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultVideo.html#method_getWidth"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
</tr>
<tr>
<td class="type">
integer
</td>
<td class="last">
<a href="#method_getHeight">getHeight</a>()
<p>Returns the height</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultVideo.html#method_getHeight"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setDimensions">setDimensions</a>(integer $width, integer $height)
<p>Set the dimensions</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultVideo.html#method_setDimensions"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setResizeMode">setResizeMode</a>(string $mode)
<p>Set the resize mode</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultVideo.html#method_setResizeMode"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
</tr>
<tr>
<td class="type">
string
</td>
<td class="last">
<a href="#method_getResizeMode">getResizeMode</a>()
<p>Get the current resize mode</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultVideo.html#method_getResizeMode"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
</tr>
<tr>
<td class="type">
integer
</td>
<td class="last">
<a href="#method_getFrameRate">getFrameRate</a>()
<p>Returns the frame rate</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultVideo.html#method_getFrameRate"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setFrameRate">setFrameRate</a>(integer $frameRate)
<p>Set the framerate</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultVideo.html#method_setFrameRate"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_getVideoCodec">getVideoCodec</a>()
<p>{@inheritdoc}</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultVideo.html#method_getVideoCodec"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setVideoCodec">setVideoCodec</a>(string $videoCodec)
<p>Set the video codec, Should be in the available ones, otherwise an exception is thrown</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultVideo.html#method_setVideoCodec"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_getGOPsize">getGOPsize</a>()
<p>{@inheritdoc}</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultVideo.html#method_getGOPsize"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setGOPsize">setGOPsize</a>(integer $GOPsize)
<p>Set the GOP size</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/DefaultVideo.html#method_setGOPsize"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_getAvailableAudioCodecs">getAvailableAudioCodecs</a>()
<p>{@inheritDoc}</p>
</td>
<td></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_getAvailableVideoCodecs">getAvailableVideoCodecs</a>()
<p>{@inheritDoc}</p>
</td>
<td></td>
</tr>
</table>
<h2>Details</h2>
<h3 id="method_getWidth">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultVideo.html#method_getWidth"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 35</div>
<code> public integer
<strong>getWidth</strong>()</code>
</h3>
<div class="details">
<p>Returns the width</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>integer</td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_getHeight">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultVideo.html#method_getHeight"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 43</div>
<code> public integer
<strong>getHeight</strong>()</code>
</h3>
<div class="details">
<p>Returns the height</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>integer</td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_setDimensions">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultVideo.html#method_setDimensions"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 55</div>
<code> public
<strong>setDimensions</strong>(integer $width, integer $height)</code>
</h3>
<div class="details">
<p>Set the dimensions</p>
<p></p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td>integer</td>
<td>$width</td>
<td>The heigth</td>
</tr>
<tr>
<td>integer</td>
<td>$height</td>
<td>The width</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_setResizeMode">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultVideo.html#method_setResizeMode"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 77</div>
<code> public
<strong>setResizeMode</strong>(string $mode)</code>
</h3>
<div class="details">
<p>Set the resize mode</p>
<p></p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td>string</td>
<td>$mode</td>
<td>The mode, one of the self::RESIZEMODE_* constants</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_getResizeMode">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultVideo.html#method_getResizeMode"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 95</div>
<code> public string
<strong>getResizeMode</strong>()</code>
</h3>
<div class="details">
<p>Get the current resize mode</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>string</td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_getFrameRate">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultVideo.html#method_getFrameRate"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 103</div>
<code> public integer
<strong>getFrameRate</strong>()</code>
</h3>
<div class="details">
<p>Returns the frame rate</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>integer</td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_setFrameRate">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultVideo.html#method_setFrameRate"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 115</div>
<code> public
<strong>setFrameRate</strong>(integer $frameRate)</code>
</h3>
<div class="details">
<p>Set the framerate</p>
<p></p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td>integer</td>
<td>$frameRate</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/DefaultVideo.html#method_getVideoCodec"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 129</div>
<code> public
<strong>getVideoCodec</strong>()</code>
</h3>
<div class="details">
<p>{@inheritdoc}</p>
<p></p>
<div class="tags">
</div>
</div>
<h3 id="method_setVideoCodec">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultVideo.html#method_setVideoCodec"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 141</div>
<code> public
<strong>setVideoCodec</strong>(string $videoCodec)</code>
</h3>
<div class="details">
<p>Set 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_getGOPsize">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultVideo.html#method_getGOPsize"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 158</div>
<code> public
<strong>getGOPsize</strong>()</code>
</h3>
<div class="details">
<p>{@inheritdoc}</p>
<p></p>
<div class="tags">
</div>
</div>
<h3 id="method_setGOPsize">
<div class="location">in <a href="../../../FFMpeg/Format/DefaultVideo.html#method_setGOPsize"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 170</div>
<code> public
<strong>setGOPsize</strong>(integer $GOPsize)</code>
</h3>
<div class="details">
<p>Set the GOP size</p>
<p></p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td>integer</td>
<td>$GOPsize</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_getAvailableAudioCodecs">
<div class="location">at line 29</div>
<code> public
<strong>getAvailableAudioCodecs</strong>()</code>
</h3>
<div class="details">
<p>{@inheritDoc}</p>
<p></p>
<div class="tags">
</div>
</div>
<h3 id="method_getAvailableVideoCodecs">
<div class="location">at line 37</div>
<code> public
<strong>getAvailableVideoCodecs</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>

View file

@ -0,0 +1,9 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>FFMpeg\Format\Video | PHP FFMpeg API</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
</head>
</html>

View file

@ -0,0 +1,9 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>FFMpeg\Format | PHP FFMpeg API</title>
<link rel="stylesheet" type="text/css" href="../../stylesheet.css">
</head>
</html>