scratch – Rev 115

Subversion Repositories:
Rev:
<!DOCTYPE html>
<html lang="en">
    <head>
        <meta charset="UTF-8" />
        <meta name="robots" content="index, follow, all" />
        <title>FFMpeg\Filters\Video\ResizeFilter | 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/Filters/Video.html">FFMpeg\Filters\Video</a>\ResizeFilter</h1>
    </div>
        <div class="content">
                <p>    class
    <strong>ResizeFilter</strong>        implements
        <a href="../../../FFMpeg/Filters/Video/VideoFilterInterface.html"><abbr title="FFMpeg\Filters\Video\VideoFilterInterface">VideoFilterInterface</abbr></a></p>

    
            <h2>Constants</h2>

            <table>
                    <tr>
                <td>RESIZEMODE_FIT</td>
                <td class="last">
                    <p><em>fits to the dimensions, might introduce anamorphosis</em></p>
                    <p>
</p>
                </td>
            </tr>
                    <tr>
                <td>RESIZEMODE_INSET</td>
                <td class="last">
                    <p><em>resizes the video inside the given dimension, no anamorphosis</em></p>
                    <p>
</p>
                </td>
            </tr>
                    <tr>
                <td>RESIZEMODE_SCALE_WIDTH</td>
                <td class="last">
                    <p><em>resizes the video to fit the dimension width, no anamorphosis</em></p>
                    <p>
</p>
                </td>
            </tr>
                    <tr>
                <td>RESIZEMODE_SCALE_HEIGHT</td>
                <td class="last">
                    <p><em>resizes the video to fit the dimension height, no anamorphosis</em></p>
                    <p>
</p>
                </td>
            </tr>
            </table>

    
    
            <h2>Methods</h2>

            <table>
                    <tr>
                <td class="type">
                    
                </td>
                <td class="last">
                    <a href="#method___construct">__construct</a>(<a href="../../../FFMpeg/Coordinate/Dimension.html"><abbr title="FFMpeg\Coordinate\Dimension">Dimension</abbr></a> $dimension, $mode = self::RESIZEMODE_FIT, $forceStandards = true, $priority)
                    <p>
</p>
                </td>
                <td></td>
            </tr>
                    <tr>
                <td class="type">
                    integer
                </td>
                <td class="last">
                    <a href="#method_getPriority">getPriority</a>()
                    <p>Returns the priority of the filter.</p>
                </td>
                <td></td>
            </tr>
                    <tr>
                <td class="type">
                    <a href="../../../FFMpeg/Coordinate/Dimension.html"><abbr title="FFMpeg\Coordinate\Dimension">Dimension</abbr></a>
                </td>
                <td class="last">
                    <a href="#method_getDimension">getDimension</a>()
                    <p>
</p>
                </td>
                <td></td>
            </tr>
                    <tr>
                <td class="type">
                    string
                </td>
                <td class="last">
                    <a href="#method_getMode">getMode</a>()
                    <p>
</p>
                </td>
                <td></td>
            </tr>
                    <tr>
                <td class="type">
                    Boolean
                </td>
                <td class="last">
                    <a href="#method_areStandardsForced">areStandardsForced</a>()
                    <p>
</p>
                </td>
                <td></td>
            </tr>
                    <tr>
                <td class="type">
                    array
                </td>
                <td class="last">
                    <a href="#method_apply">apply</a>(<a href="../../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a> $video, <a href="../../../FFMpeg/Format/VideoInterface.html"><abbr title="FFMpeg\Format\VideoInterface">VideoInterfaceOR="#A020F0"></abbr></a> $format)
                    <p>Applies the filter on the the Video media given an format.</p>
                </td>
                <td></td>
            </tr>
            </table>


        <h2>Details</h2>

                        <h3 id="method___construct">
        <div class="location">at line 39</div>
        <code>            public            
    <strong>__construct</strong>(<a href="../../../FFMpeg/Coordinate/Dimension.html"><abbr title="FFMpeg\Coordinate\Dimension">Dimension</abbr></a> $dimension, $mode = self::RESIZEMODE_FIT, $forceStandards = true, $priority)</code>
    </h3>
    <div class="details">
        <p>
</p>
        <p>
</p>
        <div class="tags">
                            <h4>Parameters</h4>

                    <table>
                    <tr>
                <td><a href="../../../FFMpeg/Coordinate/Dimension.html"><abbr title="FFMpeg\Coordinate\Dimension">Dimension</abbr></a></td>
                <td>$dimension</td>
                <td>
</td>
            </tr>
                    <tr>
                <td></td>
                <td>$mode</td>
                <td>
</td>
            </tr>
                    <tr>
                <td></td>
                <td>$forceStandards</td>
                <td>
</td>
            </tr>
                    <tr>
                <td></td>
                <td>$priority</td>
                <td>
</td>
            </tr>
            </table>

            
            
            
                    </div>
    </div>

                <h3 id="method_getPriority">
        <div class="location">at line 50</div>
        <code>            public            integer
    <strong>getPriority</strong>()</code>
    </h3>
    <div class="details">
        <p>Returns the priority of the filter.</p>
        <p>
</p>
        <div class="tags">
            
                            <h4>Return Value</h4>

                    <table>
        <tr>
            <td>integer</td>
            <td>
</td>
        </tr>
    </table>

            
            
                    </div>
    </div>

                <h3 id="method_getDimension">
        <div class="location">at line 58</div>
        <code>            public            <a href="../../../FFMpeg/Coordinate/Dimension.html"><abbr title="FFMpeg\Coordinate\Dimension">Dimension</abbr></a>
    <strong>getDimension</strong>()</code>
    </h3>
    <div class="details">
        <p>
</p>
        <p>
</p>
        <div class="tags">
            
                            <h4>Return Value</h4>

                    <table>
        <tr>
            <td><a href="../../../FFMpeg/Coordinate/Dimension.html"><abbr title="FFMpeg\Coordinate\Dimension">Dimension</abbr></a></td>
            <td>
</td>
        </tr>
    </table>

            
            
                    </div>
    </div>

                <h3 id="method_getMode">
        <div class="location">at line 66</div>
        <code>            public            string
    <strong>getMode</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_areStandardsForced">
        <div class="location">at line 74</div>
        <code>            public            Boolean
    <strong>areStandardsForced</strong>()</code>
    </h3>
    <div class="details">
        <p>
</p>
        <p>
</p>
        <div class="tags">
            
                            <h4>Return Value</h4>

                    <table>
        <tr>
            <td>Boolean</td>
            <td>
</td>
        </tr>
    </table>

            
            
                    </div>
    </div>

                <h3 id="method_apply">
        <div class="location">at line 82</div>
        <code>            public            array
    <strong>apply</strong>(<a href="../../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a> $video, <a href="../../../FFMpeg/Format/VideoInterface.html"><abbr title="FFMpeg\Format\VideoInterface">VideoInterface</abbr></a> $format)</code>
    </h3>
    <div class="details">
        <p>Applies the filter on the the Video media given an format.</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/Format/VideoInterface.html"><abbr title="FFMpeg\Format\VideoInterface">VideoInterface</abbr></a></td>
                <td>$format</td>
                <td>
</td>
            </tr>
            </table>

            
                            <h4>Return Value</h4>

                    <table>
        <tr>
            <td>array</td>
            <td>An array of arguments</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>