From c98db82668b41ec4d62d27b8074042385bd9e452 Mon Sep 17 00:00:00 2001 From: "=^._.^=" Date: Tue, 15 Dec 2015 14:07:55 -0800 Subject: [PATCH] mention getUserMedia options in desktop-capturer docs --- docs/api/desktop-capturer.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/api/desktop-capturer.md b/docs/api/desktop-capturer.md index e0ec75842841..7863622e372a 100644 --- a/docs/api/desktop-capturer.md +++ b/docs/api/desktop-capturer.md @@ -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: