global.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Global</title>
  6. <script src="scripts/prettify/prettify.js"> </script>
  7. <script src="scripts/prettify/lang-css.js"> </script>
  8. <!--[if lt IE 9]>
  9. <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  10. <![endif]-->
  11. <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
  12. <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
  13. </head>
  14. <body>
  15. <div id="main">
  16. <h1 class="page-title">Global</h1>
  17. <section>
  18. <header>
  19. <h2>
  20. </h2>
  21. </header>
  22. <article>
  23. <div class="container-overview">
  24. <dl class="details">
  25. </dl>
  26. </div>
  27. <h3 class="subsection-title">Methods</h3>
  28. <dl>
  29. <dt>
  30. <h4 class="name" id="createSizeFilters"><span class="type-signature">&lt;private> </span>createSizeFilters<span class="signature">(command, key, value)</span><span class="type-signature"></span></h4>
  31. </dt>
  32. <dd>
  33. <div class="description">
  34. <p>Recompute size filters</p>
  35. </div>
  36. <h5>Parameters:</h5>
  37. <table class="params">
  38. <thead>
  39. <tr>
  40. <th>Name</th>
  41. <th>Type</th>
  42. <th class="last">Description</th>
  43. </tr>
  44. </thead>
  45. <tbody>
  46. <tr>
  47. <td class="name"><code>command</code></td>
  48. <td class="type">
  49. <span class="param-type"><a href="FfmpegCommand.html">FfmpegCommand</a></span>
  50. </td>
  51. <td class="description last"></td>
  52. </tr>
  53. <tr>
  54. <td class="name"><code>key</code></td>
  55. <td class="type">
  56. <span class="param-type">String</span>
  57. </td>
  58. <td class="description last"><p>newly-added parameter name ('size', 'aspect' or 'pad')</p></td>
  59. </tr>
  60. <tr>
  61. <td class="name"><code>value</code></td>
  62. <td class="type">
  63. <span class="param-type">String</span>
  64. </td>
  65. <td class="description last"><p>newly-added parameter value</p></td>
  66. </tr>
  67. </tbody>
  68. </table>
  69. <dl class="details">
  70. <dt class="tag-source">Source:</dt>
  71. <dd class="tag-source"><ul class="dummy"><li>
  72. <a href="videosize.js.html">options/videosize.js</a>, <a href="videosize.js.html#line72">line 72</a>
  73. </li></ul></dd>
  74. </dl>
  75. <h5>Returns:</h5>
  76. <div class="param-desc">
  77. <p>filter string array</p>
  78. </div>
  79. </dd>
  80. <dt>
  81. <h4 class="name" id="getScalePadFilters"><span class="type-signature">&lt;private> </span>getScalePadFilters<span class="signature">(width, height, aspect, color)</span><span class="type-signature"></span></h4>
  82. </dt>
  83. <dd>
  84. <div class="description">
  85. <p>Return filters to pad video to width*height,</p>
  86. </div>
  87. <h5>Parameters:</h5>
  88. <table class="params">
  89. <thead>
  90. <tr>
  91. <th>Name</th>
  92. <th>Type</th>
  93. <th class="last">Description</th>
  94. </tr>
  95. </thead>
  96. <tbody>
  97. <tr>
  98. <td class="name"><code>width</code></td>
  99. <td class="type">
  100. <span class="param-type">Number</span>
  101. </td>
  102. <td class="description last"><p>output width</p></td>
  103. </tr>
  104. <tr>
  105. <td class="name"><code>height</code></td>
  106. <td class="type">
  107. <span class="param-type">Number</span>
  108. </td>
  109. <td class="description last"><p>output height</p></td>
  110. </tr>
  111. <tr>
  112. <td class="name"><code>aspect</code></td>
  113. <td class="type">
  114. <span class="param-type">Number</span>
  115. </td>
  116. <td class="description last"><p>video aspect ratio (without padding)</p></td>
  117. </tr>
  118. <tr>
  119. <td class="name"><code>color</code></td>
  120. <td class="type">
  121. <span class="param-type">Number</span>
  122. </td>
  123. <td class="description last"><p>padding color</p></td>
  124. </tr>
  125. </tbody>
  126. </table>
  127. <dl class="details">
  128. <dt class="tag-source">Source:</dt>
  129. <dd class="tag-source"><ul class="dummy"><li>
  130. <a href="videosize.js.html">options/videosize.js</a>, <a href="videosize.js.html#line19">line 19</a>
  131. </li></ul></dd>
  132. </dl>
  133. <h5>Returns:</h5>
  134. <div class="param-desc">
  135. <p>scale/pad filters</p>
  136. </div>
  137. </dd>
  138. <dt>
  139. <h4 class="name" id="parseProgressLine"><span class="type-signature">&lt;private> </span>parseProgressLine<span class="signature">(line)</span><span class="type-signature"></span></h4>
  140. </dt>
  141. <dd>
  142. <div class="description">
  143. <p>Parse progress line from ffmpeg stderr</p>
  144. </div>
  145. <h5>Parameters:</h5>
  146. <table class="params">
  147. <thead>
  148. <tr>
  149. <th>Name</th>
  150. <th>Type</th>
  151. <th class="last">Description</th>
  152. </tr>
  153. </thead>
  154. <tbody>
  155. <tr>
  156. <td class="name"><code>line</code></td>
  157. <td class="type">
  158. <span class="param-type">String</span>
  159. </td>
  160. <td class="description last"><p>progress line</p></td>
  161. </tr>
  162. </tbody>
  163. </table>
  164. <dl class="details">
  165. <dt class="tag-source">Source:</dt>
  166. <dd class="tag-source"><ul class="dummy"><li>
  167. <a href="utils.js.html">utils.js</a>, <a href="utils.js.html#line16">line 16</a>
  168. </li></ul></dd>
  169. </dl>
  170. <h5>Returns:</h5>
  171. <div class="param-desc">
  172. <p>progress object</p>
  173. </div>
  174. </dd>
  175. <dt>
  176. <h4 class="name" id="process"><span class="type-signature">&lt;private> </span>process<span class="signature">(command, target, <span class="optional">pipeOptions</span>)</span><span class="type-signature"></span></h4>
  177. </dt>
  178. <dd>
  179. <h5>Parameters:</h5>
  180. <table class="params">
  181. <thead>
  182. <tr>
  183. <th>Name</th>
  184. <th>Type</th>
  185. <th>Argument</th>
  186. <th class="last">Description</th>
  187. </tr>
  188. </thead>
  189. <tbody>
  190. <tr>
  191. <td class="name"><code>command</code></td>
  192. <td class="type">
  193. <span class="param-type"><a href="FfmpegCommand.html">FfmpegCommand</a></span>
  194. </td>
  195. <td class="attributes">
  196. </td>
  197. <td class="description last"></td>
  198. </tr>
  199. <tr>
  200. <td class="name"><code>target</code></td>
  201. <td class="type">
  202. <span class="param-type">String</span>
  203. |
  204. <span class="param-type">Writable</span>
  205. </td>
  206. <td class="attributes">
  207. </td>
  208. <td class="description last"></td>
  209. </tr>
  210. <tr>
  211. <td class="name"><code>pipeOptions</code></td>
  212. <td class="type">
  213. <span class="param-type">Object</span>
  214. </td>
  215. <td class="attributes">
  216. &lt;optional><br>
  217. </td>
  218. <td class="description last"></td>
  219. </tr>
  220. </tbody>
  221. </table>
  222. <dl class="details">
  223. <dt class="tag-source">Source:</dt>
  224. <dd class="tag-source"><ul class="dummy"><li>
  225. <a href="processor.js.html">processor.js</a>, <a href="processor.js.html#line47">line 47</a>
  226. </li></ul></dd>
  227. </dl>
  228. </dd>
  229. <dt>
  230. <h4 class="name" id="runFfprobe"><span class="type-signature">&lt;private> </span>runFfprobe<span class="signature">(command)</span><span class="type-signature"></span></h4>
  231. </dt>
  232. <dd>
  233. <div class="description">
  234. <p>Run ffprobe asynchronously and store data in command</p>
  235. </div>
  236. <h5>Parameters:</h5>
  237. <table class="params">
  238. <thead>
  239. <tr>
  240. <th>Name</th>
  241. <th>Type</th>
  242. <th class="last">Description</th>
  243. </tr>
  244. </thead>
  245. <tbody>
  246. <tr>
  247. <td class="name"><code>command</code></td>
  248. <td class="type">
  249. <span class="param-type"><a href="FfmpegCommand.html">FfmpegCommand</a></span>
  250. </td>
  251. <td class="description last"></td>
  252. </tr>
  253. </tbody>
  254. </table>
  255. <dl class="details">
  256. <dt class="tag-source">Source:</dt>
  257. <dd class="tag-source"><ul class="dummy"><li>
  258. <a href="processor.js.html">processor.js</a>, <a href="processor.js.html#line194">line 194</a>
  259. </li></ul></dd>
  260. </dl>
  261. </dd>
  262. </dl>
  263. </article>
  264. </section>
  265. </div>
  266. <nav>
  267. <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="FfmpegCommand.html">FfmpegCommand</a></li></ul><h3>Events</h3><ul><li><a href="FfmpegCommand.html#event:codecData">codecData</a></li><li><a href="FfmpegCommand.html#event:end">end</a></li><li><a href="FfmpegCommand.html#event:error">error</a></li><li><a href="FfmpegCommand.html#event:progress">progress</a></li><li><a href="FfmpegCommand.html#event:start">start</a></li></ul><h3>Global</h3><ul><li><a href="global.html#createSizeFilters">createSizeFilters</a></li><li><a href="global.html#getScalePadFilters">getScalePadFilters</a></li><li><a href="global.html#parseProgressLine">parseProgressLine</a></li><li><a href="global.html#process">process</a></li><li><a href="global.html#runFfprobe">runFfprobe</a></li></ul>
  268. </nav>
  269. <br clear="both">
  270. <footer>
  271. Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha5</a> on Thu May 01 2014 13:29:29 GMT+0200 (CEST)
  272. </footer>
  273. <script> prettyPrint(); </script>
  274. <script src="scripts/linenumber.js"> </script>
  275. </body>
  276. </html>