scratch – Blame information for rev 115

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