mention getUserMedia options in desktop-capturer docs
author=^._.^= <max@maxogden.com>
Tue, 15 Dec 2015 22:07:55 +0000 (14:07 -0800)
committer=^._.^= <max@maxogden.com>
Tue, 15 Dec 2015 22:07:55 +0000 (14:07 -0800)
docs/api/desktop-capturer.md

index e0ec758..7863622 100644 (file)
@@ -38,6 +38,15 @@ function getUserMediaError(e) {
 }
 ```
 
+When creating a constraints object for the `navigator.webkitGetUserMedia` call,
+if you are using a source from `desktopCapturer` your `chromeMediaSource` must
+be set to `"desktop"` and your `audio` must be set to `false`. 
+
+If you wish to
+capture the audio and video from the entire desktop you can set
+`chromeMediaSource` to `"screen"` and `audio` to `true`. When using this method
+you cannot specify a `chromeMediaSourceId`.
+
 ## Methods
 
 The `desktopCapturer` module has the following methods: