| | <!DOCTYPE html> |
| | <html lang="en"> |
| | <head> |
| | <meta charset="utf-8"> |
| | <title>JSDoc: Source: options/video.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/video.js</h1> |
| |
|
| | |
| |
|
| |
|
| | |
| | <section> |
| | <article> |
| | <pre class="prettyprint source linenums"><code>/*jshint node:true*/ |
| | 'use strict'; |
| |
|
| | var utils = require('../utils'); |
| |
|
| |
|
| | /* |
| | *! Video-related methods |
| | */ |
| |
|
| | module.exports = function(proto) { |
| | /** |
| | * Disable video in the output |
| | * |
| | * @method FfmpegCommand#noVideo |
| | * @category Video |
| | * @aliases withNoVideo |
| | * |
| | * @return FfmpegCommand |
| | */ |
| | proto.withNoVideo = |
| | proto.noVideo = function() { |
| | this._currentOutput.video.clear(); |
| | this._currentOutput.videoFilters.clear(); |
| | this._currentOutput.video('-vn'); |
| |
|
| | return this; |
| | }; |
| |
|
| |
|
| | /** |
| | * Specify video codec |
| | * |
| | * @method FfmpegCommand#videoCodec |
| | * @category Video |
| | * @aliases withVideoCodec |
| | * |
| | * @param {String} codec video codec name |
| | * @return FfmpegCommand |
| | */ |
| | proto.withVideoCodec = |
| | proto.videoCodec = function(codec) { |
| | this._currentOutput.video('-vcodec', codec); |
| | return this; |
| | }; |
| |
|
| |
|
| | /** |
| | * Specify video bitrate |
| | * |
| | * @method FfmpegCommand#videoBitrate |
| | * @category Video |
| | * @aliases withVideoBitrate |
| | * |
| | * @param {String|Number} bitrate video bitrate in kbps (with an optional 'k' suffix) |
| | * @param {Boolean} [constant=false] enforce constant bitrate |
| | * @return FfmpegCommand |
| | */ |
| | proto.withVideoBitrate = |
| | proto.videoBitrate = function(bitrate, constant) { |
| | bitrate = ('' + bitrate).replace(/k?$/, 'k'); |
| |
|
| | this._currentOutput.video('-b:v', bitrate); |
| | if (constant) { |
| | this._currentOutput.video( |
| | '-maxrate', bitrate, |
| | '-minrate', bitrate, |
| | '-bufsize', '3M' |
| | ); |
| | } |
| |
|
| | return this; |
| | }; |
| |
|
| |
|
| | /** |
| | * Specify custom video filter(s) |
| | * |
| | * Can be called both with one or many filters, or a filter array. |
| | * |
| | * @example |
| | * command.videoFilters('filter1'); |
| | * |
| | * @example |
| | * command.videoFilters('filter1', 'filter2=param1=value1:param2=value2'); |
| | * |
| | * @example |
| | * command.videoFilters(['filter1', 'filter2']); |
| | * |
| | * @example |
| | * command.videoFilters([ |
| | * { |
| | * filter: 'filter1' |
| | * }, |
| | * { |
| | * filter: 'filter2', |
| | * options: 'param=value:param=value' |
| | * } |
| | * ]); |
| | * |
| | * @example |
| | * command.videoFilters( |
| | * { |
| | * filter: 'filter1', |
| | * options: ['value1', 'value2'] |
| | * }, |
| | * { |
| | * filter: 'filter2', |
| | * options: { param1: 'value1', param2: 'value2' } |
| | * } |
| | * ); |
| | * |
| | * @method FfmpegCommand#videoFilters |
| | * @category Video |
| | * @aliases withVideoFilter,withVideoFilters,videoFilter |
| | * |
| | * @param {...String|String[]|Object[]} filters video filter strings, string array or |
| | * filter specification array, each with the following properties: |
| | * @param {String} filters.filter filter name |
| | * @param {String|String[]|Object} [filters.options] filter option string, array, or object |
| | * @return FfmpegCommand |
| | */ |
| | proto.withVideoFilter = |
| | proto.withVideoFilters = |
| | proto.videoFilter = |
| | proto.videoFilters = function(filters) { |
| | if (arguments.length > 1) { |
| | filters = [].slice.call(arguments); |
| | } |
| |
|
| | if (!Array.isArray(filters)) { |
| | filters = [filters]; |
| | } |
| |
|
| | this._currentOutput.videoFilters(utils.makeFilterStrings(filters)); |
| |
|
| | return this; |
| | }; |
| |
|
| |
|
| | /** |
| | * Specify output FPS |
| | * |
| | * @method FfmpegCommand#fps |
| | * @category Video |
| | * @aliases withOutputFps,withOutputFPS,withFpsOutput,withFPSOutput,withFps,withFPS,outputFPS,outputFps,fpsOutput,FPSOutput,FPS |
| | * |
| | * @param {Number} fps output FPS |
| | * @return FfmpegCommand |
| | */ |
| | proto.withOutputFps = |
| | proto.withOutputFPS = |
| | proto.withFpsOutput = |
| | proto.withFPSOutput = |
| | proto.withFps = |
| | proto.withFPS = |
| | proto.outputFPS = |
| | proto.outputFps = |
| | proto.fpsOutput = |
| | proto.FPSOutput = |
| | proto.fps = |
| | proto.FPS = function(fps) { |
| | this._currentOutput.video('-r', fps); |
| | return this; |
| | }; |
| |
|
| |
|
| | /** |
| | * Only transcode a certain number of frames |
| | * |
| | * @method FfmpegCommand#frames |
| | * @category Video |
| | * @aliases takeFrames,withFrames |
| | * |
| | * @param {Number} frames frame count |
| | * @return FfmpegCommand |
| | */ |
| | proto.takeFrames = |
| | proto.withFrames = |
| | proto.frames = function(frames) { |
| | this._currentOutput.video('-vframes', frames); |
| | 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> |
| |
|
