ffmpeg-mappable-media/docs/API/FFMpeg/Format/Video/ResizableVideo.html
2012-05-30 12:37:30 +02:00

234 lines
7.1 KiB
HTML

<!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&nbsp;<a href="../../../FFMpeg/Format/Video.html#method_getVideoCodec"><abbr title="FFMpeg\Format\Video">Video</abbr></a></small></td>
</tr>
<tr>
<td class="type">
integer
</td>
<td class="last">
<a href="#method_getWidth">getWidth</a>()
<p>Returns the width 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>