Update README and examples, commit jsdoc

fluent-ffmpeg · May 3, 2014 · 5614110 · 5614110
1 parent ff85414
commit 5614110
Show file tree

Hide file tree

Showing 35 changed files with 12,847 additions and 488 deletions.
diff --git a/README.md b/README.md
diff --git a/doc/FfmpegCommand.html b/doc/FfmpegCommand.html
diff --git a/doc/audio.js.html b/doc/audio.js.html
@@ -0,0 +1,173 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Source: options/audio.js</title>
+
+    <script src="scripts/prettify/prettify.js"> </script>
+    <script src="scripts/prettify/lang-css.js"> </script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <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/audio.js</h1>
+
+
+
+
+
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>/*jshint node:true*/
+'use strict';
+
+/*
+ *! Audio-related methods
+ */
+
+module.exports = function(proto) {
+  /**
+   * Disable audio in the output
+   *
+   * @method FfmpegCommand#noAudio
+   * @return FfmpegCommand
+   */
+  proto.withNoAudio =
+  proto.noAudio = function() {
+    this._audio.clear();
+    this._audio('-an');
+
+    return this;
+  };
+
+
+  /**
+   * Specify audio codec
+   *
+   * @method FfmpegCommand#audioCodec
+   * @param {String} codec audio codec name
+   * @return FfmpegCommand
+   */
+  proto.withAudioCodec =
+  proto.audioCodec = function(codec) {
+    this._audio('-acodec', codec);
+    return this;
+  };
+
+
+  /**
+   * Specify audio bitrate
+   *
+   * @method FfmpegCommand#audioBitrate
+   * @param {String|Number} bitrate audio bitrate in kbps (with an optional 'k' suffix)
+   * @return FfmpegCommand
+   */
+  proto.withAudioBitrate =
+  proto.audioBitrate = function(bitrate) {
+    this._audio('-b:a', ('' + bitrate).replace(/k?$/, 'k'));
+    return this;
+  };
+
+
+  /**
+   * Specify audio channel count
+   *
+   * @method FfmpegCommand#audioChannels
+   * @param {Number} channels channel count
+   * @return FfmpegCommand
+   */
+  proto.withAudioChannels =
+  proto.audioChannels = function(channels) {
+    this._audio('-ac', channels);
+    return this;
+  };
+
+
+  /**
+   * Specify audio frequency
+   *
+   * @method FfmpegCommand#audioFrequency
+   * @param {Number} freq audio frequency in Hz
+   * @return FfmpegCommand
+   */
+  proto.withAudioFrequency =
+  proto.audioFrequency = function(freq) {
+    this._audio('-ar', freq);
+    return this;
+  };
+
+
+  /**
+   * Specify audio quality
+   *
+   * @method FfmpegCommand#audioQuality
+   * @param {Number} quality audio quality factor
+   * @return FfmpegCommand
+   */
+  proto.withAudioQuality =
+  proto.audioQuality = function(quality) {
+    this._audio('-aq', quality);
+    return this;
+  };
+
+
+  /**
+   * Specify custom audio filter(s)
+   *
+   * Can be called both with one or many filters, or a filter array.
+   *
+   * @example
+   * command.audioFilters('filter1');
+   *
+   * @example
+   * command.audioFilters('filter1', 'filter2');
+   *
+   * @example
+   * command.audioFilters(['filter1', 'filter2']);
+   *
+   * @method FfmpegCommand#audioFilters
+   * @param {String|Array} filters... audio filter strings or string array
+   * @return FfmpegCommand
+   */
+  proto.withAudioFilter =
+  proto.withAudioFilters =
+  proto.audioFilter =
+  proto.audioFilters = function(filters) {
+    if (arguments.length > 1) {
+      filters = [].slice.call(arguments);
+    }
+
+    this._audioFilters(filters);
+    return this;
+  };
+};
+</code></pre>
+        </article>
+    </section>
+
+
+
+
+</div>
+
+<nav>
+    <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>
+</nav>
+
+<br clear="both">
+
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha5</a> on Sat May 03 2014 20:15:59 GMT+0200 (CEST)
+</footer>
+
+<script> prettyPrint(); </script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>