| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <title>JSDoc: Source: options/output.js</title> |
|
|
| <script src="scripts/prettify/prettify.js"> </script> |
| <script src="scripts/prettify/lang-css.js"> </script> |
| |
| |
| |
| <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> |
| <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> |
| </head> |
|
|
| <body> |
|
|
| <div id="main"> |
|
|
| <h1 class="page-title">Source: options/output.js</h1> |
|
|
| |
|
|
|
|
| |
| <section> |
| <article> |
| <pre class="prettyprint source linenums"><code>/*jshint node:true*/ |
| 'use strict'; |
|
|
| var utils = require('../utils'); |
|
|
|
|
| /* |
| *! Output-related methods |
| */ |
|
|
| module.exports = function(proto) { |
| /** |
| * Add output |
| * |
| * @method FfmpegCommand#output |
| * @category Output |
| * @aliases addOutput |
| * |
| * @param {String|Writable} target target file path or writable stream |
| * @param {Object} [pipeopts={}] pipe options (only applies to streams) |
| * @return FfmpegCommand |
| */ |
| proto.addOutput = |
| proto.output = function(target, pipeopts) { |
| var isFile = false; |
|
|
| if (!target && this._currentOutput) { |
| // No target is only allowed when called from constructor |
| throw new Error('Invalid output'); |
| } |
|
|
| if (target && typeof target !== 'string') { |
| if (!('writable' in target) || !(target.writable)) { |
| throw new Error('Invalid output'); |
| } |
| } else if (typeof target === 'string') { |
| var protocol = target.match(/^([a-z]{2,}):/i); |
| isFile = !protocol || protocol[0] === 'file'; |
| } |
|
|
| if (target && !('target' in this._currentOutput)) { |
| // For backwards compatibility, set target for first output |
| this._currentOutput.target = target; |
| this._currentOutput.isFile = isFile; |
| this._currentOutput.pipeopts = pipeopts || {}; |
| } else { |
| if (target && typeof target !== 'string') { |
| var hasOutputStream = this._outputs.some(function(output) { |
| return typeof output.target !== 'string'; |
| }); |
|
|
| if (hasOutputStream) { |
| throw new Error('Only one output stream is supported'); |
| } |
| } |
|
|
| this._outputs.push(this._currentOutput = { |
| target: target, |
| isFile: isFile, |
| flags: {}, |
| pipeopts: pipeopts || {} |
| }); |
|
|
| var self = this; |
| ['audio', 'audioFilters', 'video', 'videoFilters', 'sizeFilters', 'options'].forEach(function(key) { |
| self._currentOutput[key] = utils.args(); |
| }); |
|
|
| if (!target) { |
| // Call from constructor: remove target key |
| delete this._currentOutput.target; |
| } |
| } |
|
|
| return this; |
| }; |
|
|
|
|
| /** |
| * Specify output seek time |
| * |
| * @method FfmpegCommand#seek |
| * @category Input |
| * @aliases seekOutput |
| * |
| * @param {String|Number} seek seek time in seconds or as a '[hh:[mm:]]ss[.xxx]' string |
| * @return FfmpegCommand |
| */ |
| proto.seekOutput = |
| proto.seek = function(seek) { |
| this._currentOutput.options('-ss', seek); |
| return this; |
| }; |
|
|
|
|
| /** |
| * Set output duration |
| * |
| * @method FfmpegCommand#duration |
| * @category Output |
| * @aliases withDuration,setDuration |
| * |
| * @param {String|Number} duration duration in seconds or as a '[[hh:]mm:]ss[.xxx]' string |
| * @return FfmpegCommand |
| */ |
| proto.withDuration = |
| proto.setDuration = |
| proto.duration = function(duration) { |
| this._currentOutput.options('-t', duration); |
| return this; |
| }; |
|
|
|
|
| /** |
| * Set output format |
| * |
| * @method FfmpegCommand#format |
| * @category Output |
| * @aliases toFormat,withOutputFormat,outputFormat |
| * |
| * @param {String} format output format name |
| * @return FfmpegCommand |
| */ |
| proto.toFormat = |
| proto.withOutputFormat = |
| proto.outputFormat = |
| proto.format = function(format) { |
| this._currentOutput.options('-f', format); |
| return this; |
| }; |
|
|
|
|
| /** |
| * Add stream mapping to output |
| * |
| * @method FfmpegCommand#map |
| * @category Output |
| * |
| * @param {String} spec stream specification string, with optional square brackets |
| * @return FfmpegCommand |
| */ |
| proto.map = function(spec) { |
| this._currentOutput.options('-map', spec.replace(utils.streamRegexp, '[$1]')); |
| return this; |
| }; |
|
|
|
|
| /** |
| * Run flvtool2/flvmeta on output |
| * |
| * @method FfmpegCommand#flvmeta |
| * @category Output |
| * @aliases updateFlvMetadata |
| * |
| * @return FfmpegCommand |
| */ |
| proto.updateFlvMetadata = |
| proto.flvmeta = function() { |
| this._currentOutput.flags.flvmeta = true; |
| return this; |
| }; |
| }; |
| </code></pre> |
| </article> |
| </section> |
|
|
|
|
|
|
|
|
| </div> |
|
|
| <nav> |
| <h2><a href="index.html">Index</a></h2><ul><li><a href="index.html#installation">Installation</a></li><ul></ul><li><a href="index.html#usage">Usage</a></li><ul><li><a href="index.html#prerequisites">Prerequisites</a></li><li><a href="index.html#creating-an-ffmpeg-command">Creating an FFmpeg command</a></li><li><a href="index.html#specifying-inputs">Specifying inputs</a></li><li><a href="index.html#input-options">Input options</a></li><li><a href="index.html#audio-options">Audio options</a></li><li><a href="index.html#video-options">Video options</a></li><li><a href="index.html#video-frame-size-options">Video frame size options</a></li><li><a href="index.html#specifying-multiple-outputs">Specifying multiple outputs</a></li><li><a href="index.html#output-options">Output options</a></li><li><a href="index.html#miscellaneous-options">Miscellaneous options</a></li><li><a href="index.html#setting-event-handlers">Setting event handlers</a></li><li><a href="index.html#starting-ffmpeg-processing">Starting FFmpeg processing</a></li><li><a href="index.html#controlling-the-ffmpeg-process">Controlling the FFmpeg process</a></li><li><a href="index.html#reading-video-metadata">Reading video metadata</a></li><li><a href="index.html#querying-ffmpeg-capabilities">Querying ffmpeg capabilities</a></li><li><a href="index.html#cloning-an-ffmpegcommand">Cloning an FfmpegCommand</a></li></ul><li><a href="index.html#contributing">Contributing</a></li><ul><li><a href="index.html#code-contributions">Code contributions</a></li><li><a href="index.html#documentation-contributions">Documentation contributions</a></li><li><a href="index.html#updating-the-documentation">Updating the documentation</a></li><li><a href="index.html#running-tests">Running tests</a></li></ul><li><a href="index.html#main-contributors">Main contributors</a></li><ul></ul><li><a href="index.html#license">License</a></li><ul></ul></ul><h3>Classes</h3><ul><li><a href="FfmpegCommand.html">FfmpegCommand</a></li><ul><li> <a href="FfmpegCommand.html#audio-methods">Audio methods</a></li><li> <a href="FfmpegCommand.html#capabilities-methods">Capabilities methods</a></li><li> <a href="FfmpegCommand.html#custom-options-methods">Custom options methods</a></li><li> <a href="FfmpegCommand.html#input-methods">Input methods</a></li><li> <a href="FfmpegCommand.html#metadata-methods">Metadata methods</a></li><li> <a href="FfmpegCommand.html#miscellaneous-methods">Miscellaneous methods</a></li><li> <a href="FfmpegCommand.html#other-methods">Other methods</a></li><li> <a href="FfmpegCommand.html#output-methods">Output methods</a></li><li> <a href="FfmpegCommand.html#processing-methods">Processing methods</a></li><li> <a href="FfmpegCommand.html#video-methods">Video methods</a></li><li> <a href="FfmpegCommand.html#video-size-methods">Video size methods</a></li></ul></ul> |
| </nav> |
|
|
| <br clear="both"> |
|
|
| <footer> |
| Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha5</a> on Tue Jul 08 2014 21:22:19 GMT+0200 (CEST) |
| </footer> |
|
|
| <script> prettyPrint(); </script> |
| <script src="scripts/linenumber.js"> </script> |
| </body> |
| </html> |
|
|
