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\Media\Frame | 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/Media.html">FFMpeg\Media</a>\Frame</h1>
24 </div>
25 <div class="content">
26 <p> class
27 <strong>Frame</strong> extends <a href="../../FFMpeg/Media/AbstractMediaType.html"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></p>
28  
29  
30  
31  
32 <h2>Methods</h2>
33  
34 <table>
35 <tr>
36 <td class="type">
37  
38 </td>
39 <td class="last">
40 <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)
41 <p>
42 </p>
43 </td>
44 <td></td>
45 </tr>
46 <tr>
47 <td class="type">
48 <a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a>
49 </td>
50 <td class="last">
51 <a href="#method_getFFMpegDriver">getFFMpegDriver</a>()
52 <p>
53 </p>
54 </td>
55 <td><small>from&nbsp;<a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFFMpegDriver"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td>
56 </tr>
57 <tr>
58 <td class="type">
59 <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a>
60 </td>
61 <td class="last">
62 <a href="#method_setFFMpegDriver">setFFMpegDriver</a>(<a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> $driver)
63 <p>
64 </p>
65 </td>
66 <td><small>from&nbsp;<a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFFMpegDriver"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td>
67 </tr>
68 <tr>
69 <td class="type">
70 <a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a>
71 </td>
72 <td class="last">
73 <a href="#method_getFFProbe">getFFProbe</a>()
74 <p>
75 </p>
76 </td>
77 <td><small>from&nbsp;<a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFFProbe"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td>
78 </tr>
79 <tr>
80 <td class="type">
81 <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a>
82 </td>
83 <td class="last">
84 <a href="#method_setFFProbe">setFFProbe</a>(<a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe)
85 <p>
86 </p>
87 </td>
88 <td><small>from&nbsp;<a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFFProbe"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td>
89 </tr>
90 <tr>
91 <td class="type">
92 string
93 </td>
94 <td class="last">
95 <a href="#method_getPathfile">getPathfile</a>()
96 <p>
97 </p>
98 </td>
99 <td><small>from&nbsp;<a href="../../FFMpeg/Media/AbstractMediaType.html#method_getPathfile"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td>
100 </tr>
101 <tr>
102 <td class="type">
103 <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a>
104 </td>
105 <td class="last">
106 <a href="#method_setFiltersCollection">setFiltersCollection</a>(<a href="../../FFMpeg/Filters/FiltersCollection.html"><abbr title="FFMpeg\Filters\FiltersCollection">FiltersCollection</abbr></a> $filters)
107 <p>
108 </p>
109 </td>
110 <td><small>from&nbsp;<a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFiltersCollection"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td>
111 </tr>
112 <tr>
113 <td class="type">
114 <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a>
115 </td>
116 <td class="last">
117 <a href="#method_getFiltersCollection">getFiltersCollection</a>()
118 <p>
119 </p>
120 </td>
121 <td><small>from&nbsp;<a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFiltersCollection"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a></small></td>
122 </tr>
123 <tr>
124 <td class="type">
125 <a href="../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a>
126 </td>
127 <td class="last">
128 <a href="#method_getVideo">getVideo</a>()
129 <p>Returns the video related to the frame.</p>
130 </td>
131 <td></td>
132 </tr>
133 <tr>
134 <td class="type">
135 <a href="../../FFMpeg/Filters/Frame/FrameFilters.html"><abbr title="FFMpeg\Filters\Frame\FrameFilters">FrameFilters</abbr></a>
136 </td>
137 <td class="last">
138 <a href="#method_filters">filters</a>()
139 <p>Returns the available filters.</p>
140 </td>
141 <td></td>
142 </tr>
143 <tr>
144 <td class="type">
145 <a href="../../FFMpeg/Media/Frame.html"><abbr title="FFMpeg\Media\Frame">Frame</abbr></a>
146 </td>
147 <td class="last">
148 <a href="#method_addFilter">addFilter</a>(<a href="../../FFMpeg/Filters/Frame/FrameFilterInterface.html"><abbr title="FFMpeg\Filters\Frame\FrameFilterInterface">FrameFilterInterface</abbr></a> $filter)
149 <p>{@inheritdoc}</p>
150 </td>
151 <td></td>
152 </tr>
153 <tr>
154 <td class="type">
155 <a href="../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a>
156 </td>
157 <td class="last">
158 <a href="#method_getTimeCode">getTimeCode</a>()
159 <p>
160 </p>
161 </td>
162 <td></td>
163 </tr>
164 <tr>
165 <td class="type">
166 <a href="../../FFMpeg/Media/Frame.html"><abbr title="FFMpeg\Media\Frame">Frame</abbr></a>
167 </td>
168 <td class="last">
169 <a href="#method_save">save</a>(string $pathfile, Boolean $accurate = false)
170 <p>Saves the frame in the given filename.</p>
171 </td>
172 <td></td>
173 </tr>
174 </table>
175  
176  
177 <h2>Details</h2>
178  
179 <h3 id="method___construct">
180 <div class="location">at line 29</div>
181 <code> public
182 <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>
183 </h3>
184 <div class="details">
185 <p>
186 </p>
187 <p>
188 </p>
189 <div class="tags">
190 <h4>Parameters</h4>
191  
192 <table>
193 <tr>
194 <td><a href="../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a></td>
195 <td>$video</td>
196 <td>
197 </td>
198 </tr>
199 <tr>
200 <td><a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a></td>
201 <td>$driver</td>
202 <td>
203 </td>
204 </tr>
205 <tr>
206 <td><a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td>
207 <td>$ffprobe</td>
208 <td>
209 </td>
210 </tr>
211 <tr>
212 <td><a href="../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a></td>
213 <td>$timecode</td>
214 <td>
215 </td>
216 </tr>
217 </table>
218  
219  
220  
221  
222 </div>
223 </div>
224  
225 <h3 id="method_getFFMpegDriver">
226 <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFFMpegDriver"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 40</div>
227 <code> public <a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a>
228 <strong>getFFMpegDriver</strong>()</code>
229 </h3>
230 <div class="details">
231 <p>
232 </p>
233 <p>
234 </p>
235 <div class="tags">
236  
237 <h4>Return Value</h4>
238  
239 <table>
240 <tr>
241 <td><a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a></td>
242 <td>
243 </td>
244 </tr>
245 </table>
246  
247  
248  
249 </div>
250 </div>
251  
252 <h3 id="method_setFFMpegDriver">
253 <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFFMpegDriver"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 50</div>
254 <code> public <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a>
255 <strong>setFFMpegDriver</strong>(<a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a> $driver)</code>
256 </h3>
257 <div class="details">
258 <p>
259 </p>
260 <p>
261 </p>
262 <div class="tags">
263 <h4>Parameters</h4>
264  
265 <table>
266 <tr>
267 <td><a href="../../FFMpeg/Driver/FFMpegDriver.html"><abbr title="FFMpeg\Driver\FFMpegDriver">FFMpegDriver</abbr></a></td>
268 <td>$driver</td>
269 <td>
270 </td>
271 </tr>
272 </table>
273  
274  
275 <h4>Return Value</h4>
276  
277 <table>
278 <tr>
279 <td><a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td>
280 <td>
281 </td>
282 </tr>
283 </table>
284  
285  
286  
287 </div>
288 </div>
289  
290 <h3 id="method_getFFProbe">
291 <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFFProbe"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 60</div>
292 <code> public <a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a>
293 <strong>getFFProbe</strong>()</code>
294 </h3>
295 <div class="details">
296 <p>
297 </p>
298 <p>
299 </p>
300 <div class="tags">
301  
302 <h4>Return Value</h4>
303  
304 <table>
305 <tr>
306 <td><a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td>
307 <td>
308 </td>
309 </tr>
310 </table>
311  
312  
313  
314 </div>
315 </div>
316  
317 <h3 id="method_setFFProbe">
318 <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFFProbe"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 70</div>
319 <code> public <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a>
320 <strong>setFFProbe</strong>(<a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $ffprobe)</code>
321 </h3>
322 <div class="details">
323 <p>
324 </p>
325 <p>
326 </p>
327 <div class="tags">
328 <h4>Parameters</h4>
329  
330 <table>
331 <tr>
332 <td><a href="../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td>
333 <td>$ffprobe</td>
334 <td>
335 </td>
336 </tr>
337 </table>
338  
339  
340 <h4>Return Value</h4>
341  
342 <table>
343 <tr>
344 <td><a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td>
345 <td>
346 </td>
347 </tr>
348 </table>
349  
350  
351  
352 </div>
353 </div>
354  
355 <h3 id="method_getPathfile">
356 <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getPathfile"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 80</div>
357 <code> public string
358 <strong>getPathfile</strong>()</code>
359 </h3>
360 <div class="details">
361 <p>
362 </p>
363 <p>
364 </p>
365 <div class="tags">
366  
367 <h4>Return Value</h4>
368  
369 <table>
370 <tr>
371 <td>string</td>
372 <td>
373 </td>
374 </tr>
375 </table>
376  
377  
378  
379 </div>
380 </div>
381  
382 <h3 id="method_setFiltersCollection">
383 <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_setFiltersCollection"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 90</div>
384 <code> public <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a>
385 <strong>setFiltersCollection</strong>(<a href="../../FFMpeg/Filters/FiltersCollection.html"><abbr title="FFMpeg\Filters\FiltersCollection">FiltersCollection</abbr></a> $filters)</code>
386 </h3>
387 <div class="details">
388 <p>
389 </p>
390 <p>
391 </p>
392 <div class="tags">
393 <h4>Parameters</h4>
394  
395 <table>
396 <tr>
397 <td><a href="../../FFMpeg/Filters/FiltersCollection.html"><abbr title="FFMpeg\Filters\FiltersCollection">FiltersCollection</abbr></a></td>
398 <td>$filters</td>
399 <td>
400 </td>
401 </tr>
402 </table>
403  
404  
405 <h4>Return Value</h4>
406  
407 <table>
408 <tr>
409 <td><a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td>
410 <td>
411 </td>
412 </tr>
413 </table>
414  
415  
416  
417 </div>
418 </div>
419  
420 <h3 id="method_getFiltersCollection">
421 <div class="location">in <a href="../../FFMpeg/Media/AbstractMediaType.html#method_getFiltersCollection"><abbr title="FFMpeg\Media\AbstractMediaType">AbstractMediaType</abbr></a> at line 100</div>
422 <code> public <a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a>
423 <strong>getFiltersCollection</strong>()</code>
424 </h3>
425 <div class="details">
426 <p>
427 </p>
428 <p>
429 </p>
430 <div class="tags">
431  
432 <h4>Return Value</h4>
433  
434 <table>
435 <tr>
436 <td><a href="../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td>
437 <td>
438 </td>
439 </tr>
440 </table>
441  
442  
443  
444 </div>
445 </div>
446  
447 <h3 id="method_getVideo">
448 <div class="location">at line 41</div>
449 <code> public <a href="../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a>
450 <strong>getVideo</strong>()</code>
451 </h3>
452 <div class="details">
453 <p>Returns the video related to the frame.</p>
454 <p>
455 </p>
456 <div class="tags">
457  
458 <h4>Return Value</h4>
459  
460 <table>
461 <tr>
462 <td><a href="../../FFMpeg/Media/Video.html"><abbr title="FFMpeg\Media\Video">Video</abbr></a></td>
463 <td>
464 </td>
465 </tr>
466 </table>
467  
468  
469  
470 </div>
471 </div>
472  
473 <h3 id="method_filters">
474 <div class="location">at line 51</div>
475 <code> public <a href="../../FFMpeg/Filters/Frame/FrameFilters.html"><abbr title="FFMpeg\Filters\Frame\FrameFilters">FrameFilters</abbr></a>
476 <strong>filters</strong>()</code>
477 </h3>
478 <div class="details">
479 <p>Returns the available filters.</p>
480 <p>
481 </p>
482 <div class="tags">
483  
484 <h4>Return Value</h4>
485  
486 <table>
487 <tr>
488 <td><a href="../../FFMpeg/Filters/Frame/FrameFilters.html"><abbr title="FFMpeg\Filters\Frame\FrameFilters">FrameFilters</abbr></a></td>
489 <td>
490 </td>
491 </tr>
492 </table>
493  
494  
495  
496 </div>
497 </div>
498  
499 <h3 id="method_addFilter">
500 <div class="location">at line 61</div>
501 <code> public <a href="../../FFMpeg/Media/Frame.html"><abbr title="FFMpeg\Media\Frame">Frame</abbr></a>
502 <strong>addFilter</strong>(<a href="../../FFMpeg/Filters/Frame/FrameFilterInterface.html"><abbr title="FFMpeg\Filters\Frame\FrameFilterInterface">FrameFilterInterface</abbr></a> $filter)</code>
503 </h3>
504 <div class="details">
505 <p>{@inheritdoc}</p>
506 <p>
507 </p>
508 <div class="tags">
509 <h4>Parameters</h4>
510  
511 <table>
512 <tr>
513 <td><a href="../../FFMpeg/Filters/Frame/FrameFilterInterface.html"><abbr title="FFMpeg\Filters\Frame\FrameFilterInterface">FrameFilterInterface</abbr></a></td>
514 <td>$filter</td>
515 <td>
516 </td>
517 </tr>
518 </table>
519  
520  
521 <h4>Return Value</h4>
522  
523 <table>
524 <tr>
525 <td><a href="../../FFMpeg/Media/Frame.html"><abbr title="FFMpeg\Media\Frame">Frame</abbr></a></td>
526 <td>
527 </td>
528 </tr>
529 </table>
530  
531  
532  
533 </div>
534 </div>
535  
536 <h3 id="method_getTimeCode">
537 <div class="location">at line 71</div>
538 <code> public <a href="../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a>
539 <strong>getTimeCode</strong>()</code>
540 </h3>
541 <div class="details">
542 <p>
543 </p>
544 <p>
545 </p>
546 <div class="tags">
547  
548 <h4>Return Value</h4>
549  
550 <table>
551 <tr>
552 <td><a href="../../FFMpeg/Coordinate/TimeCode.html"><abbr title="FFMpeg\Coordinate\TimeCode">TimeCode</abbr></a></td>
553 <td>
554 </td>
555 </tr>
556 </table>
557  
558  
559  
560 </div>
561 </div>
562  
563 <h3 id="method_save">
564 <div class="location">at line 88</div>
565 <code> public <a href="../../FFMpeg/Media/Frame.html"><abbr title="FFMpeg\Media\Frame">Frame</abbr></a>
566 <strong>save</strong>(string $pathfile, Boolean $accurate = false)</code>
567 </h3>
568 <div class="details">
569 <p>Saves the frame in the given filename.</p>
570 <p>Uses the <code>unaccurate method by default.</code></p>
571 <div class="tags">
572 <h4>Parameters</h4>
573  
574 <table>
575 <tr>
576 <td>string</td>
577 <td>$pathfile</td>
578 <td>
579 </td>
580 </tr>
581 <tr>
582 <td>Boolean</td>
583 <td>$accurate</td>
584 <td>
585 </td>
586 </tr>
587 </table>
588  
589  
590 <h4>Return Value</h4>
591  
592 <table>
593 <tr>
594 <td><a href="../../FFMpeg/Media/Frame.html"><abbr title="FFMpeg\Media\Frame">Frame</abbr></a></td>
595 <td>
596 </td>
597 </tr>
598 </table>
599  
600  
601 <h4>Exceptions</h4>
602  
603 <table>
604 <tr>
605 <td><a href="http://php.net/RuntimeException"><abbr title="RuntimeException">RuntimeException</abbr></a></td>
606 <td>
607 </td>
608 </tr>
609 </table>
610  
611  
612 </div>
613 </div>
614  
615  
616 </div>
617 <div id="footer">
618 Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>.
619 </div>
620 </body>
621 </html>