|
<!DOCTYPE html> |
|
<html lang="en"> |
|
<head> |
|
<meta charset="utf-8"> |
|
<title>JSDoc: Source: options/inputs.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/inputs.js</h1> |
|
|
|
|
|
|
|
|
|
|
|
<section> |
|
<article> |
|
<pre class="prettyprint source linenums"><code>/*jshint node:true*/ |
|
'use strict'; |
|
|
|
var utils = require('../utils'); |
|
|
|
/* |
|
*! Input-related methods |
|
*/ |
|
|
|
module.exports = function(proto) { |
|
/** |
|
* Add an input to command |
|
* |
|
* Also switches "current input", that is the input that will be affected |
|
* by subsequent input-related methods. |
|
* |
|
* Note: only one stream input is supported for now. |
|
* |
|
* @method FfmpegCommand#input |
|
* @category Input |
|
* @aliases mergeAdd,addInput |
|
* |
|
* @param {String|Readable} source input file path or readable stream |
|
* @return FfmpegCommand |
|
*/ |
|
proto.mergeAdd = |
|
proto.addInput = |
|
proto.input = function(source) { |
|
var isFile = false; |
|
var isStream = false; |
|
|
|
if (typeof source !== 'string') { |
|
if (!('readable' in source) || !(source.readable)) { |
|
throw new Error('Invalid input'); |
|
} |
|
|
|
var hasInputStream = this._inputs.some(function(input) { |
|
return input.isStream; |
|
}); |
|
|
|
if (hasInputStream) { |
|
throw new Error('Only one input stream is supported'); |
|
} |
|
|
|
isStream = true; |
|
source.pause(); |
|
} else { |
|
var protocol = source.match(/^([a-z]{2,}):/i); |
|
isFile = !protocol || protocol[0] === 'file'; |
|
} |
|
|
|
this._inputs.push(this._currentInput = { |
|
source: source, |
|
isFile: isFile, |
|
isStream: isStream, |
|
options: utils.args() |
|
}); |
|
|
|
return this; |
|
}; |
|
|
|
|
|
/** |
|
* Specify input format for the last specified input |
|
* |
|
* @method FfmpegCommand#inputFormat |
|
* @category Input |
|
* @aliases withInputFormat,fromFormat |
|
* |
|
* @param {String} format input format |
|
* @return FfmpegCommand |
|
*/ |
|
proto.withInputFormat = |
|
proto.inputFormat = |
|
proto.fromFormat = function(format) { |
|
if (!this._currentInput) { |
|
throw new Error('No input specified'); |
|
} |
|
|
|
this._currentInput.options('-f', format); |
|
return this; |
|
}; |
|
|
|
|
|
/** |
|
* Specify input FPS for the last specified input |
|
* (only valid for raw video formats) |
|
* |
|
* @method FfmpegCommand#inputFps |
|
* @category Input |
|
* @aliases withInputFps,withInputFPS,withFpsInput,withFPSInput,inputFPS,inputFps,fpsInput |
|
* |
|
* @param {Number} fps input FPS |
|
* @return FfmpegCommand |
|
*/ |
|
proto.withInputFps = |
|
proto.withInputFPS = |
|
proto.withFpsInput = |
|
proto.withFPSInput = |
|
proto.inputFPS = |
|
proto.inputFps = |
|
proto.fpsInput = |
|
proto.FPSInput = function(fps) { |
|
if (!this._currentInput) { |
|
throw new Error('No input specified'); |
|
} |
|
|
|
this._currentInput.options('-r', fps); |
|
return this; |
|
}; |
|
|
|
|
|
/** |
|
* Use native framerate for the last specified input |
|
* |
|
* @method FfmpegCommand#native |
|
* @category Input |
|
* @aliases nativeFramerate,withNativeFramerate |
|
* |
|
* @return FfmmegCommand |
|
*/ |
|
proto.nativeFramerate = |
|
proto.withNativeFramerate = |
|
proto.native = function() { |
|
if (!this._currentInput) { |
|
throw new Error('No input specified'); |
|
} |
|
|
|
this._currentInput.options('-re'); |
|
return this; |
|
}; |
|
|
|
|
|
/** |
|
* Specify input seek time for the last specified input |
|
* |
|
* @method FfmpegCommand#seekInput |
|
* @category Input |
|
* @aliases setStartTime,seekTo |
|
* |
|
* @param {String|Number} seek seek time in seconds or as a '[hh:[mm:]]ss[.xxx]' string |
|
* @return FfmpegCommand |
|
*/ |
|
proto.setStartTime = |
|
proto.seekInput = function(seek) { |
|
if (!this._currentInput) { |
|
throw new Error('No input specified'); |
|
} |
|
|
|
this._currentInput.options('-ss', seek); |
|
|
|
return this; |
|
}; |
|
|
|
|
|
/** |
|
* Loop over the last specified input |
|
* |
|
* @method FfmpegCommand#loop |
|
* @category Input |
|
* |
|
* @param {String|Number} [duration] loop duration in seconds or as a '[[hh:]mm:]ss[.xxx]' string |
|
* @return FfmpegCommand |
|
*/ |
|
proto.loop = function(duration) { |
|
if (!this._currentInput) { |
|
throw new Error('No input specified'); |
|
} |
|
|
|
this._currentInput.options('-loop', '1'); |
|
|
|
if (typeof duration !== 'undefined') { |
|
this.duration(duration); |
|
} |
|
|
|
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.4.0</a> on Sun May 01 2016 12:10:37 GMT+0200 (CEST) |
|
</footer> |
|
|
|
<script> prettyPrint(); </script> |
|
<script src="scripts/linenumber.js"> </script> |
|
</body> |
|
</html> |
|
|
