Move API folder
This commit is contained in:
grosroro
parent
cee2e1892e
commit
e59f411c88
63 changed files with 9236 additions and 2 deletions
778
docs/API/FFMpeg/Format/Video/DefaultVideo.html
Normal file
778
docs/API/FFMpeg/Format/Video/DefaultVideo.html
Normal file
|
|
@ -0,0 +1,778 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8" />
|
||||
<meta name="robots" content="index, follow, all" />
|
||||
<title>FFMpeg\Format\Video\DefaultVideo | PHP FFMpeg API</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
|
||||
</head>
|
||||
<body id="class">
|
||||
<div class="header">
|
||||
<ul>
|
||||
<li><a href="../../../classes.html">Classes</a></li>
|
||||
<li><a href="../../../namespaces.html">Namespaces</a></li>
|
||||
<li><a href="../../../interfaces.html">Interfaces</a></li>
|
||||
<li><a href="../../../doc-index.html">Index</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
<div id="title">PHP FFMpeg API</div>
|
||||
|
||||
<div class="type">Class</div>
|
||||
<h1><a href="../../../FFMpeg/Format/Video.html">FFMpeg\Format\Video</a>\DefaultVideo</h1>
|
||||
</div>
|
||||
<div class="content">
|
||||
<p>abstract class <strong>DefaultVideo</strong> extends <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> implements
|
||||
<a href="../../../FFMpeg/Format/Video/InteractiveVideo.html"><abbr title="FFMpeg\Format\Video\InteractiveVideo">InteractiveVideo</abbr></a>, <a href="../../../FFMpeg/Format/Video/ResamplableVideo.html"><abbr title="FFMpeg\Format\Video\ResamplableVideo">ResamplableVideo</abbr></a>, <a href="../../../FFMpeg/Format/Video/ResizableVideo.html"><abbr title="FFMpeg\Format\Video\ResizableVideo">ResizableVideo</abbr></a></p>
|
||||
|
||||
<div class="description">
|
||||
<p>The abstract default Video format</p>
|
||||
<p></p>
|
||||
</div>
|
||||
|
||||
<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_getExtraParams">getExtraParams</a>()
|
||||
<p>Returns extra parameters for the encoding</p>
|
||||
</td>
|
||||
<td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getExtraParams"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="type">
|
||||
|
||||
</td>
|
||||
<td class="last">
|
||||
<a href="#method_getAudioCodec">getAudioCodec</a>()
|
||||
<p>{@inheritdoc}</p>
|
||||
</td>
|
||||
<td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="type">
|
||||
|
||||
</td>
|
||||
<td class="last">
|
||||
<a href="#method_setAudioCodec">setAudioCodec</a>(string $audioCodec)
|
||||
<p>Set the audio codec, Should be in the available ones, otherwise an exception is thrown</p>
|
||||
</td>
|
||||
<td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="type">
|
||||
integer
|
||||
</td>
|
||||
<td class="last">
|
||||
<a href="#method_getAudioSampleRate">getAudioSampleRate</a>()
|
||||
<p>Get the audio sample rate</p>
|
||||
</td>
|
||||
<td><small>from <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioSampleRate"><abbr title="FFMpeg\Format\Audio\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 <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioSampleRate"><abbr title="FFMpeg\Format\Audio\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 <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getKiloBitrate"><abbr title="FFMpeg\Format\Audio\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 <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setKiloBitrate"><abbr title="FFMpeg\Format\Audio\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 setting.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="type">
|
||||
integer
|
||||
</td>
|
||||
<td class="last">
|
||||
<a href="#method_getHeight">getHeight</a>()
|
||||
<p>Returns the height setting The return of this method should not depend on a media file size</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">
|
||||
array
|
||||
</td>
|
||||
<td class="last">
|
||||
<a href="#method_getComputedDimensions">getComputedDimensions</a>(integer $originalWidth, integer $originalHeight)
|
||||
<p>{@inheritdoc)</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 name</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/Audio/DefaultAudio.html#method_getExtraParams"><abbr title="FFMpeg\Format\Audio\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/Audio/DefaultAudio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\Audio\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/Audio/DefaultAudio.html#method_setAudioCodec"><abbr title="FFMpeg\Format\Audio\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/Audio/DefaultAudio.html#method_getAudioSampleRate"><abbr title="FFMpeg\Format\Audio\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/Audio/DefaultAudio.html#method_setAudioSampleRate"><abbr title="FFMpeg\Format\Audio\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/Audio/DefaultAudio.html#method_getKiloBitrate"><abbr title="FFMpeg\Format\Audio\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/Audio/DefaultAudio.html#method_setKiloBitrate"><abbr title="FFMpeg\Format\Audio\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 38</div>
|
||||
<code> public integer
|
||||
<strong>getWidth</strong>()</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
<p>Returns the width setting.</p>
|
||||
<p>The return of this method should not depend on a media file size</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 46</div>
|
||||
<code> public integer
|
||||
<strong>getHeight</strong>()</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
<p>Returns the height setting The return of this method should not depend on a media file size</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 58</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_getComputedDimensions">
|
||||
<div class="location">at line 76</div>
|
||||
<code> public array
|
||||
<strong>getComputedDimensions</strong>(integer $originalWidth, integer $originalHeight)</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
<p>{@inheritdoc)</p>
|
||||
<p></p>
|
||||
<div class="tags">
|
||||
<h4>Parameters</h4>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td>integer</td>
|
||||
<td>$originalWidth</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>integer</td>
|
||||
<td>$originalHeight</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
<h4>Return Value</h4>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td>array</td>
|
||||
<td>An indexed array containing the width and the height</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h3 id="method_setResizeMode">
|
||||
<div class="location">at line 108</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 126</div>
|
||||
<code> public string
|
||||
<strong>getResizeMode</strong>()</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
<p>Get the current resize mode name</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 134</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 146</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 160</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 172</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 189</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 201</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>
|
||||
119
docs/API/FFMpeg/Format/Video/InteractiveVideo.html
Normal file
119
docs/API/FFMpeg/Format/Video/InteractiveVideo.html
Normal file
|
|
@ -0,0 +1,119 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8" />
|
||||
<meta name="robots" content="index, follow, all" />
|
||||
<title>FFMpeg\Format\Video\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/Video.html">FFMpeg\Format\Video</a>\InteractiveVideo</h1>
|
||||
</div>
|
||||
<div class="content">
|
||||
<p>interface <strong>InteractiveVideo</strong> implements
|
||||
<a href="../../../FFMpeg/Format/Video.html"><abbr title="FFMpeg\Format\Video">Video</abbr></a></p>
|
||||
|
||||
<div class="description">
|
||||
<p>The interactive video interface.</p>
|
||||
<p>This provide a method to list available<br />
|
||||
codecs. This is usefull to build interactive development and switch between<br />
|
||||
different codecs</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<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 <a href="../../../FFMpeg/Format/Video.html#method_getVideoCodec"><abbr title="FFMpeg\Format\Video">Video</abbr></a></small></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_getVideoCodec">
|
||||
<div class="location">in <a href="../../../FFMpeg/Format/Video.html#method_getVideoCodec"><abbr title="FFMpeg\Format\Video">Video</abbr></a> at line 27</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_getAvailableVideoCodecs">
|
||||
<div class="location">at line 31</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>
|
||||
577
docs/API/FFMpeg/Format/Video/Ogg.html
Normal file
577
docs/API/FFMpeg/Format/Video/Ogg.html
Normal file
|
|
@ -0,0 +1,577 @@
|
|||
<!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/Video/DefaultVideo.html"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></p>
|
||||
|
||||
<div class="description">
|
||||
<p>The Ogg video format</p>
|
||||
<p></p>
|
||||
</div>
|
||||
|
||||
<h2>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">
|
||||
integer
|
||||
</td>
|
||||
<td class="last">
|
||||
<a href="#method_getWidth">getWidth</a>()
|
||||
<p>Returns the width setting.</p>
|
||||
</td>
|
||||
<td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getWidth"><abbr title="FFMpeg\Format\Video\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 setting The return of this method should not depend on a media file size</p>
|
||||
</td>
|
||||
<td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getHeight"><abbr title="FFMpeg\Format\Video\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 <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setDimensions"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></small></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="type">
|
||||
array
|
||||
</td>
|
||||
<td class="last">
|
||||
<a href="#method_getComputedDimensions">getComputedDimensions</a>(integer $originalWidth, integer $originalHeight)
|
||||
<p>{@inheritdoc)</p>
|
||||
</td>
|
||||
<td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getComputedDimensions"><abbr title="FFMpeg\Format\Video\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 <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setResizeMode"><abbr title="FFMpeg\Format\Video\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 name</p>
|
||||
</td>
|
||||
<td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getResizeMode"><abbr title="FFMpeg\Format\Video\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 <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getFrameRate"><abbr title="FFMpeg\Format\Video\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 <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setFrameRate"><abbr title="FFMpeg\Format\Video\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 <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></small></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="type">
|
||||
|
||||
</td>
|
||||
<td class="last">
|
||||
<a href="#method_setVideoCodec">setVideoCodec</a>(string $videoCodec)
|
||||
<p>Set the video codec, Should be in the available ones, otherwise an exception is thrown</p>
|
||||
</td>
|
||||
<td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></small></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="type">
|
||||
|
||||
</td>
|
||||
<td class="last">
|
||||
<a href="#method_getGOPsize">getGOPsize</a>()
|
||||
<p>{@inheritdoc}</p>
|
||||
</td>
|
||||
<td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getGOPsize"><abbr title="FFMpeg\Format\Video\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 <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setGOPsize"><abbr title="FFMpeg\Format\Video\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/Video/DefaultVideo.html#method_getWidth"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 38</div>
|
||||
<code> public integer
|
||||
<strong>getWidth</strong>()</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
<p>Returns the width setting.</p>
|
||||
<p>The return of this method should not depend on a media file size</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/Video/DefaultVideo.html#method_getHeight"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 46</div>
|
||||
<code> public integer
|
||||
<strong>getHeight</strong>()</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
<p>Returns the height setting The return of this method should not depend on a media file size</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/Video/DefaultVideo.html#method_setDimensions"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 58</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_getComputedDimensions">
|
||||
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getComputedDimensions"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 76</div>
|
||||
<code> public array
|
||||
<strong>getComputedDimensions</strong>(integer $originalWidth, integer $originalHeight)</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
<p>{@inheritdoc)</p>
|
||||
<p></p>
|
||||
<div class="tags">
|
||||
<h4>Parameters</h4>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td>integer</td>
|
||||
<td>$originalWidth</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>integer</td>
|
||||
<td>$originalHeight</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
<h4>Return Value</h4>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td>array</td>
|
||||
<td>An indexed array containing the width and the height</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h3 id="method_setResizeMode">
|
||||
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setResizeMode"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 108</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/Video/DefaultVideo.html#method_getResizeMode"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 126</div>
|
||||
<code> public string
|
||||
<strong>getResizeMode</strong>()</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
<p>Get the current resize mode name</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/Video/DefaultVideo.html#method_getFrameRate"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 134</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/Video/DefaultVideo.html#method_setFrameRate"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 146</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/Video/DefaultVideo.html#method_getVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 160</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/Video/DefaultVideo.html#method_setVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 172</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/Video/DefaultVideo.html#method_getGOPsize"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 189</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/Video/DefaultVideo.html#method_setGOPsize"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 201</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 27</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 35</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>
|
||||
151
docs/API/FFMpeg/Format/Video/ResamplableVideo.html
Normal file
151
docs/API/FFMpeg/Format/Video/ResamplableVideo.html
Normal file
|
|
@ -0,0 +1,151 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8" />
|
||||
<meta name="robots" content="index, follow, all" />
|
||||
<title>FFMpeg\Format\Video\ResamplableVideo | 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/Video.html">FFMpeg\Format\Video</a>\ResamplableVideo</h1>
|
||||
</div>
|
||||
<div class="content">
|
||||
<p>interface <strong>ResamplableVideo</strong> implements
|
||||
<a href="../../../FFMpeg/Format/Video.html"><abbr title="FFMpeg\Format\Video">Video</abbr></a></p>
|
||||
|
||||
<div class="description">
|
||||
<p>The resamplable video interface</p>
|
||||
<p>This interface provides frame rate and GOP size settings for video encoding</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<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 <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_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 27</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_getFrameRate">
|
||||
<div class="location">at line 31</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 38</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>
|
||||
234
docs/API/FFMpeg/Format/Video/ResizableVideo.html
Normal file
234
docs/API/FFMpeg/Format/Video/ResizableVideo.html
Normal file
|
|
@ -0,0 +1,234 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8" />
|
||||
<meta name="robots" content="index, follow, all" />
|
||||
<title>FFMpeg\Format\Video\ResizableVideo | 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/Video.html">FFMpeg\Format\Video</a>\ResizableVideo</h1>
|
||||
</div>
|
||||
<div class="content">
|
||||
<p>interface <strong>ResizableVideo</strong> implements
|
||||
<a href="../../../FFMpeg/Format/Video.html"><abbr title="FFMpeg\Format\Video">Video</abbr></a></p>
|
||||
|
||||
<div class="description">
|
||||
<p>The resizable video interface</p>
|
||||
<p>This interface provides methods for video resizing.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<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 <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 setting.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="type">
|
||||
integer
|
||||
</td>
|
||||
<td class="last">
|
||||
<a href="#method_getHeight">getHeight</a>()
|
||||
<p>Returns the height setting The return of this method should not depend on a media file size</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="type">
|
||||
array
|
||||
</td>
|
||||
<td class="last">
|
||||
<a href="#method_getComputedDimensions">getComputedDimensions</a>(integer $originalWidth, integer $originalHeight)
|
||||
<p>Returns the computed dimensions for the resize, after operation.</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 name</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 27</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 32</div>
|
||||
<code> public integer
|
||||
<strong>getWidth</strong>()</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
<p>Returns the width setting.</p>
|
||||
<p>The return of this method should not depend on a media file size</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 40</div>
|
||||
<code> public integer
|
||||
<strong>getHeight</strong>()</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
<p>Returns the height setting The return of this method should not depend on a media file size</p>
|
||||
<p></p>
|
||||
<div class="tags">
|
||||
|
||||
<h4>Return Value</h4>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td>integer</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h3 id="method_getComputedDimensions">
|
||||
<div class="location">at line 50</div>
|
||||
<code> public array
|
||||
<strong>getComputedDimensions</strong>(integer $originalWidth, integer $originalHeight)</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
<p>Returns the computed dimensions for the resize, after operation.</p>
|
||||
<p>This method return the actual dimensions that FFmpeg will use.</p>
|
||||
<div class="tags">
|
||||
<h4>Parameters</h4>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td>integer</td>
|
||||
<td>$originalWidth</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>integer</td>
|
||||
<td>$originalHeight</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
<h4>Return Value</h4>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td>array</td>
|
||||
<td>An indexed array containing the width and the height</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h3 id="method_getResizeMode">
|
||||
<div class="location">at line 57</div>
|
||||
<code> public string
|
||||
<strong>getResizeMode</strong>()</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
<p>Get the current resize mode name</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>
|
||||
602
docs/API/FFMpeg/Format/Video/WebM.html
Normal file
602
docs/API/FFMpeg/Format/Video/WebM.html
Normal file
|
|
@ -0,0 +1,602 @@
|
|||
<!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/Video/DefaultVideo.html"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></p>
|
||||
|
||||
<div class="description">
|
||||
<p>The WebM video format</p>
|
||||
<p></p>
|
||||
</div>
|
||||
|
||||
<h2>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">
|
||||
integer
|
||||
</td>
|
||||
<td class="last">
|
||||
<a href="#method_getWidth">getWidth</a>()
|
||||
<p>Returns the width setting.</p>
|
||||
</td>
|
||||
<td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getWidth"><abbr title="FFMpeg\Format\Video\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 setting The return of this method should not depend on a media file size</p>
|
||||
</td>
|
||||
<td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getHeight"><abbr title="FFMpeg\Format\Video\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 <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setDimensions"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></small></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="type">
|
||||
array
|
||||
</td>
|
||||
<td class="last">
|
||||
<a href="#method_getComputedDimensions">getComputedDimensions</a>(integer $originalWidth, integer $originalHeight)
|
||||
<p>{@inheritdoc)</p>
|
||||
</td>
|
||||
<td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getComputedDimensions"><abbr title="FFMpeg\Format\Video\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 <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setResizeMode"><abbr title="FFMpeg\Format\Video\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 name</p>
|
||||
</td>
|
||||
<td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getResizeMode"><abbr title="FFMpeg\Format\Video\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 <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getFrameRate"><abbr title="FFMpeg\Format\Video\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 <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setFrameRate"><abbr title="FFMpeg\Format\Video\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 <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></small></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="type">
|
||||
|
||||
</td>
|
||||
<td class="last">
|
||||
<a href="#method_setVideoCodec">setVideoCodec</a>(string $videoCodec)
|
||||
<p>Set the video codec, Should be in the available ones, otherwise an exception is thrown</p>
|
||||
</td>
|
||||
<td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></small></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="type">
|
||||
|
||||
</td>
|
||||
<td class="last">
|
||||
<a href="#method_getGOPsize">getGOPsize</a>()
|
||||
<p>{@inheritdoc}</p>
|
||||
</td>
|
||||
<td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getGOPsize"><abbr title="FFMpeg\Format\Video\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 <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setGOPsize"><abbr title="FFMpeg\Format\Video\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/Video/DefaultVideo.html#method_getWidth"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 38</div>
|
||||
<code> public integer
|
||||
<strong>getWidth</strong>()</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
<p>Returns the width setting.</p>
|
||||
<p>The return of this method should not depend on a media file size</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/Video/DefaultVideo.html#method_getHeight"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 46</div>
|
||||
<code> public integer
|
||||
<strong>getHeight</strong>()</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
<p>Returns the height setting The return of this method should not depend on a media file size</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/Video/DefaultVideo.html#method_setDimensions"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 58</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_getComputedDimensions">
|
||||
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getComputedDimensions"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 76</div>
|
||||
<code> public array
|
||||
<strong>getComputedDimensions</strong>(integer $originalWidth, integer $originalHeight)</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
<p>{@inheritdoc)</p>
|
||||
<p></p>
|
||||
<div class="tags">
|
||||
<h4>Parameters</h4>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td>integer</td>
|
||||
<td>$originalWidth</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>integer</td>
|
||||
<td>$originalHeight</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
<h4>Return Value</h4>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td>array</td>
|
||||
<td>An indexed array containing the width and the height</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h3 id="method_setResizeMode">
|
||||
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setResizeMode"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 108</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/Video/DefaultVideo.html#method_getResizeMode"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 126</div>
|
||||
<code> public string
|
||||
<strong>getResizeMode</strong>()</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
<p>Get the current resize mode name</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/Video/DefaultVideo.html#method_getFrameRate"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 134</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/Video/DefaultVideo.html#method_setFrameRate"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 146</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/Video/DefaultVideo.html#method_getVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 160</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/Video/DefaultVideo.html#method_setVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 172</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/Video/DefaultVideo.html#method_getGOPsize"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 189</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/Video/DefaultVideo.html#method_setGOPsize"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 201</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 27</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 35</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 43</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>
|
||||
577
docs/API/FFMpeg/Format/Video/X264.html
Normal file
577
docs/API/FFMpeg/Format/Video/X264.html
Normal file
|
|
@ -0,0 +1,577 @@
|
|||
<!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/Video/DefaultVideo.html"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></p>
|
||||
|
||||
<div class="description">
|
||||
<p>The X264 video format</p>
|
||||
<p></p>
|
||||
</div>
|
||||
|
||||
<h2>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">
|
||||
integer
|
||||
</td>
|
||||
<td class="last">
|
||||
<a href="#method_getWidth">getWidth</a>()
|
||||
<p>Returns the width setting.</p>
|
||||
</td>
|
||||
<td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getWidth"><abbr title="FFMpeg\Format\Video\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 setting The return of this method should not depend on a media file size</p>
|
||||
</td>
|
||||
<td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getHeight"><abbr title="FFMpeg\Format\Video\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 <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setDimensions"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></small></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="type">
|
||||
array
|
||||
</td>
|
||||
<td class="last">
|
||||
<a href="#method_getComputedDimensions">getComputedDimensions</a>(integer $originalWidth, integer $originalHeight)
|
||||
<p>{@inheritdoc)</p>
|
||||
</td>
|
||||
<td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getComputedDimensions"><abbr title="FFMpeg\Format\Video\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 <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setResizeMode"><abbr title="FFMpeg\Format\Video\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 name</p>
|
||||
</td>
|
||||
<td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getResizeMode"><abbr title="FFMpeg\Format\Video\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 <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getFrameRate"><abbr title="FFMpeg\Format\Video\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 <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setFrameRate"><abbr title="FFMpeg\Format\Video\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 <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></small></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="type">
|
||||
|
||||
</td>
|
||||
<td class="last">
|
||||
<a href="#method_setVideoCodec">setVideoCodec</a>(string $videoCodec)
|
||||
<p>Set the video codec, Should be in the available ones, otherwise an exception is thrown</p>
|
||||
</td>
|
||||
<td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></small></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="type">
|
||||
|
||||
</td>
|
||||
<td class="last">
|
||||
<a href="#method_getGOPsize">getGOPsize</a>()
|
||||
<p>{@inheritdoc}</p>
|
||||
</td>
|
||||
<td><small>from <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getGOPsize"><abbr title="FFMpeg\Format\Video\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 <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setGOPsize"><abbr title="FFMpeg\Format\Video\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/Video/DefaultVideo.html#method_getWidth"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 38</div>
|
||||
<code> public integer
|
||||
<strong>getWidth</strong>()</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
<p>Returns the width setting.</p>
|
||||
<p>The return of this method should not depend on a media file size</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/Video/DefaultVideo.html#method_getHeight"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 46</div>
|
||||
<code> public integer
|
||||
<strong>getHeight</strong>()</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
<p>Returns the height setting The return of this method should not depend on a media file size</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/Video/DefaultVideo.html#method_setDimensions"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 58</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_getComputedDimensions">
|
||||
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getComputedDimensions"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 76</div>
|
||||
<code> public array
|
||||
<strong>getComputedDimensions</strong>(integer $originalWidth, integer $originalHeight)</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
<p>{@inheritdoc)</p>
|
||||
<p></p>
|
||||
<div class="tags">
|
||||
<h4>Parameters</h4>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td>integer</td>
|
||||
<td>$originalWidth</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>integer</td>
|
||||
<td>$originalHeight</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
<h4>Return Value</h4>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td>array</td>
|
||||
<td>An indexed array containing the width and the height</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h3 id="method_setResizeMode">
|
||||
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setResizeMode"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 108</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/Video/DefaultVideo.html#method_getResizeMode"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 126</div>
|
||||
<code> public string
|
||||
<strong>getResizeMode</strong>()</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
<p>Get the current resize mode name</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/Video/DefaultVideo.html#method_getFrameRate"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 134</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/Video/DefaultVideo.html#method_setFrameRate"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 146</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/Video/DefaultVideo.html#method_getVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 160</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/Video/DefaultVideo.html#method_setVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 172</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/Video/DefaultVideo.html#method_getGOPsize"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 189</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/Video/DefaultVideo.html#method_setGOPsize"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 201</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 27</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 35</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>
|
||||
9
docs/API/FFMpeg/Format/Video/namespace-frame.html
Normal file
9
docs/API/FFMpeg/Format/Video/namespace-frame.html
Normal 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>
|
||||
Loading…
Add table
Add a link
Reference in a new issue