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\Audio\DefaultAudio | 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/Audio.html">FFMpeg\Format\Audio</a>\DefaultAudio</h1>
24 </div>
25 <div class="content">
26 <p>abstract class
27 <strong>DefaultAudio</strong> extends <abbr title="Evenement\EventEmitter">EventEmitter</abbr> implements
28 <a href="../../../FFMpeg/Format/AudioInterface.html"><abbr title="FFMpeg\Format\AudioInterface">AudioInterface</abbr></a>, <a href="../../../FFMpeg/Format/ProgressableInterface.html"><abbr title="FFMpeg\Format\ProgressableInterface">ProgressableInterface</abbr></a></p>
29  
30  
31  
32  
33 <h2>Methods</h2>
34  
35 <table>
36 <tr>
37 <td class="type">
38 <abbr title="FFMpeg\Format\array()">array()</abbr>
39 </td>
40 <td class="last">
41 <a href="#method_getExtraParams">getExtraParams</a>()
42 <p>Returns an array of extra parameters to add to ffmpeg commandline.</p>
43 </td>
44 <td></td>
45 </tr>
46 <tr>
47 <td class="type">
48 string
49 </td>
50 <td class="last">
51 <a href="#method_getAudioCodec">getAudioCodec</a>()
52 <p>Returns the audio codec.</p>
53 </td>
54 <td></td>
55 </tr>
56 <tr>
57 <td class="type">
58  
59 </td>
60 <td class="last">
61 <a href="#method_setAudioCodec">setAudioCodec</a>(string $audioCodec)
62 <p>Sets the audio codec, Should be in the available ones, otherwise an exception is thrown.</p>
63 </td>
64 <td></td>
65 </tr>
66 <tr>
67 <td class="type">
68 integer
69 </td>
70 <td class="last">
71 <a href="#method_getAudioKiloBitrate">getAudioKiloBitrate</a>()
72 <p>Gets the audio kiloBitrate value.</p>
73 </td>
74 <td></td>
75 </tr>
76 <tr>
77 <td class="type">
78  
79 </td>
80 <td class="last">
81 <a href="#method_setAudioKiloBitrate">setAudioKiloBitrate</a>(integer $kiloBitrate)
82 <p>Sets the kiloBitrate value.</p>
83 </td>
84 <td></td>
85 </tr>
86 <tr>
87 <td class="type">
88 integer
89 </td>
90 <td class="last">
91 <a href="#method_getAudioChannels">getAudioChannels</a>()
92 <p>Gets the audio channels value.</p>
93 </td>
94 <td></td>
95 </tr>
96 <tr>
97 <td class="type">
98  
99 </td>
100 <td class="last">
101 <a href="#method_setAudioChannels">setAudioChannels</a>(integer $channels)
102 <p>Sets the channels value.</p>
103 </td>
104 <td></td>
105 </tr>
106 <tr>
107 <td class="type">
108 array
109 </td>
110 <td class="last">
111 <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)
112 <p>Creates the progress listener.</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_getPasses">getPasses</a>()
122 <p>Returns the number of passes.</p>
123 </td>
124 <td></td>
125 </tr>
126 </table>
127  
128  
129 <h2>Details</h2>
130  
131 <h3 id="method_getExtraParams">
132 <div class="location">at line 36</div>
133 <code> public <abbr title="FFMpeg\Format\array()">array()</abbr>
134 <strong>getExtraParams</strong>()</code>
135 </h3>
136 <div class="details">
137 <p>Returns an array of extra parameters to add to ffmpeg commandline.</p>
138 <p>
139 </p>
140 <div class="tags">
141  
142 <h4>Return Value</h4>
143  
144 <table>
145 <tr>
146 <td><abbr title="FFMpeg\Format\array()">array()</abbr></td>
147 <td>
148 </td>
149 </tr>
150 </table>
151  
152  
153  
154 </div>
155 </div>
156  
157 <h3 id="method_getAudioCodec">
158 <div class="location">at line 44</div>
159 <code> public string
160 <strong>getAudioCodec</strong>()</code>
161 </h3>
162 <div class="details">
163 <p>Returns the audio codec.</p>
164 <p>
165 </p>
166 <div class="tags">
167  
168 <h4>Return Value</h4>
169  
170 <table>
171 <tr>
172 <td>string</td>
173 <td>
174 </td>
175 </tr>
176 </table>
177  
178  
179  
180 </div>
181 </div>
182  
183 <h3 id="method_setAudioCodec">
184 <div class="location">at line 57</div>
185 <code> public
186 <strong>setAudioCodec</strong>(string $audioCodec)</code>
187 </h3>
188 <div class="details">
189 <p>Sets the audio codec, Should be in the available ones, otherwise an exception is thrown.</p>
190 <p>
191 </p>
192 <div class="tags">
193 <h4>Parameters</h4>
194  
195 <table>
196 <tr>
197 <td>string</td>
198 <td>$audioCodec</td>
199 <td>
200 </td>
201 </tr>
202 </table>
203  
204  
205  
206 <h4>Exceptions</h4>
207  
208 <table>
209 <tr>
210 <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td>
211 <td>
212 </td>
213 </tr>
214 </table>
215  
216  
217 </div>
218 </div>
219  
220 <h3 id="method_getAudioKiloBitrate">
221 <div class="location">at line 74</div>
222 <code> public integer
223 <strong>getAudioKiloBitrate</strong>()</code>
224 </h3>
225 <div class="details">
226 <p>Gets the audio kiloBitrate value.</p>
227 <p>
228 </p>
229 <div class="tags">
230  
231 <h4>Return Value</h4>
232  
233 <table>
234 <tr>
235 <td>integer</td>
236 <td>
237 </td>
238 </tr>
239 </table>
240  
241  
242  
243 </div>
244 </div>
245  
246 <h3 id="method_setAudioKiloBitrate">
247 <div class="location">at line 85</div>
248 <code> public
249 <strong>setAudioKiloBitrate</strong>(integer $kiloBitrate)</code>
250 </h3>
251 <div class="details">
252 <p>Sets the kiloBitrate value.</p>
253 <p>
254 </p>
255 <div class="tags">
256 <h4>Parameters</h4>
257  
258 <table>
259 <tr>
260 <td>integer</td>
261 <td>$kiloBitrate</td>
262 <td>
263 </td>
264 </tr>
265 </table>
266  
267  
268  
269 <h4>Exceptions</h4>
270  
271 <table>
272 <tr>
273 <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td>
274 <td>
275 </td>
276 </tr>
277 </table>
278  
279  
280 </div>
281 </div>
282  
283 <h3 id="method_getAudioChannels">
284 <div class="location">at line 99</div>
285 <code> public integer
286 <strong>getAudioChannels</strong>()</code>
287 </h3>
288 <div class="details">
289 <p>Gets the audio channels value.</p>
290 <p>
291 </p>
292 <div class="tags">
293  
294 <h4>Return Value</h4>
295  
296 <table>
297 <tr>
298 <td>integer</td>
299 <td>
300 </td>
301 </tr>
302 </table>
303  
304  
305  
306 </div>
307 </div>
308  
309 <h3 id="method_setAudioChannels">
310 <div class="location">at line 110</div>
311 <code> public
312 <strong>setAudioChannels</strong>(integer $channels)</code>
313 </h3>
314 <div class="details">
315 <p>Sets the channels value.</p>
316 <p>
317 </p>
318 <div class="tags">
319 <h4>Parameters</h4>
320  
321 <table>
322 <tr>
323 <td>integer</td>
324 <td>$channels</td>
325 <td>
326 </td>
327 </tr>
328 </table>
329  
330  
331  
332 <h4>Exceptions</h4>
333  
334 <table>
335 <tr>
336 <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td>
337 <td>
338 </td>
339 </tr>
340 </table>
341  
342  
343 </div>
344 </div>
345  
346 <h3 id="method_createProgressListener">
347 <div class="location">at line 124</div>
348 <code> public array
349 <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>
350 </h3>
351 <div class="details">
352 <p>Creates the progress listener.</p>
353 <p>
354 </p>
355 <div class="tags">
356 <h4>Parameters</h4>
357  
358 <table>
359 <tr>
360 <td><a href="../../../FFMpeg/Media/MediaTypeInterface.html"><abbr title="FFMpeg\Media\MediaTypeInterface">MediaTypeInterface</abbr></a></td>
361 <td>$media</td>
362 <td>
363 </td>
364 </tr>
365 <tr>
366 <td><a href="../../../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a></td>
367 <td>$ffprobe</td>
368 <td>
369 </td>
370 </tr>
371 <tr>
372 <td>Integer</td>
373 <td>$pass</td>
374 <td>The current pas snumber</td>
375 </tr>
376 <tr>
377 <td>Integer</td>
378 <td>$total</td>
379 <td>The total pass number</td>
380 </tr>
381 </table>
382  
383  
384 <h4>Return Value</h4>
385  
386 <table>
387 <tr>
388 <td>array</td>
389 <td>An array of listeners</td>
390 </tr>
391 </table>
392  
393  
394  
395 </div>
396 </div>
397  
398 <h3 id="method_getPasses">
399 <div class="location">at line 138</div>
400 <code> public string
401 <strong>getPasses</strong>()</code>
402 </h3>
403 <div class="details">
404 <p>Returns the number of passes.</p>
405 <p>
406 </p>
407 <div class="tags">
408  
409 <h4>Return Value</h4>
410  
411 <table>
412 <tr>
413 <td>string</td>
414 <td>
415 </td>
416 </tr>
417 </table>
418  
419  
420  
421 </div>
422 </div>
423  
424  
425 </div>
426 <div id="footer">
427 Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>.
428 </div>
429 </body>
430 </html>