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\VideoInterface | 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">Interface</div>
23 <h1><a href="../../FFMpeg/Format.html">FFMpeg\Format</a>\VideoInterface</h1>
24 </div>
25 <div class="content">
26 <p> interface
27 <strong>VideoInterface</strong> implements
28 <a href="../../FFMpeg/Format/AudioInterface.html"><abbr title="FFMpeg\Format\AudioInterface">AudioInterface</abbr></a></p>
29  
30  
31  
32  
33 <h2>Methods</h2>
34  
35 <table>
36 <tr>
37 <td class="type">
38 string
39 </td>
40 <td class="last">
41 <a href="#method_getPasses">getPasses</a>()
42 <p>Returns the number of passes.</p>
43 </td>
44 <td><small>from&nbsp;<a href="../../FFMpeg/Format/FormatInterface.html#method_getPasses"><abbr title="FFMpeg\Format\FormatInterface">FormatInterface</abbr></a></small></td>
45 </tr>
46 <tr>
47 <td class="type">
48 <abbr title="FFMpeg\Format\array()">array()</abbr>
49 </td>
50 <td class="last">
51 <a href="#method_getExtraParams">getExtraParams</a>()
52 <p>Returns an array of extra parameters to add to ffmpeg commandline.</p>
53 </td>
54 <td><small>from&nbsp;<a href="../../FFMpeg/Format/FormatInterface.html#method_getExtraParams"><abbr title="FFMpeg\Format\FormatInterface">FormatInterface</abbr></a></small></td>
55 </tr>
56 <tr>
57 <td class="type">
58 integer
59 </td>
60 <td class="last">
61 <a href="#method_getAudioKiloBitrate">getAudioKiloBitrate</a>()
62 <p>Gets the audio kiloBitrate value.</p>
63 </td>
64 <td><small>from&nbsp;<a href="../../FFMpeg/Format/AudioInterface.html#method_getAudioKiloBitrate"><abbr title="FFMpeg\Format\AudioInterface">AudioInterface</abbr></a></small></td>
65 </tr>
66 <tr>
67 <td class="type">
68 integer
69 </td>
70 <td class="last">
71 <a href="#method_getAudioChannels">getAudioChannels</a>()
72 <p>Gets the audio channels value.</p>
73 </td>
74 <td><small>from&nbsp;<a href="../../FFMpeg/Format/AudioInterface.html#method_getAudioChannels"><abbr title="FFMpeg\Format\AudioInterface">AudioInterface</abbr></a></small></td>
75 </tr>
76 <tr>
77 <td class="type">
78 string
79 </td>
80 <td class="last">
81 <a href="#method_getAudioCodec">getAudioCodec</a>()
82 <p>Returns the audio codec.</p>
83 </td>
84 <td><small>from&nbsp;<a href="../../FFMpeg/Format/AudioInterface.html#method_getAudioCodec"><abbr title="FFMpeg\Format\AudioInterface">AudioInterface</abbr></a></small></td>
85 </tr>
86 <tr>
87 <td class="type">
88 array
89 </td>
90 <td class="last">
91 <a href="#method_getAvailableAudioCodecs">getAvailableAudioCodecs</a>()
92 <p>Returns the list of available audio codecs for this format.</p>
93 </td>
94 <td><small>from&nbsp;<a href="../../FFMpeg/Format/AudioInterface.html#method_getAvailableAudioCodecs"><abbr title="FFMpeg\Format\AudioInterface">AudioInterface</abbr></a></small></td>
95 </tr>
96 <tr>
97 <td class="type">
98 integer
99 </td>
100 <td class="last">
101 <a href="#method_getKiloBitrate">getKiloBitrate</a>()
102 <p>Gets the kiloBitrate value.</p>
103 </td>
104 <td></td>
105 </tr>
106 <tr>
107 <td class="type">
108 integer
109 </td>
110 <td class="last">
111 <a href="#method_getModulus">getModulus</a>()
112 <p>Returns the modulus used by the Resizable video.</p>
113 </td>
114 <td></td>
115 </tr>
116 <tr>
117 <td class="type">
118 string
119 </td>
120 <td class="last">
121 <a href="#method_getVideoCodec">getVideoCodec</a>()
122 <p>Returns the video codec.</p>
123 </td>
124 <td></td>
125 </tr>
126 <tr>
127 <td class="type">
128 Boolean
129 </td>
130 <td class="last">
131 <a href="#method_supportBFrames">supportBFrames</a>()
132 <p>Returns true if the current format supports B-Frames.</p>
133 </td>
134 <td></td>
135 </tr>
136 <tr>
137 <td class="type">
138 array
139 </td>
140 <td class="last">
141 <a href="#method_getAvailableVideoCodecs">getAvailableVideoCodecs</a>()
142 <p>Returns the list of available video codecs for this format.</p>
143 </td>
144 <td></td>
145 </tr>
146 </table>
147  
148  
149 <h2>Details</h2>
150  
151 <h3 id="method_getPasses">
152 <div class="location">in <a href="../../FFMpeg/Format/FormatInterface.html#method_getPasses"><abbr title="FFMpeg\Format\FormatInterface">FormatInterface</abbr></a> at line 20</div>
153 <code> public string
154 <strong>getPasses</strong>()</code>
155 </h3>
156 <div class="details">
157 <p>Returns the number of passes.</p>
158 <p>
159 </p>
160 <div class="tags">
161  
162 <h4>Return Value</h4>
163  
164 <table>
165 <tr>
166 <td>string</td>
167 <td>
168 </td>
169 </tr>
170 </table>
171  
172  
173  
174 </div>
175 </div>
176  
177 <h3 id="method_getExtraParams">
178 <div class="location">in <a href="../../FFMpeg/Format/FormatInterface.html#method_getExtraParams"><abbr title="FFMpeg\Format\FormatInterface">FormatInterface</abbr></a> at line 27</div>
179 <code> public <abbr title="FFMpeg\Format\array()">array()</abbr>
180 <strong>getExtraParams</strong>()</code>
181 </h3>
182 <div class="details">
183 <p>Returns an array of extra parameters to add to ffmpeg commandline.</p>
184 <p>
185 </p>
186 <div class="tags">
187  
188 <h4>Return Value</h4>
189  
190 <table>
191 <tr>
192 <td><abbr title="FFMpeg\Format\array()">array()</abbr></td>
193 <td>
194 </td>
195 </tr>
196 </table>
197  
198  
199  
200 </div>
201 </div>
202  
203 <h3 id="method_getAudioKiloBitrate">
204 <div class="location">in <a href="../../FFMpeg/Format/AudioInterface.html#method_getAudioKiloBitrate"><abbr title="FFMpeg\Format\AudioInterface">AudioInterface</abbr></a> at line 20</div>
205 <code> public integer
206 <strong>getAudioKiloBitrate</strong>()</code>
207 </h3>
208 <div class="details">
209 <p>Gets the audio kiloBitrate value.</p>
210 <p>
211 </p>
212 <div class="tags">
213  
214 <h4>Return Value</h4>
215  
216 <table>
217 <tr>
218 <td>integer</td>
219 <td>
220 </td>
221 </tr>
222 </table>
223  
224  
225  
226 </div>
227 </div>
228  
229 <h3 id="method_getAudioChannels">
230 <div class="location">in <a href="../../FFMpeg/Format/AudioInterface.html#method_getAudioChannels"><abbr title="FFMpeg\Format\AudioInterface">AudioInterface</abbr></a> at line 27</div>
231 <code> public integer
232 <strong>getAudioChannels</strong>()</code>
233 </h3>
234 <div class="details">
235 <p>Gets the audio channels value.</p>
236 <p>
237 </p>
238 <div class="tags">
239  
240 <h4>Return Value</h4>
241  
242 <table>
243 <tr>
244 <td>integer</td>
245 <td>
246 </td>
247 </tr>
248 </table>
249  
250  
251  
252 </div>
253 </div>
254  
255 <h3 id="method_getAudioCodec">
256 <div class="location">in <a href="../../FFMpeg/Format/AudioInterface.html#method_getAudioCodec"><abbr title="FFMpeg\Format\AudioInterface">AudioInterface</abbr></a> at line 34</div>
257 <code> public string
258 <strong>getAudioCodec</strong>()</code>
259 </h3>
260 <div class="details">
261 <p>Returns the audio codec.</p>
262 <p>
263 </p>
264 <div class="tags">
265  
266 <h4>Return Value</h4>
267  
268 <table>
269 <tr>
270 <td>string</td>
271 <td>
272 </td>
273 </tr>
274 </table>
275  
276  
277  
278 </div>
279 </div>
280  
281 <h3 id="method_getAvailableAudioCodecs">
282 <div class="location">in <a href="../../FFMpeg/Format/AudioInterface.html#method_getAvailableAudioCodecs"><abbr title="FFMpeg\Format\AudioInterface">AudioInterface</abbr></a> at line 41</div>
283 <code> public array
284 <strong>getAvailableAudioCodecs</strong>()</code>
285 </h3>
286 <div class="details">
287 <p>Returns the list of available audio codecs for this format.</p>
288 <p>
289 </p>
290 <div class="tags">
291  
292 <h4>Return Value</h4>
293  
294 <table>
295 <tr>
296 <td>array</td>
297 <td>
298 </td>
299 </tr>
300 </table>
301  
302  
303  
304 </div>
305 </div>
306  
307 <h3 id="method_getKiloBitrate">
308 <div class="location">at line 21</div>
309 <code> public integer
310 <strong>getKiloBitrate</strong>()</code>
311 </h3>
312 <div class="details">
313 <p>Gets the kiloBitrate value.</p>
314 <p>
315 </p>
316 <div class="tags">
317  
318 <h4>Return Value</h4>
319  
320 <table>
321 <tr>
322 <td>integer</td>
323 <td>
324 </td>
325 </tr>
326 </table>
327  
328  
329  
330 </div>
331 </div>
332  
333 <h3 id="method_getModulus">
334 <div class="location">at line 33</div>
335 <code> public integer
336 <strong>getModulus</strong>()</code>
337 </h3>
338 <div class="details">
339 <p>Returns the modulus used by the Resizable video.</p>
340 <p>This used to calculate the target dimensions while maintaining the best
341 aspect ratio.</p>
342 <div class="tags">
343  
344 <h4>Return Value</h4>
345  
346 <table>
347 <tr>
348 <td>integer</td>
349 <td>
350 </td>
351 </tr>
352 </table>
353  
354  
355  
356 <h4>See also</h4>
357  
358 <table>
359 <tr>
360 <td>http://www.undeadborn.net/tools/rescalculator.php</td>
361 <td></td>
362 </tr>
363 </table>
364  
365 </div>
366 </div>
367  
368 <h3 id="method_getVideoCodec">
369 <div class="location">at line 40</div>
370 <code> public string
371 <strong>getVideoCodec</strong>()</code>
372 </h3>
373 <div class="details">
374 <p>Returns the video codec.</p>
375 <p>
376 </p>
377 <div class="tags">
378  
379 <h4>Return Value</h4>
380  
381 <table>
382 <tr>
383 <td>string</td>
384 <td>
385 </td>
386 </tr>
387 </table>
388  
389  
390  
391 </div>
392 </div>
393  
394 <h3 id="method_supportBFrames">
395 <div class="location">at line 49</div>
396 <code> public Boolean
397 <strong>supportBFrames</strong>()</code>
398 </h3>
399 <div class="details">
400 <p>Returns true if the current format supports B-Frames.</p>
401 <p>
402 </p>
403 <div class="tags">
404  
405 <h4>Return Value</h4>
406  
407 <table>
408 <tr>
409 <td>Boolean</td>
410 <td>
411 </td>
412 </tr>
413 </table>
414  
415  
416  
417 <h4>See also</h4>
418  
419 <table>
420 <tr>
421 <td>https://wikipedia.org/wiki/Video_compression_picture_types</td>
422 <td></td>
423 </tr>
424 </table>
425  
426 </div>
427 </div>
428  
429 <h3 id="method_getAvailableVideoCodecs">
430 <div class="location">at line 56</div>
431 <code> public array
432 <strong>getAvailableVideoCodecs</strong>()</code>
433 </h3>
434 <div class="details">
435 <p>Returns the list of available video codecs for this format.</p>
436 <p>
437 </p>
438 <div class="tags">
439  
440 <h4>Return Value</h4>
441  
442 <table>
443 <tr>
444 <td>array</td>
445 <td>
446 </td>
447 </tr>
448 </table>
449  
450  
451  
452 </div>
453 </div>
454  
455  
456 </div>
457 <div id="footer">
458 Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>.
459 </div>
460 </body>
461 </html>