Add Sami API
This commit is contained in:
Romain Neutron
parent
96820c5d0f
commit
557c0bc1c7
60 changed files with 8724 additions and 0 deletions
534
docs/build/API/FFMpeg/Format/Video/WebM.html
vendored
Normal file
534
docs/build/API/FFMpeg/Format/Video/WebM.html
vendored
Normal file
|
|
@ -0,0 +1,534 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8" />
|
||||
<meta name="robots" content="index, follow, all" />
|
||||
<title>FFMpeg\Format\Video\WebM | PHP FFMpeg API</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
|
||||
</head>
|
||||
<body id="class">
|
||||
<div class="header">
|
||||
<ul>
|
||||
<li><a href="../../../classes.html">Classes</a></li>
|
||||
<li><a href="../../../namespaces.html">Namespaces</a></li>
|
||||
<li><a href="../../../interfaces.html">Interfaces</a></li>
|
||||
<li><a href="../../../doc-index.html">Index</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
<div id="title">PHP FFMpeg API</div>
|
||||
|
||||
<div class="type">Class</div>
|
||||
<h1><a href="../../../FFMpeg/Format/Video.html">FFMpeg\Format\Video</a>\WebM</h1>
|
||||
</div>
|
||||
<div class="content">
|
||||
<p>class <strong>WebM</strong> extends <a href="../../../FFMpeg/Format/DefaultVideo.html"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></p>
|
||||
|
||||
<div class="description">
|
||||
<p>The WebM video format</p>
|
||||
<p></p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<h2>Methods</h2>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td class="type">
|
||||
integer
|
||||
</td>
|
||||
<td class="last">
|
||||
<a href="#method_getWidth">getWidth</a>()
|
||||
<p>Returns the width</p>
|
||||
</td>
|
||||
<td><small>from <a href="../../../FFMpeg/Format/DefaultVideo.html#method_getWidth"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="type">
|
||||
integer
|
||||
</td>
|
||||
<td class="last">
|
||||
<a href="#method_getHeight">getHeight</a>()
|
||||
<p>Returns the height</p>
|
||||
</td>
|
||||
<td><small>from <a href="../../../FFMpeg/Format/DefaultVideo.html#method_getHeight"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="type">
|
||||
|
||||
</td>
|
||||
<td class="last">
|
||||
<a href="#method_setDimensions">setDimensions</a>(integer $width, integer $height)
|
||||
<p>Set the dimensions</p>
|
||||
</td>
|
||||
<td><small>from <a href="../../../FFMpeg/Format/DefaultVideo.html#method_setDimensions"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="type">
|
||||
|
||||
</td>
|
||||
<td class="last">
|
||||
<a href="#method_setResizeMode">setResizeMode</a>(string $mode)
|
||||
<p>Set the resize mode</p>
|
||||
</td>
|
||||
<td><small>from <a href="../../../FFMpeg/Format/DefaultVideo.html#method_setResizeMode"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="type">
|
||||
string
|
||||
</td>
|
||||
<td class="last">
|
||||
<a href="#method_getResizeMode">getResizeMode</a>()
|
||||
<p>Get the current resize mode</p>
|
||||
</td>
|
||||
<td><small>from <a href="../../../FFMpeg/Format/DefaultVideo.html#method_getResizeMode"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="type">
|
||||
integer
|
||||
</td>
|
||||
<td class="last">
|
||||
<a href="#method_getFrameRate">getFrameRate</a>()
|
||||
<p>Returns the frame rate</p>
|
||||
</td>
|
||||
<td><small>from <a href="../../../FFMpeg/Format/DefaultVideo.html#method_getFrameRate"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="type">
|
||||
|
||||
</td>
|
||||
<td class="last">
|
||||
<a href="#method_setFrameRate">setFrameRate</a>(integer $frameRate)
|
||||
<p>Set the framerate</p>
|
||||
</td>
|
||||
<td><small>from <a href="../../../FFMpeg/Format/DefaultVideo.html#method_setFrameRate"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="type">
|
||||
|
||||
</td>
|
||||
<td class="last">
|
||||
<a href="#method_getVideoCodec">getVideoCodec</a>()
|
||||
<p>{@inheritdoc}</p>
|
||||
</td>
|
||||
<td><small>from <a href="../../../FFMpeg/Format/DefaultVideo.html#method_getVideoCodec"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="type">
|
||||
|
||||
</td>
|
||||
<td class="last">
|
||||
<a href="#method_setVideoCodec">setVideoCodec</a>(string $videoCodec)
|
||||
<p>Set the video codec, Should be in the available ones, otherwise an exception is thrown</p>
|
||||
</td>
|
||||
<td><small>from <a href="../../../FFMpeg/Format/DefaultVideo.html#method_setVideoCodec"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="type">
|
||||
|
||||
</td>
|
||||
<td class="last">
|
||||
<a href="#method_getGOPsize">getGOPsize</a>()
|
||||
<p>{@inheritdoc}</p>
|
||||
</td>
|
||||
<td><small>from <a href="../../../FFMpeg/Format/DefaultVideo.html#method_getGOPsize"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="type">
|
||||
|
||||
</td>
|
||||
<td class="last">
|
||||
<a href="#method_setGOPsize">setGOPsize</a>(integer $GOPsize)
|
||||
<p>Set the GOP size</p>
|
||||
</td>
|
||||
<td><small>from <a href="../../../FFMpeg/Format/DefaultVideo.html#method_setGOPsize"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a></small></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="type">
|
||||
|
||||
</td>
|
||||
<td class="last">
|
||||
<a href="#method_getExtraParams">getExtraParams</a>()
|
||||
<p>{@inheritDoc}</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="type">
|
||||
|
||||
</td>
|
||||
<td class="last">
|
||||
<a href="#method_getAvailableAudioCodecs">getAvailableAudioCodecs</a>()
|
||||
<p>{@inheritDoc}</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="type">
|
||||
|
||||
</td>
|
||||
<td class="last">
|
||||
<a href="#method_getAvailableVideoCodecs">getAvailableVideoCodecs</a>()
|
||||
<p>{@inheritDoc}</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
<h2>Details</h2>
|
||||
|
||||
<h3 id="method_getWidth">
|
||||
<div class="location">in <a href="../../../FFMpeg/Format/DefaultVideo.html#method_getWidth"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 35</div>
|
||||
<code> public integer
|
||||
<strong>getWidth</strong>()</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
<p>Returns the width</p>
|
||||
<p></p>
|
||||
<div class="tags">
|
||||
|
||||
<h4>Return Value</h4>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td>integer</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h3 id="method_getHeight">
|
||||
<div class="location">in <a href="../../../FFMpeg/Format/DefaultVideo.html#method_getHeight"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 43</div>
|
||||
<code> public integer
|
||||
<strong>getHeight</strong>()</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
<p>Returns the height</p>
|
||||
<p></p>
|
||||
<div class="tags">
|
||||
|
||||
<h4>Return Value</h4>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td>integer</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h3 id="method_setDimensions">
|
||||
<div class="location">in <a href="../../../FFMpeg/Format/DefaultVideo.html#method_setDimensions"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 55</div>
|
||||
<code> public
|
||||
<strong>setDimensions</strong>(integer $width, integer $height)</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
<p>Set the dimensions</p>
|
||||
<p></p>
|
||||
<div class="tags">
|
||||
<h4>Parameters</h4>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td>integer</td>
|
||||
<td>$width</td>
|
||||
<td>The heigth</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>integer</td>
|
||||
<td>$height</td>
|
||||
<td>The width</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
<h4>Exceptions</h4>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h3 id="method_setResizeMode">
|
||||
<div class="location">in <a href="../../../FFMpeg/Format/DefaultVideo.html#method_setResizeMode"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 77</div>
|
||||
<code> public
|
||||
<strong>setResizeMode</strong>(string $mode)</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
<p>Set the resize mode</p>
|
||||
<p></p>
|
||||
<div class="tags">
|
||||
<h4>Parameters</h4>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td>string</td>
|
||||
<td>$mode</td>
|
||||
<td>The mode, one of the self::RESIZEMODE_* constants</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
<h4>Exceptions</h4>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h3 id="method_getResizeMode">
|
||||
<div class="location">in <a href="../../../FFMpeg/Format/DefaultVideo.html#method_getResizeMode"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 95</div>
|
||||
<code> public string
|
||||
<strong>getResizeMode</strong>()</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
<p>Get the current resize mode</p>
|
||||
<p></p>
|
||||
<div class="tags">
|
||||
|
||||
<h4>Return Value</h4>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td>string</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h3 id="method_getFrameRate">
|
||||
<div class="location">in <a href="../../../FFMpeg/Format/DefaultVideo.html#method_getFrameRate"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 103</div>
|
||||
<code> public integer
|
||||
<strong>getFrameRate</strong>()</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
<p>Returns the frame rate</p>
|
||||
<p></p>
|
||||
<div class="tags">
|
||||
|
||||
<h4>Return Value</h4>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td>integer</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h3 id="method_setFrameRate">
|
||||
<div class="location">in <a href="../../../FFMpeg/Format/DefaultVideo.html#method_setFrameRate"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 115</div>
|
||||
<code> public
|
||||
<strong>setFrameRate</strong>(integer $frameRate)</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
<p>Set the framerate</p>
|
||||
<p></p>
|
||||
<div class="tags">
|
||||
<h4>Parameters</h4>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td>integer</td>
|
||||
<td>$frameRate</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
<h4>Exceptions</h4>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h3 id="method_getVideoCodec">
|
||||
<div class="location">in <a href="../../../FFMpeg/Format/DefaultVideo.html#method_getVideoCodec"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 129</div>
|
||||
<code> public
|
||||
<strong>getVideoCodec</strong>()</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
<p>{@inheritdoc}</p>
|
||||
<p></p>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h3 id="method_setVideoCodec">
|
||||
<div class="location">in <a href="../../../FFMpeg/Format/DefaultVideo.html#method_setVideoCodec"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 141</div>
|
||||
<code> public
|
||||
<strong>setVideoCodec</strong>(string $videoCodec)</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
<p>Set the video codec, Should be in the available ones, otherwise an exception is thrown</p>
|
||||
<p></p>
|
||||
<div class="tags">
|
||||
<h4>Parameters</h4>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td>string</td>
|
||||
<td>$videoCodec</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
<h4>Exceptions</h4>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h3 id="method_getGOPsize">
|
||||
<div class="location">in <a href="../../../FFMpeg/Format/DefaultVideo.html#method_getGOPsize"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 158</div>
|
||||
<code> public
|
||||
<strong>getGOPsize</strong>()</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
<p>{@inheritdoc}</p>
|
||||
<p></p>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h3 id="method_setGOPsize">
|
||||
<div class="location">in <a href="../../../FFMpeg/Format/DefaultVideo.html#method_setGOPsize"><abbr title="FFMpeg\Format\DefaultVideo">DefaultVideo</abbr></a> at line 170</div>
|
||||
<code> public
|
||||
<strong>setGOPsize</strong>(integer $GOPsize)</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
<p>Set the GOP size</p>
|
||||
<p></p>
|
||||
<div class="tags">
|
||||
<h4>Parameters</h4>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td>integer</td>
|
||||
<td>$GOPsize</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
<h4>Exceptions</h4>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h3 id="method_getExtraParams">
|
||||
<div class="location">at line 29</div>
|
||||
<code> public
|
||||
<strong>getExtraParams</strong>()</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
<p>{@inheritDoc}</p>
|
||||
<p></p>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h3 id="method_getAvailableAudioCodecs">
|
||||
<div class="location">at line 37</div>
|
||||
<code> public
|
||||
<strong>getAvailableAudioCodecs</strong>()</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
<p>{@inheritDoc}</p>
|
||||
<p></p>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h3 id="method_getAvailableVideoCodecs">
|
||||
<div class="location">at line 45</div>
|
||||
<code> public
|
||||
<strong>getAvailableVideoCodecs</strong>()</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
<p>{@inheritDoc}</p>
|
||||
<p></p>
|
||||
<div class="tags">
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
<div id="footer">
|
||||
Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Loading…
Add table
Add a link
Reference in a new issue