scratch – Blame information for rev

Subversion Repositories:
Rev:
Rev Author Line No. Line
115 office 1 <!DOCTYPE html>
2 <html lang="en">
3 <head>
4 <meta charset="UTF-8" />
5 <meta name="robots" content="index, follow, all" />
6 <title>FFMpeg\Coordinate\AspectRatio | PHP-FFMpeg API</title>
7 <link rel="stylesheet" type="text/css" href="../../stylesheet.css">
8 </head>
9 <body id="class">
10 <div class="header">
11 <ul>
12 <li><a href="../../classes.html">Classes</a></li>
13 <li><a href="../../namespaces.html">Namespaces</a></li>
14 <li><a href="../../interfaces.html">Interfaces</a></li>
15 <li><a href="../../traits.html">Traits</a></li>
16 <li><a href="../../doc-index.html">Index</a></li>
17  
18 </ul>
19  
20 <div id="title">PHP-FFMpeg API</div>
21  
22 <div class="type">Class</div>
23 <h1><a href="../../FFMpeg/Coordinate.html">FFMpeg\Coordinate</a>\AspectRatio</h1>
24 </div>
25 <div class="content">
26 <p> class
27 <strong>AspectRatio</strong></p>
28  
29  
30 <h2>Constants</h2>
31  
32 <table>
33 <tr>
34 <td>AR_4_3</td>
35 <td class="last">
36 <p><em>
37 </em></p>
38 <p>
39 </p>
40 </td>
41 </tr>
42 <tr>
43 <td>AR_16_9</td>
44 <td class="last">
45 <p><em>
46 </em></p>
47 <p>
48 </p>
49 </td>
50 </tr>
51 <tr>
52 <td>AR_3_2</td>
53 <td class="last">
54 <p><em>
55 </em></p>
56 <p>
57 </p>
58 </td>
59 </tr>
60 <tr>
61 <td>AR_5_3</td>
62 <td class="last">
63 <p><em>
64 </em></p>
65 <p>
66 </p>
67 </td>
68 </tr>
69 <tr>
70 <td>AR_5_4</td>
71 <td class="last">
72 <p><em>
73 </em></p>
74 <p>
75 </p>
76 </td>
77 </tr>
78 <tr>
79 <td>AR_1_1</td>
80 <td class="last">
81 <p><em>
82 </em></p>
83 <p>
84 </p>
85 </td>
86 </tr>
87 <tr>
88 <td>AR_1_DOT_85_1</td>
89 <td class="last">
90 <p><em>
91 </em></p>
92 <p>
93 </p>
94 </td>
95 </tr>
96 <tr>
97 <td>AR_2_DOT_39_1</td>
98 <td class="last">
99 <p><em>
100 </em></p>
101 <p>
102 </p>
103 </td>
104 </tr>
105 <tr>
106 <td>AR_ROTATED_3_4</td>
107 <td class="last">
108 <p><em>
109 </em></p>
110 <p>
111 </p>
112 </td>
113 </tr>
114 <tr>
115 <td>AR_ROTATED_9_16</td>
116 <td class="last">
117 <p><em>
118 </em></p>
119 <p>
120 </p>
121 </td>
122 </tr>
123 <tr>
124 <td>AR_ROTATED_2_3</td>
125 <td class="last">
126 <p><em>
127 </em></p>
128 <p>
129 </p>
130 </td>
131 </tr>
132 <tr>
133 <td>AR_ROTATED_3_5</td>
134 <td class="last">
135 <p><em>
136 </em></p>
137 <p>
138 </p>
139 </td>
140 </tr>
141 <tr>
142 <td>AR_ROTATED_4_5</td>
143 <td class="last">
144 <p><em>
145 </em></p>
146 <p>
147 </p>
148 </td>
149 </tr>
150 <tr>
151 <td>AR_ROTATED_1_DOT_85</td>
152 <td class="last">
153 <p><em>
154 </em></p>
155 <p>
156 </p>
157 </td>
158 </tr>
159 <tr>
160 <td>AR_ROTATED_2_DOT_39</td>
161 <td class="last">
162 <p><em>
163 </em></p>
164 <p>
165 </p>
166 </td>
167 </tr>
168 </table>
169  
170  
171  
172 <h2>Methods</h2>
173  
174 <table>
175 <tr>
176 <td class="type">
177  
178 </td>
179 <td class="last">
180 <a href="#method___construct">__construct</a>($ratio)
181 <p>
182 </p>
183 </td>
184 <td></td>
185 </tr>
186 <tr>
187 <td class="type">
188 float
189 </td>
190 <td class="last">
191 <a href="#method_getValue">getValue</a>()
192 <p>Returns the value of the ratio.</p>
193 </td>
194 <td></td>
195 </tr>
196 <tr>
197 <td class="type">
198 Integer
199 </td>
200 <td class="last">
201 <a href="#method_calculateWidth">calculateWidth</a>(Integer $height, Integer $modulus = 1)
202 <p>Computes the best width for given height and modulus.</p>
203 </td>
204 <td></td>
205 </tr>
206 <tr>
207 <td class="type">
208 Integer
209 </td>
210 <td class="last">
211 <a href="#method_calculateHeight">calculateHeight</a>(Integer $width, Integer $modulus = 1)
212 <p>Computes the best height for given width and modulus.</p>
213 </td>
214 <td></td>
215 </tr>
216 <tr>
217 <td class="type">
218 static&nbsp;<a href="../../FFMpeg/Coordinate/AspectRatio.html"><abbr title="FFMpeg\Coordinate\AspectRatio">AspectRatio</abbr></a>
219 </td>
220 <td class="last">
221 <a href="#method_create">create</a>(<a href="../../FFMpeg/Coordinate/Dimension.html"><abbr title="FFMpeg\Coordinate\Dimension">Dimension</abbr></a> $dimension, Boolean $forceStandards = true)
222 <p>Creates a ratio based on Dimension.</p>
223 </td>
224 <td></td>
225 </tr>
226 </table>
227  
228  
229 <h2>Details</h2>
230  
231 <h3 id="method___construct">
232 <div class="location">at line 61</div>
233 <code> public
234 <strong>__construct</strong>($ratio)</code>
235 </h3>
236 <div class="details">
237 <p>
238 </p>
239 <p>
240 </p>
241 <div class="tags">
242 <h4>Parameters</h4>
243  
244 <table>
245 <tr>
246 <td></td>
247 <td>$ratio</td>
248 <td>
249 </td>
250 </tr>
251 </table>
252  
253  
254  
255  
256 </div>
257 </div>
258  
259 <h3 id="method_getValue">
260 <div class="location">at line 71</div>
261 <code> public float
262 <strong>getValue</strong>()</code>
263 </h3>
264 <div class="details">
265 <p>Returns the value of the ratio.</p>
266 <p>
267 </p>
268 <div class="tags">
269  
270 <h4>Return Value</h4>
271  
272 <table>
273 <tr>
274 <td>float</td>
275 <td>
276 </td>
277 </tr>
278 </table>
279  
280  
281  
282 </div>
283 </div>
284  
285 <h3 id="method_calculateWidth">
286 <div class="location">at line 84</div>
287 <code> public Integer
288 <strong>calculateWidth</strong>(Integer $height, Integer $modulus = 1)</code>
289 </h3>
290 <div class="details">
291 <p>Computes the best width for given height and modulus.</p>
292 <p>
293 </p>
294 <div class="tags">
295 <h4>Parameters</h4>
296  
297 <table>
298 <tr>
299 <td>Integer</td>
300 <td>$height</td>
301 <td>
302 </td>
303 </tr>
304 <tr>
305 <td>Integer</td>
306 <td>$modulus</td>
307 <td>
308 </td>
309 </tr>
310 </table>
311  
312  
313 <h4>Return Value</h4>
314  
315 <table>
316 <tr>
317 <td>Integer</td>
318 <td>
319 </td>
320 </tr>
321 </table>
322  
323  
324  
325 </div>
326 </div>
327  
328 <h3 id="method_calculateHeight">
329 <div class="location">at line 103</div>
330 <code> public Integer
331 <strong>calculateHeight</strong>(Integer $width, Integer $modulus = 1)</code>
332 </h3>
333 <div class="details">
334 <p>Computes the best height for given width and modulus.</p>
335 <p>
336 </p>
337 <div class="tags">
338 <h4>Parameters</h4>
339  
340 <table>
341 <tr>
342 <td>Integer</td>
343 <td>$width</td>
344 <td>
345 </td>
346 </tr>
347 <tr>
348 <td>Integer</td>
349 <td>$modulus</td>
350 <td>
351 </td>
352 </tr>
353 </table>
354  
355  
356 <h4>Return Value</h4>
357  
358 <table>
359 <tr>
360 <td>Integer</td>
361 <td>
362 </td>
363 </tr>
364 </table>
365  
366  
367  
368 </div>
369 </div>
370  
371 <h3 id="method_create">
372 <div class="location">at line 145</div>
373 <code> static public <a href="../../FFMpeg/Coordinate/AspectRatio.html"><abbr title="FFMpeg\Coordinate\AspectRatio">AspectRatio</abbr></a>
374 <strong>create</strong>(<a href="../../FFMpeg/Coordinate/Dimension.html"><abbr title="FFMpeg\Coordinate\Dimension">Dimension</abbr></a> $dimension, Boolean $forceStandards = true)</code>
375 </h3>
376 <div class="details">
377 <p>Creates a ratio based on Dimension.</p>
378 <p>The strategy parameter forces by default to use standardized ratios. If
379 custom ratio need to be used, disable it.</p>
380 <div class="tags">
381 <h4>Parameters</h4>
382  
383 <table>
384 <tr>
385 <td><a href="../../FFMpeg/Coordinate/Dimension.html"><abbr title="FFMpeg\Coordinate\Dimension">Dimension</abbr></a></td>
386 <td>$dimension</td>
387 <td>
388 </td>
389 </tr>
390 <tr>
391 <td>Boolean</td>
392 <td>$forceStandards</td>
393 <td>Whether to force or not standard ratios</td>
394 </tr>
395 </table>
396  
397  
398 <h4>Return Value</h4>
399  
400 <table>
401 <tr>
402 <td><a href="../../FFMpeg/Coordinate/AspectRatio.html"><abbr title="FFMpeg\Coordinate\AspectRatio">AspectRatio</abbr></a></td>
403 <td>
404 </td>
405 </tr>
406 </table>
407  
408  
409 <h4>Exceptions</h4>
410  
411 <table>
412 <tr>
413 <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td>
414 <td>
415 </td>
416 </tr>
417 </table>
418  
419  
420 </div>
421 </div>
422  
423  
424 </div>
425 <div id="footer">
426 Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>.
427 </div>
428 </body>
429 </html>