scratch – Rev
?pathlinks?
<!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>