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