/vendor/php-ffmpeg/php-ffmpeg/docs/source/API/API/FFMpeg/Media/Frame.html |
@@ -0,0 +1,621 @@ |
<!DOCTYPE html> |
<html lang="en"> |
<head> |
<meta charset="UTF-8" /> |
<meta name="robots" content="index, follow, all" /> |
<title>FFMpeg\Media\Frame | PHP-FFMpeg API</title> |
<link rel="stylesheet" type="text/css" href="../../stylesheet.css"> |
</head> |
<body id="class"> |
<div class="header"> |
<ul> |
<li><a href="../../classes.html">Classes</a></li> |
<li><a href="../../namespaces.html">Namespaces</a></li> |
<li><a href="../../interfaces.html">Interfaces</a></li> |
<li><a href="../../traits.html">Traits</a></li> |
<li><a href="../../doc-index.html">Index</a></li> |
|
</ul> |
|
<div id="title">PHP-FFMpeg API</div> |
|
<div class="type">Class</div> |
<h1><a href="../../FFMpeg/Media.html">FFMpeg\Media</a>\Frame</h1> |
</div> |
<div class="content"> |
<p> class |
<strong>Frame</strong> extends <a href="../../FFMpeg/Media/AbstractMediaType.html"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></p> |
|
|
|
|
<h2>Methods</h2> |
|
<table> |
<tr> |
<td class="type"> |
|
</td> |
<td class="last"> |
<a href="#method___construct">__construct</a>(<a href="../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a> $video, <a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> $driver, <a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe, <a href="../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a> $timecode) |
<p> |
</p> |
</td> |
<td></td> |
</tr> |
<tr> |
<td class="type"> |
<a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> |
</td> |
<td class="last"> |
<a href="#method_getFFMpegDriver">getFFMpegDriver</a>() |
<p> |
</p> |
</td> |
<td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFFMpegDriver"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
</tr> |
<tr> |
<td class="type"> |
<a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
</td> |
<td class="last"> |
<a href="#method_setFFMpegDriver">setFFMpegDriver</a>(<a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> $driver) |
<p> |
</p> |
</td> |
<td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFFMpegDriver"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
</tr> |
<tr> |
<td class="type"> |
<a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> |
</td> |
<td class="last"> |
<a href="#method_getFFProbe">getFFProbe</a>() |
<p> |
</p> |
</td> |
<td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFFProbe"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
</tr> |
<tr> |
<td class="type"> |
<a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
</td> |
<td class="last"> |
<a href="#method_setFFProbe">setFFProbe</a>(<a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe) |
<p> |
</p> |
</td> |
<td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFFProbe"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
</tr> |
<tr> |
<td class="type"> |
string |
</td> |
<td class="last"> |
<a href="#method_getPathfile">getPathfile</a>() |
<p> |
</p> |
</td> |
<td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getPathfile"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
</tr> |
<tr> |
<td class="type"> |
<a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
</td> |
<td class="last"> |
<a href="#method_setFiltersCollection">setFiltersCollection</a>(<a href="../../FFMpeg/Filters/FiltersCollection.html"><abbr title="FFMpeg\Filters\FiltersCollection">FiltersCollection</abbr></a> $filters) |
<p> |
</p> |
</td> |
<td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFiltersCollection"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
</tr> |
<tr> |
<td class="type"> |
<a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
</td> |
<td class="last"> |
<a href="#method_getFiltersCollection">getFiltersCollection</a>() |
<p> |
</p> |
</td> |
<td><small>from <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFiltersCollection"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td> |
</tr> |
<tr> |
<td class="type"> |
<a href="../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a> |
</td> |
<td class="last"> |
<a href="#method_getVideo">getVideo</a>() |
<p>Returns the video related to the frame.</p> |
</td> |
<td></td> |
</tr> |
<tr> |
<td class="type"> |
<a href="../../FFMpeg/Filters/Frame/FrameFilters.html"><abbr title="FFMpeg\Filters\Frame\FrameFilters">FrameFilters</abbr></a> |
</td> |
<td class="last"> |
<a href="#method_filters">filters</a>() |
<p>Returns the available filters.</p> |
</td> |
<td></td> |
</tr> |
<tr> |
<td class="type"> |
<a href="../../FFMpeg/Media/Frame.html"><abbr title="FFMpeg\Media\Frame">Frame</abbr></a> |
</td> |
<td class="last"> |
<a href="#method_addFilter">addFilter</a>(<a href="../../FFMpeg/Filters/Frame/FrameFilterInterface.html"><abbr title="FFMpeg\Filters\Frame\FrameFilterInterface">FrameFilterInterface</abbr></a> $filter) |
<p>{@inheritdoc}</p> |
</td> |
<td></td> |
</tr> |
<tr> |
<td class="type"> |
<a href="../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a> |
</td> |
<td class="last"> |
<a href="#method_getTimeCode">getTimeCode</a>() |
<p> |
</p> |
</td> |
<td></td> |
</tr> |
<tr> |
<td class="type"> |
<a href="../../FFMpeg/Media/Frame.html"><abbr title="FFMpeg\Media\Frame">Frame</abbr></a> |
</td> |
<td class="last"> |
<a href="#method_save">save</a>(string $pathfile, Boolean $accurate = false) |
<p>Saves the frame in the given filename.</p> |
</td> |
<td></td> |
</tr> |
</table> |
|
|
<h2>Details</h2> |
|
<h3 id="method___construct"> |
<div class="location">at line 29</div> |
<code> public |
<strong>__construct</strong>(<a href="../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a> $video, <a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> $driver, <a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe, <a href="../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a> $timecode)</code> |
</h3> |
<div class="details"> |
<p> |
</p> |
<p> |
</p> |
<div class="tags"> |
<h4>Parameters</h4> |
|
<table> |
<tr> |
<td><a href="../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a></td> |
<td>$video</td> |
<td> |
</td> |
</tr> |
<tr> |
<td><a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a></td> |
<td>$driver</td> |
<td> |
</td> |
</tr> |
<tr> |
<td><a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
<td>$ffprobe</td> |
<td> |
</td> |
</tr> |
<tr> |
<td><a href="../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a></td> |
<td>$timecode</td> |
<td> |
</td> |
</tr> |
</table> |
|
|
|
|
</div> |
</div> |
|
<h3 id="method_getFFMpegDriver"> |
<div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFFMpegDriver"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 40</div> |
<code> public <a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> |
<strong>getFFMpegDriver</strong>()</code> |
</h3> |
<div class="details"> |
<p> |
</p> |
<p> |
</p> |
<div class="tags"> |
|
<h4>Return Value</h4> |
|
<table> |
<tr> |
<td><a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a></td> |
<td> |
</td> |
</tr> |
</table> |
|
|
|
</div> |
</div> |
|
<h3 id="method_setFFMpegDriver"> |
<div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFFMpegDriver"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 50</div> |
<code> public <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
<strong>setFFMpegDriver</strong>(<a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> $driver)</code> |
</h3> |
<div class="details"> |
<p> |
</p> |
<p> |
</p> |
<div class="tags"> |
<h4>Parameters</h4> |
|
<table> |
<tr> |
<td><a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a></td> |
<td>$driver</td> |
<td> |
</td> |
</tr> |
</table> |
|
|
<h4>Return Value</h4> |
|
<table> |
<tr> |
<td><a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td> |
<td> |
</td> |
</tr> |
</table> |
|
|
|
</div> |
</div> |
|
<h3 id="method_getFFProbe"> |
<div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFFProbe"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 60</div> |
<code> public <a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> |
<strong>getFFProbe</strong>()</code> |
</h3> |
<div class="details"> |
<p> |
</p> |
<p> |
</p> |
<div class="tags"> |
|
<h4>Return Value</h4> |
|
<table> |
<tr> |
<td><a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
<td> |
</td> |
</tr> |
</table> |
|
|
|
</div> |
</div> |
|
<h3 id="method_setFFProbe"> |
<div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFFProbe"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 70</div> |
<code> public <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
<strong>setFFProbe</strong>(<a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe)</code> |
</h3> |
<div class="details"> |
<p> |
</p> |
<p> |
</p> |
<div class="tags"> |
<h4>Parameters</h4> |
|
<table> |
<tr> |
<td><a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td> |
<td>$ffprobe</td> |
<td> |
</td> |
</tr> |
</table> |
|
|
<h4>Return Value</h4> |
|
<table> |
<tr> |
<td><a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td> |
<td> |
</td> |
</tr> |
</table> |
|
|
|
</div> |
</div> |
|
<h3 id="method_getPathfile"> |
<div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getPathfile"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 80</div> |
<code> public string |
<strong>getPathfile</strong>()</code> |
</h3> |
<div class="details"> |
<p> |
</p> |
<p> |
</p> |
<div class="tags"> |
|
<h4>Return Value</h4> |
|
<table> |
<tr> |
<td>string</td> |
<td> |
</td> |
</tr> |
</table> |
|
|
|
</div> |
</div> |
|
<h3 id="method_setFiltersCollection"> |
<div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFiltersCollection"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 90</div> |
<code> public <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
<strong>setFiltersCollection</strong>(<a href="../../FFMpeg/Filters/FiltersCollection.html"><abbr title="FFMpeg\Filters\FiltersCollection">FiltersCollection</abbr></a> $filters)</code> |
</h3> |
<div class="details"> |
<p> |
</p> |
<p> |
</p> |
<div class="tags"> |
<h4>Parameters</h4> |
|
<table> |
<tr> |
<td><a href="../../FFMpeg/Filters/FiltersCollection.html"><abbr title="FFMpeg\Filters\FiltersCollection">FiltersCollection</abbr></a></td> |
<td>$filters</td> |
<td> |
</td> |
</tr> |
</table> |
|
|
<h4>Return Value</h4> |
|
<table> |
<tr> |
<td><a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td> |
<td> |
</td> |
</tr> |
</table> |
|
|
|
</div> |
</div> |
|
<h3 id="method_getFiltersCollection"> |
<div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFiltersCollection"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 100</div> |
<code> public <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a> |
<strong>getFiltersCollection</strong>()</code> |
</h3> |
<div class="details"> |
<p> |
</p> |
<p> |
</p> |
<div class="tags"> |
|
<h4>Return Value</h4> |
|
<table> |
<tr> |
<td><a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td> |
<td> |
</td> |
</tr> |
</table> |
|
|
|
</div> |
</div> |
|
<h3 id="method_getVideo"> |
<div class="location">at line 41</div> |
<code> public <a href="../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a> |
<strong>getVideo</strong>()</code> |
</h3> |
<div class="details"> |
<p>Returns the video related to the frame.</p> |
<p> |
</p> |
<div class="tags"> |
|
<h4>Return Value</h4> |
|
<table> |
<tr> |
<td><a href="../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a></td> |
<td> |
</td> |
</tr> |
</table> |
|
|
|
</div> |
</div> |
|
<h3 id="method_filters"> |
<div class="location">at line 51</div> |
<code> public <a href="../../FFMpeg/Filters/Frame/FrameFilters.html"><abbr title="FFMpeg\Filters\Frame\FrameFilters">FrameFilters</abbr></a> |
<strong>filters</strong>()</code> |
</h3> |
<div class="details"> |
<p>Returns the available filters.</p> |
<p> |
</p> |
<div class="tags"> |
|
<h4>Return Value</h4> |
|
<table> |
<tr> |
<td><a href="../../FFMpeg/Filters/Frame/FrameFilters.html"><abbr title="FFMpeg\Filters\Frame\FrameFilters">FrameFilters</abbr></a></td> |
<td> |
</td> |
</tr> |
</table> |
|
|
|
</div> |
</div> |
|
<h3 id="method_addFilter"> |
<div class="location">at line 61</div> |
<code> public <a href="../../FFMpeg/Media/Frame.html"><abbr title="FFMpeg\Media\Frame">Frame</abbr></a> |
<strong>addFilter</strong>(<a href="../../FFMpeg/Filters/Frame/FrameFilterInterface.html"><abbr title="FFMpeg\Filters\Frame\FrameFilterInterface">FrameFilterInterface</abbr></a> $filter)</code> |
</h3> |
<div class="details"> |
<p>{@inheritdoc}</p> |
<p> |
</p> |
<div class="tags"> |
<h4>Parameters</h4> |
|
<table> |
<tr> |
<td><a href="../../FFMpeg/Filters/Frame/FrameFilterInterface.html"><abbr title="FFMpeg\Filters\Frame\FrameFilterInterface">FrameFilterInterface</abbr></a></td> |
<td>$filter</td> |
<td> |
</td> |
</tr> |
</table> |
|
|
<h4>Return Value</h4> |
|
<table> |
<tr> |
<td><a href="../../FFMpeg/Media/Frame.html"><abbr title="FFMpeg\Media\Frame">Frame</abbr></a></td> |
<td> |
</td> |
</tr> |
</table> |
|
|
|
</div> |
</div> |
|
<h3 id="method_getTimeCode"> |
<div class="location">at line 71</div> |
<code> public <a href="../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a> |
<strong>getTimeCode</strong>()</code> |
</h3> |
<div class="details"> |
<p> |
</p> |
<p> |
</p> |
<div class="tags"> |
|
<h4>Return Value</h4> |
|
<table> |
<tr> |
<td><a href="../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a></td> |
<td> |
</td> |
</tr> |
</table> |
|
|
|
</div> |
</div> |
|
<h3 id="method_save"> |
<div class="location">at line 88</div> |
<code> public <a href="../../FFMpeg/Media/Frame.html"><abbr title="FFMpeg\Media\Frame">Frame</abbr></a> |
<strong>save</strong>(string $pathfile, Boolean $accurate = false)</code> |
</h3> |
<div class="details"> |
<p>Saves the frame in the given filename.</p> |
<p>Uses the <code>unaccurate method by default.</code></p> |
<div class="tags"> |
<h4>Parameters</h4> |
|
<table> |
<tr> |
<td>string</td> |
<td>$pathfile</td> |
<td> |
</td> |
</tr> |
<tr> |
<td>Boolean</td> |
<td>$accurate</td> |
<td> |
</td> |
</tr> |
</table> |
|
|
<h4>Return Value</h4> |
|
<table> |
<tr> |
<td><a href="../../FFMpeg/Media/Frame.html"><abbr title="FFMpeg\Media\Frame">Frame</abbr></a></td> |
<td> |
</td> |
</tr> |
</table> |
|
|
<h4>Exceptions</h4> |
|
<table> |
<tr> |
<td><a href="http://php.net/RuntimeException"><abbr title="RuntimeException">RuntimeException</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> |