document ytdl.exec() with audio example

przemyslawpluta · May 9, 2015 · 2b8333f · 2b8333f
1 parent e7cc0d5
commit 2b8333f
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,7 @@
 *.mp4
 *.webm
 *.srt
+*.mp3
+*.m4a
 node_modules
 bin
diff --git a/README.md b/README.md
@@ -125,6 +125,19 @@ Will print something like
  24video
  3sat
 
+## Call the `youtube-dl` binary directly
+
+This module doesn't have `youtube-dl` download the video. Instead, it uses the `url` key from the `--dump-json` CLI option to create a node stream. That way, it can be used like any other node stream.
+
+If that, or none of the above support your use case, you can use `ytdl.exec()` to call `youtube-dl` however you like.
+
+```javascript
+ytdl.exec(url, ['-x', '--audio-format', 'mp3'], {}, function(err, output) {
+ if (err) throw err;
+ console.log(output.join('\n'));
+});
+```
+
 # Install
 
  npm install youtube-dl

diff --git a/example/audio.js b/example/audio.js
@@ -0,0 +1,8 @@
+var ytdl = require('..');
+
+
+var url = 'https://www.youtube.com/watch?v=H7HmzwI67ec';
+ytdl.exec(url, ['-x', '--audio-format', 'mp3'], {}, function(err, output) {
+ if (err) throw err;
+ console.log(output.join('\n'));
+});