CINXE.COM

<!doctype html><html lang="en-US" prefix="og: https://ogp.me/ns#"><head><meta charSet="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1"/><link rel="icon" href="https://developer.mozilla.org/favicon-48x48.bc390275e955dacb2e65.png"/><link rel="apple-touch-icon" href="https://developer.mozilla.org/apple-touch-icon.528534bba673c38049c2.png"/><meta name="theme-color" content="#ffffff"/><link rel="manifest" href="https://developer.mozilla.org/manifest.f42880861b394dd4dc9b.json"/><link rel="search" type="application/opensearchdescription+xml" href="/opensearch.xml" title="MDN Web Docs"/><title>MediaDevices: getUserMedia() method - Web APIs | MDN</title><link rel="alternate" title="MediaDevices: Methode getUserMedia()" href="https://developer.mozilla.org/de/docs/Web/API/MediaDevices/getUserMedia" hrefLang="de"/><link rel="alternate" title="MediaDevices.getUserMedia()" href="https://developer.mozilla.org/es/docs/Web/API/MediaDevices/getUserMedia" hrefLang="es"/><link rel="alternate" title="MediaDevices.getUserMedia()" href="https://developer.mozilla.org/fr/docs/Web/API/MediaDevices/getUserMedia" hrefLang="fr"/><link rel="alternate" title="MediaDevices: getUserMedia() メソッド" href="https://developer.mozilla.org/ja/docs/Web/API/MediaDevices/getUserMedia" hrefLang="ja"/><link rel="alternate" title="MediaDevices.getUserMedia()" href="https://developer.mozilla.org/ru/docs/Web/API/MediaDevices/getUserMedia" hrefLang="ru"/><link rel="alternate" title="MediaDevices.getUserMedia()" href="https://developer.mozilla.org/zh-CN/docs/Web/API/MediaDevices/getUserMedia" hrefLang="zh"/><link rel="alternate" title="MediaDevices: getUserMedia() method" href="https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia" hrefLang="en"/><link rel="preload" as="font" type="font/woff2" href="/static/media/Inter.var.c2fe3cb2b7c746f7966a.woff2" crossorigin=""/><link rel="alternate" type="application/rss+xml" title="MDN Blog RSS Feed" href="https://developer.mozilla.org/en-US/blog/rss.xml" hrefLang="en"/><meta name="description" content="Learn about the MediaDevices.getUserMedia() method, including its syntax, code examples, specifications, and browser compatibility."/><meta property="og:url" content="https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia"/><meta property="og:title" content="MediaDevices: getUserMedia() method - Web APIs | MDN"/><meta property="og:type" content="website"/><meta property="og:locale" content="en_US"/><meta property="og:description" content="The getUserMedia() method of the MediaDevices interface prompts the user for permission to use a media input which produces a MediaStream with tracks containing the requested types of media."/><meta property="og:image" content="https://developer.mozilla.org/mdn-social-share.d893525a4fb5fb1f67a2.png"/><meta property="og:image:type" content="image/png"/><meta property="og:image:height" content="1080"/><meta property="og:image:width" content="1920"/><meta property="og:image:alt" content="The MDN Web Docs logo, featuring a blue accent color, displayed on a solid black background."/><meta property="og:site_name" content="MDN Web Docs"/><meta name="twitter:card" content="summary_large_image"/><meta name="twitter:creator" content="MozDevNet"/><link rel="canonical" href="https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia"/><style media="print">.article-actions-container,.document-toc-container,.language-menu,.main-menu-toggle,.on-github,.page-footer,.place,.sidebar,.top-banner,.top-navigation-main,ul.prev-next{display:none!important}.main-page-content,.main-page-content pre{padding:2px}.main-page-content pre{border-left-width:2px}</style><script src="/static/js/gtag.js" defer=""></script><script defer="" src="/static/js/main.d21ae86f.js"></script><link href="/static/css/main.26c64ea7.css" rel="stylesheet"/></head><body><script>if(document.body.addEventListener("load",(t=>{t.target.classList.contains("interactive")&&t.target.setAttribute("data-readystate","complete")}),{capture:!0}),window&&document.documentElement){const t={light:"#ffffff",dark:"#1b1b1b"};try{const e=window.localStorage.getItem("theme");e&&(document.documentElement.className=e,document.documentElement.style.backgroundColor=t[e]);const o=window.localStorage.getItem("nop");o&&(document.documentElement.dataset.nop=o)}catch(t){console.warn("Unable to read theme from localStorage",t)}}</script><div id="root"><ul id="nav-access" class="a11y-nav"><li><a id="skip-main" href="#content">Skip to main content</a></li><li><a id="skip-search" href="#top-nav-search-input">Skip to search</a></li><li><a id="skip-select-language" href="#languages-switcher-button">Skip to select language</a></li></ul><div class="page-wrapper category-api document-page"><div class="top-banner loading"><section class="place top container"></section></div><div class="sticky-header-container"><header class="top-navigation "><div class="container "><div class="top-navigation-wrap"><a href="/en-US/" class="logo" aria-label="MDN homepage"><svg id="mdn-docs-logo" xmlns="http://www.w3.org/2000/svg" x="0" y="0" viewBox="0 0 694.9 104.4" style="enable-background:new 0 0 694.9 104.4" xml:space="preserve" role="img"><title>MDN Web Docs</title><path d="M40.3 0 11.7 92.1H0L28.5 0h11.8zm10.4 0v92.1H40.3V0h10.4zM91 0 62.5 92.1H50.8L79.3 0H91zm10.4 0v92.1H91V0h10.4z" class="logo-m"></path><path d="M627.9 95.6h67v8.8h-67v-8.8z" class="logo-_"></path><path d="M367 42h-4l-10.7 30.8h-5.5l-10.8-26h-.4l-10.5 26h-5.2L308.7 42h-3.8v-5.6H323V42h-6.5l6.8 20.4h.4l10.3-26h4.7l11.2 26h.5l5.7-20.3h-6.2v-5.6H367V42zm34.9 20c-.4 3.2-2 5.9-4.7 8.2-2.8 2.3-6.5 3.4-11.3 3.4-5.4 0-9.7-1.6-13.1-4.7-3.3-3.2-5-7.7-5-13.7 0-5.7 1.6-10.3 4.7-14s7.4-5.5 12.9-5.5c5.1 0 9.1 1.6 11.9 4.7s4.3 6.9 4.3 11.3c0 1.5-.2 3-.5 4.7h-25.6c.3 7.7 4 11.6 10.9 11.6 2.9 0 5.1-.7 6.5-2 1.5-1.4 2.5-3 3-4.9l6 .9zM394 51.3c.2-2.4-.4-4.7-1.8-6.9s-3.8-3.3-7-3.3c-3.1 0-5.3 1-6.9 3-1.5 2-2.5 4.4-2.8 7.2H394zm51 2.4c0 5-1.3 9.5-4 13.7s-6.9 6.2-12.7 6.2c-6 0-10.3-2.2-12.7-6.7-.1.4-.2 1.4-.4 2.9s-.3 2.5-.4 2.9h-7.3c.3-1.7.6-3.5.8-5.3.3-1.8.4-3.7.4-5.5V22.3h-6v-5.6H416v27c1.1-2.2 2.7-4.1 4.7-5.7 2-1.6 4.8-2.4 8.4-2.4 4.6 0 8.4 1.6 11.4 4.7 3 3.2 4.5 7.6 4.5 13.4zm-7.7.6c0-4.2-1-7.4-3-9.5-2-2.2-4.4-3.3-7.4-3.3-3.4 0-6 1.2-8 3.7-1.9 2.4-2.9 5-3 7.7V57c0 3 1 5.6 3 7.7s4.5 3.1 7.6 3.1c3.6 0 6.3-1.3 8.1-3.9 1.8-2.7 2.7-5.9 2.7-9.6zm69.2 18.5h-13.2v-7.2c-1.2 2.2-2.8 4.1-4.9 5.6-2.1 1.6-4.8 2.4-8.3 2.4-4.8 0-8.7-1.6-11.6-4.9-2.9-3.2-4.3-7.7-4.3-13.3 0-5 1.3-9.6 4-13.7 2.6-4.1 6.9-6.2 12.8-6.2 5.7 0 9.8 2.2 12.3 6.5V22.3h-8.6v-5.6h15.8v50.6h6v5.5zM493.2 56v-4.4c-.1-3-1.2-5.5-3.2-7.3s-4.4-2.8-7.2-2.8c-3.6 0-6.3 1.3-8.2 3.9-1.9 2.6-2.8 5.8-2.8 9.6 0 4.1 1 7.3 3 9.5s4.5 3.3 7.4 3.3c3.2 0 5.8-1.3 7.8-3.8 2.1-2.6 3.1-5.3 3.2-8zm53.1-1.4c0 5.6-1.8 10.2-5.3 13.7s-8.2 5.3-13.9 5.3-10.1-1.7-13.4-5.1c-3.3-3.4-5-7.9-5-13.5 0-5.3 1.6-9.9 4.7-13.7 3.2-3.8 7.9-5.7 14.2-5.7s11 1.9 14.1 5.7c3 3.7 4.6 8.1 4.6 13.3zm-7.7-.2c0-4-1-7.2-3-9.5s-4.8-3.5-8.2-3.5c-3.6 0-6.4 1.2-8.3 3.7s-2.9 5.6-2.9 9.5c0 3.7.9 6.8 2.8 9.4 1.9 2.6 4.6 3.9 8.3 3.9 3.6 0 6.4-1.3 8.4-3.8 1.9-2.6 2.9-5.8 2.9-9.7zm45 5.8c-.4 3.2-1.9 6.3-4.4 9.1-2.5 2.9-6.4 4.3-11.8 4.3-5.2 0-9.4-1.6-12.6-4.8-3.2-3.2-4.8-7.7-4.8-13.7 0-5.5 1.6-10.1 4.7-13.9 3.2-3.8 7.6-5.7 13.2-5.7 2.3 0 4.6.3 6.7.8 2.2.5 4.2 1.5 6.2 2.9l1.5 9.5-5.9.7-1.3-6.1c-2.1-1.2-4.5-1.8-7.2-1.8-3.5 0-6.1 1.2-7.7 3.7-1.7 2.5-2.5 5.7-2.5 9.6 0 4.1.9 7.3 2.7 9.5 1.8 2.3 4.4 3.4 7.8 3.4 5.2 0 8.2-2.9 9.2-8.8l6.2 1.3zm34.7 1.9c0 3.6-1.5 6.5-4.6 8.5s-7 3-11.7 3c-5.7 0-10.6-1.2-14.6-3.6l1.2-8.8 5.7.6-.2 4.7c1.1.5 2.3.9 3.6 1.1s2.6.3 3.9.3c2.4 0 4.5-.4 6.5-1.3 1.9-.9 2.9-2.2 2.9-4.1 0-1.8-.8-3.1-2.3-3.8s-3.5-1.3-5.8-1.7-4.6-.9-6.9-1.4c-2.3-.6-4.2-1.6-5.7-2.9-1.6-1.4-2.3-3.5-2.3-6.3 0-4.1 1.5-6.9 4.6-8.5s6.4-2.4 9.9-2.4c2.6 0 5 .3 7.2.9 2.2.6 4.3 1.4 6.1 2.4l.8 8.8-5.8.7-.8-5.7c-2.3-1-4.7-1.6-7.2-1.6-2.1 0-3.7.4-5.1 1.1-1.3.8-2 2-2 3.8 0 1.7.8 2.9 2.3 3.6 1.5.7 3.4 1.2 5.7 1.6 2.2.4 4.5.8 6.7 1.4 2.2.6 4.1 1.6 5.7 3 1.4 1.6 2.2 3.7 2.2 6.6zM197.6 73.2h-17.1v-5.5h3.8V51.9c0-3.7-.7-6.3-2.1-7.9-1.4-1.6-3.3-2.3-5.7-2.3-3.2 0-5.6 1.1-7.2 3.4s-2.4 4.6-2.5 6.9v15.6h6v5.5h-17.1v-5.5h3.8V51.9c0-3.8-.7-6.4-2.1-7.9-1.4-1.5-3.3-2.3-5.6-2.3-3.2 0-5.5 1.1-7.2 3.3-1.6 2.2-2.4 4.5-2.5 6.9v15.8h6.9v5.5h-20.2v-5.5h6V42.4h-6.1v-5.6h13.4v6.4c1.2-2.1 2.7-3.8 4.7-5.2 2-1.3 4.4-2 7.3-2s5.3.7 7.5 2.1c2.2 1.4 3.7 3.5 4.5 6.4 1.1-2.5 2.7-4.5 4.9-6.1s4.8-2.4 7.9-2.4c3.5 0 6.5 1.1 8.9 3.3s3.7 5.6 3.7 10.2v18.2h6.1v5.5zm42.5 0h-13.2V66c-1.2 2.2-2.8 4.1-4.9 5.6-2.1 1.6-4.8 2.4-8.3 2.4-4.8 0-8.7-1.6-11.6-4.9-2.9-3.2-4.3-7.7-4.3-13.3 0-5 1.3-9.6 4-13.7 2.6-4.1 6.9-6.2 12.8-6.2s9.8 2.2 12.3 6.5V22.7h-8.6v-5.6h15.8v50.6h6v5.5zm-13.3-16.8V52c-.1-3-1.2-5.5-3.2-7.3s-4.4-2.8-7.2-2.8c-3.6 0-6.3 1.3-8.2 3.9-1.9 2.6-2.8 5.8-2.8 9.6 0 4.1 1 7.3 3 9.5s4.5 3.3 7.4 3.3c3.2 0 5.8-1.3 7.8-3.8 2.1-2.6 3.1-5.3 3.2-8zm61.5 16.8H269v-5.5h6V51.9c0-3.7-.7-6.3-2.2-7.9-1.4-1.6-3.4-2.3-5.7-2.3-3.1 0-5.6 1-7.4 3s-2.8 4.4-2.9 7v15.9h6v5.5h-19.3v-5.5h6V42.4h-6.2v-5.6h13.6V43c2.6-4.6 6.8-6.9 12.7-6.9 3.6 0 6.7 1.1 9.2 3.3s3.7 5.6 3.7 10.2v18.2h6v5.4h-.2z" class="logo-text"></path></svg></a><button title="Open main menu" type="button" class="button action has-icon main-menu-toggle" aria-haspopup="menu" aria-label="Open main menu" aria-expanded="false"><span class="button-wrap"><span class="icon icon-menu "></span><span class="visually-hidden">Open main menu</span></span></button></div><div class="top-navigation-main"><nav class="main-nav" aria-label="Main menu"><ul class="main-menu nojs"><li class="top-level-entry-container active"><button type="button" id="references-button" class="top-level-entry menu-toggle" aria-controls="references-menu" aria-expanded="false">References</button><a href="/en-US/docs/Web" class="top-level-entry">References</a><ul id="references-menu" class="submenu references hidden inline-submenu-lg" aria-labelledby="references-button"><li class="apis-link-container mobile-only "><a href="/en-US/docs/Web" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Overview / Web Technology</div><p class="submenu-item-description">Web technology reference for developers</p></div></a></li><li class="html-link-container "><a href="/en-US/docs/Web/HTML" class="submenu-item "><div class="submenu-icon html"></div><div class="submenu-content-container"><div class="submenu-item-heading">HTML</div><p class="submenu-item-description">Structure of content on the web</p></div></a></li><li class="css-link-container "><a href="/en-US/docs/Web/CSS" class="submenu-item "><div class="submenu-icon css"></div><div class="submenu-content-container"><div class="submenu-item-heading">CSS</div><p class="submenu-item-description">Code used to describe document style</p></div></a></li><li class="javascript-link-container "><a href="/en-US/docs/Web/JavaScript" class="submenu-item "><div class="submenu-icon javascript"></div><div class="submenu-content-container"><div class="submenu-item-heading">JavaScript</div><p class="submenu-item-description">General-purpose scripting language</p></div></a></li><li class="http-link-container "><a href="/en-US/docs/Web/HTTP" class="submenu-item "><div class="submenu-icon http"></div><div class="submenu-content-container"><div class="submenu-item-heading">HTTP</div><p class="submenu-item-description">Protocol for transmitting web resources</p></div></a></li><li class="apis-link-container "><a href="/en-US/docs/Web/API" class="submenu-item "><div class="submenu-icon apis"></div><div class="submenu-content-container"><div class="submenu-item-heading">Web APIs</div><p class="submenu-item-description">Interfaces for building web applications</p></div></a></li><li class="apis-link-container "><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Web Extensions</div><p class="submenu-item-description">Developing extensions for web browsers</p></div></a></li><li class="apis-link-container desktop-only "><a href="/en-US/docs/Web" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Web Technology</div><p class="submenu-item-description">Web technology reference for developers</p></div></a></li></ul></li><li class="top-level-entry-container "><button type="button" id="guides-button" class="top-level-entry menu-toggle" aria-controls="guides-menu" aria-expanded="false">Guides</button><a href="/en-US/docs/Learn" class="top-level-entry">Guides</a><ul id="guides-menu" class="submenu guides hidden inline-submenu-lg" aria-labelledby="guides-button"><li class="apis-link-container mobile-only "><a href="/en-US/docs/Learn" class="submenu-item "><div class="submenu-icon learn"></div><div class="submenu-content-container"><div class="submenu-item-heading">Overview / MDN Learning Area</div><p class="submenu-item-description">Learn web development</p></div></a></li><li class="apis-link-container desktop-only "><a href="/en-US/docs/Learn" class="submenu-item "><div class="submenu-icon learn"></div><div class="submenu-content-container"><div class="submenu-item-heading">MDN Learning Area</div><p class="submenu-item-description">Learn web development</p></div></a></li><li class="html-link-container "><a href="/en-US/docs/Learn/HTML" class="submenu-item "><div class="submenu-icon html"></div><div class="submenu-content-container"><div class="submenu-item-heading">HTML</div><p class="submenu-item-description">Learn to structure web content with HTML</p></div></a></li><li class="css-link-container "><a href="/en-US/docs/Learn/CSS" class="submenu-item "><div class="submenu-icon css"></div><div class="submenu-content-container"><div class="submenu-item-heading">CSS</div><p class="submenu-item-description">Learn to style content using CSS</p></div></a></li><li class="javascript-link-container "><a href="/en-US/docs/Learn/JavaScript" class="submenu-item "><div class="submenu-icon javascript"></div><div class="submenu-content-container"><div class="submenu-item-heading">JavaScript</div><p class="submenu-item-description">Learn to run scripts in the browser</p></div></a></li><li class=" "><a href="/en-US/docs/Web/Accessibility" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Accessibility</div><p class="submenu-item-description">Learn to make the web accessible to all</p></div></a></li></ul></li><li class="top-level-entry-container "><button type="button" id="mdn-plus-button" class="top-level-entry menu-toggle" aria-controls="mdn-plus-menu" aria-expanded="false">Plus</button><a href="/en-US/plus" class="top-level-entry">Plus</a><ul id="mdn-plus-menu" class="submenu mdn-plus hidden inline-submenu-lg" aria-labelledby="mdn-plus-button"><li class=" "><a href="/en-US/plus" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Overview</div><p class="submenu-item-description">A customized MDN experience</p></div></a></li><li class=" "><a href="/en-US/plus/ai-help" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">AI Help</div><p class="submenu-item-description">Get real-time assistance and support</p></div></a></li><li class=" "><a href="/en-US/plus/updates" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Updates</div><p class="submenu-item-description">All browser compatibility updates at a glance</p></div></a></li><li class=" "><a href="/en-US/plus/docs/features/overview" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Documentation</div><p class="submenu-item-description">Learn how to use MDN Plus</p></div></a></li><li class=" "><a href="/en-US/plus/docs/faq" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">FAQ</div><p class="submenu-item-description">Frequently asked questions about MDN Plus</p></div></a></li></ul></li><li class="top-level-entry-container "><a class="top-level-entry menu-link" href="/en-US/curriculum/">Curriculum <sup class="new">New</sup></a></li><li class="top-level-entry-container "><a class="top-level-entry menu-link" href="/en-US/blog/">Blog</a></li><li class="top-level-entry-container "><button type="button" id="tools-button" class="top-level-entry menu-toggle" aria-controls="tools-menu" aria-expanded="false">Tools</button><ul id="tools-menu" class="submenu tools hidden inline-submenu-lg" aria-labelledby="tools-button"><li class=" "><a href="/en-US/play" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Playground</div><p class="submenu-item-description">Write, test and share your code</p></div></a></li><li class=" "><a href="/en-US/observatory" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">HTTP Observatory</div><p class="submenu-item-description">Scan a website for free</p></div></a></li><li class=" "><a href="/en-US/plus/ai-help" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">AI Help</div><p class="submenu-item-description">Get real-time assistance and support</p></div></a></li></ul></li></ul></nav><div class="header-search"><form action="/en-US/search" class="search-form search-widget" id="top-nav-search-form" role="search"><label id="top-nav-search-label" for="top-nav-search-input" class="visually-hidden">Search MDN</label><input aria-activedescendant="" aria-autocomplete="list" aria-controls="top-nav-search-menu" aria-expanded="false" aria-labelledby="top-nav-search-label" autoComplete="off" id="top-nav-search-input" role="combobox" type="search" class="search-input-field" name="q" placeholder=" " required="" value=""/><button type="button" class="button action has-icon clear-search-button"><span class="button-wrap"><span class="icon icon-cancel "></span><span class="visually-hidden">Clear search input</span></span></button><button type="submit" class="button action has-icon search-button"><span class="button-wrap"><span class="icon icon-search "></span><span class="visually-hidden">Search</span></span></button><div id="top-nav-search-menu" role="listbox" aria-labelledby="top-nav-search-label"></div></form></div><div class="theme-switcher-menu"><button type="button" class="button action has-icon theme-switcher-menu small" aria-haspopup="menu"><span class="button-wrap"><span class="icon icon-theme-os-default "></span>Theme</span></button></div><ul class="auth-container"><li><a href="/users/fxa/login/authenticate/?next=%2Fen-US%2Fdocs%2FWeb%2FAPI%2FMediaDevices%2FgetUserMedia" class="login-link" rel="nofollow">Log in</a></li><li><a href="/users/fxa/login/authenticate/?next=%2Fen-US%2Fdocs%2FWeb%2FAPI%2FMediaDevices%2FgetUserMedia" target="_self" rel="nofollow" class="button primary mdn-plus-subscribe-link"><span class="button-wrap">Sign up for free</span></a></li></ul></div></div></header><div class="article-actions-container"><div class="container"><button type="button" class="button action has-icon sidebar-button" aria-label="Expand sidebar" aria-expanded="false" aria-controls="sidebar-quicklinks"><span class="button-wrap"><span class="icon icon-sidebar "></span></span></button><nav class="breadcrumbs-container" aria-label="Breadcrumb"><ol typeof="BreadcrumbList" vocab="https://schema.org/" aria-label="breadcrumbs"><li property="itemListElement" typeof="ListItem"><a href="/en-US/docs/Web" class="breadcrumb" property="item" typeof="WebPage"><span property="name">References</span></a><meta property="position" content="1"/></li><li property="itemListElement" typeof="ListItem"><a href="/en-US/docs/Web/API" class="breadcrumb" property="item" typeof="WebPage"><span property="name">Web APIs</span></a><meta property="position" content="2"/></li><li property="itemListElement" typeof="ListItem"><a href="/en-US/docs/Web/API/MediaDevices" class="breadcrumb" property="item" typeof="WebPage"><span property="name">MediaDevices</span></a><meta property="position" content="3"/></li><li property="itemListElement" typeof="ListItem"><a href="/en-US/docs/Web/API/MediaDevices/getUserMedia" class="breadcrumb-current-page" property="item" typeof="WebPage"><span property="name">getUserMedia()</span></a><meta property="position" content="4"/></li></ol></nav><div class="article-actions"><button type="button" class="button action has-icon article-actions-toggle" aria-label="Article actions"><span class="button-wrap"><span class="icon icon-ellipses "></span><span class="article-actions-dialog-heading">Article Actions</span></span></button><ul class="article-actions-entries"><li class="article-actions-entry"><div class="languages-switcher-menu open-on-focus-within"><button id="languages-switcher-button" type="button" class="button action small has-icon languages-switcher-menu" aria-haspopup="menu"><span class="button-wrap"><span class="icon icon-language "></span>English (US)</span></button><div class="hidden"><ul class="submenu language-menu " aria-labelledby="language-menu-button"><li class=" "><form class="submenu-item locale-redirect-setting"><div class="group"><label class="switch"><input type="checkbox" name="locale-redirect"/><span class="slider"></span><span class="label">Remember language</span></label><a href="https://github.com/orgs/mdn/discussions/739" rel="external noopener noreferrer" target="_blank" title="Enable this setting to automatically switch to this language when it's available. (Click to learn more.)"><span class="icon icon-question-mark "></span></a></div></form></li><li class=" "><a data-locale="de" href="/de/docs/Web/API/MediaDevices/getUserMedia" class="button submenu-item"><span>Deutsch</span><span title="Diese Übersetzung ist Teil eines Experiments."><span class="icon icon-experimental "></span></span></a></li><li class=" "><a data-locale="es" href="/es/docs/Web/API/MediaDevices/getUserMedia" class="button submenu-item"><span>Español</span></a></li><li class=" "><a data-locale="fr" href="/fr/docs/Web/API/MediaDevices/getUserMedia" class="button submenu-item"><span>Français</span></a></li><li class=" "><a data-locale="ja" href="/ja/docs/Web/API/MediaDevices/getUserMedia" class="button submenu-item"><span>日本語</span></a></li><li class=" "><a data-locale="ru" href="/ru/docs/Web/API/MediaDevices/getUserMedia" class="button submenu-item"><span>Русский</span></a></li><li class=" "><a data-locale="zh-CN" href="/zh-CN/docs/Web/API/MediaDevices/getUserMedia" class="button submenu-item"><span>中文 (简体)</span></a></li></ul></div></div></li></ul></div></div></div></div><div class="main-wrapper"><div class="sidebar-container"><aside id="sidebar-quicklinks" class="sidebar" data-macro="APIRef"><button type="button" class="button action backdrop" aria-label="Collapse sidebar"><span class="button-wrap"></span></button><nav aria-label="Related Topics" class="sidebar-inner"><header class="sidebar-actions"><section class="sidebar-filter-container"><div class="sidebar-filter "><label id="sidebar-filter-label" class="sidebar-filter-label" for="sidebar-filter-input"><span class="icon icon-filter"></span><span class="visually-hidden">Filter sidebar</span></label><input id="sidebar-filter-input" autoComplete="off" class="sidebar-filter-input-field false" type="text" placeholder="Filter" value=""/><button type="button" class="button action has-icon clear-sidebar-filter-button"><span class="button-wrap"><span class="icon icon-cancel "></span><span class="visually-hidden">Clear filter input</span></span></button></div></section></header><div class="sidebar-inner-nav"><div class="in-nav-toc"><div class="document-toc-container"><section class="document-toc"><header><h2 class="document-toc-heading">In this article</h2></header><ul class="document-toc-list"><li class="document-toc-item "><a class="document-toc-link" href="#syntax">Syntax</a></li><li class="document-toc-item "><a class="document-toc-link" href="#privacy_and_security">Privacy and security</a></li><li class="document-toc-item "><a class="document-toc-link" href="#examples">Examples</a></li><li class="document-toc-item "><a class="document-toc-link" href="#specifications">Specifications</a></li><li class="document-toc-item "><a class="document-toc-link" href="#browser_compatibility">Browser compatibility</a></li><li class="document-toc-item "><a class="document-toc-link" href="#see_also">See also</a></li></ul></section></div></div><div class="sidebar-body"><ol><li class="section"><a href="/en-US/docs/Web/API/Media_Capture_and_Streams_API">Media Capture and Streams API</a></li><li class="section"><a href="/en-US/docs/Web/API/MediaDevices"><code>MediaDevices</code></a></li><li class="toggle"><details open=""><summary>Instance methods</summary><ol><li><a href="/en-US/docs/Web/API/MediaDevices/enumerateDevices"><code>enumerateDevices()</code></a></li><li><a href="/en-US/docs/Web/API/MediaDevices/getDisplayMedia"><code>getDisplayMedia()</code></a></li><li><a href="/en-US/docs/Web/API/MediaDevices/getSupportedConstraints"><code>getSupportedConstraints()</code></a></li><li><em><code>getUserMedia()</code> </em></li><li><a href="/en-US/docs/Web/API/MediaDevices/selectAudioOutput"><code>selectAudioOutput()</code></a><abbr class="icon icon-experimental" title="Experimental. Expect behavior to change in the future."> <span class="visually-hidden">Experimental</span> </abbr></li></ol></details></li><li class="toggle"><details open=""><summary>Events</summary><ol><li><a href="/en-US/docs/Web/API/MediaDevices/devicechange_event"><code>devicechange</code></a></li></ol></details></li><li class="toggle"><details open=""><summary>Inheritance</summary><ol><li><a href="/en-US/docs/Web/API/EventTarget"><code>EventTarget</code></a></li></ol></details></li><li class="toggle"><details open=""><summary>Related pages for Media Capture and Streams</summary><ol><li><a href="/en-US/docs/Web/API/CanvasCaptureMediaStreamTrack"><code>CanvasCaptureMediaStreamTrack</code></a></li><li><a href="/en-US/docs/Web/API/HTMLCanvasElement/captureStream"><code>HTMLCanvasElement.captureStream()</code></a></li><li><a href="/en-US/docs/Web/API/HTMLMediaElement/captureStream"><code>HTMLMediaElement.captureStream()</code></a></li><li><a href="/en-US/docs/Web/API/InputDeviceInfo"><code>InputDeviceInfo</code></a></li><li><a href="/en-US/docs/Web/API/MediaDeviceInfo"><code>MediaDeviceInfo</code></a></li><li><a href="/en-US/docs/Web/API/MediaStream"><code>MediaStream</code></a></li><li><a href="/en-US/docs/Web/API/MediaStreamTrack"><code>MediaStreamTrack</code></a></li><li><a href="/en-US/docs/Web/API/MediaStreamTrackEvent"><code>MediaStreamTrackEvent</code></a></li><li><a href="/en-US/docs/Web/API/MediaTrackConstraints"><code>MediaTrackConstraints</code></a></li><li><a href="/en-US/docs/Web/API/MediaTrackSettings"><code>MediaTrackSettings</code></a></li><li><a href="/en-US/docs/Web/API/MediaTrackSupportedConstraints"><code>MediaTrackSupportedConstraints</code></a></li><li><a href="/en-US/docs/Web/API/Navigator/mediaDevices"><code>Navigator.mediaDevices</code></a></li><li><a href="/en-US/docs/Web/API/OverconstrainedError"><code>OverconstrainedError</code></a></li></ol></details></li></ol></div></div><section class="place side"></section></nav></aside><div class="toc-container"><aside class="toc"><nav><div class="document-toc-container"><section class="document-toc"><header><h2 class="document-toc-heading">In this article</h2></header><ul class="document-toc-list"><li class="document-toc-item "><a class="document-toc-link" href="#syntax">Syntax</a></li><li class="document-toc-item "><a class="document-toc-link" href="#privacy_and_security">Privacy and security</a></li><li class="document-toc-item "><a class="document-toc-link" href="#examples">Examples</a></li><li class="document-toc-item "><a class="document-toc-link" href="#specifications">Specifications</a></li><li class="document-toc-item "><a class="document-toc-link" href="#browser_compatibility">Browser compatibility</a></li><li class="document-toc-item "><a class="document-toc-link" href="#see_also">See also</a></li></ul></section></div></nav></aside><section class="place side"></section></div></div><main id="content" class="main-content "><article class="main-page-content" lang="en-US"><header><h1>MediaDevices: getUserMedia() method</h1><details class="baseline-indicator high"><summary><span class="indicator" role="img" aria-label="Baseline Check"></span><h2>Baseline <span class="not-bold">Widely available</span></h2><div class="browsers"><span class="engine" title="Supported in Chrome and Edge"><span class="browser chrome supported" role="img" aria-label="Chrome check"></span><span class="browser edge supported" role="img" aria-label="Edge check"></span></span><span class="engine" title="Supported in Firefox"><span class="browser firefox supported" role="img" aria-label="Firefox check"></span></span><span class="engine" title="Supported in Safari"><span class="browser safari supported" role="img" aria-label="Safari check"></span></span></div><span class="icon icon-chevron "></span></summary><div class="extra"><p>This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2017.</p><ul><li><a href="/en-US/docs/Glossary/Baseline/Compatibility" data-glean="baseline_link_learn_more" target="_blank" class="learn-more">Learn more</a></li><li><a href="#browser_compatibility" data-glean="baseline_link_bcd_table">See full compatibility</a></li><li><a href="https://survey.alchemer.com/s3/7634825/MDN-baseline-feedback?page=%2Fen-US%2Fdocs%2FWeb%2FAPI%2FMediaDevices%2FgetUserMedia&level=high" data-glean="baseline_link_feedback" class="feedback-link" target="_blank" rel="noreferrer">Report feedback</a></li></ul></div></details></header><div class="section-content"><div class="notecard secure"><p><strong>Secure context:</strong> This feature is available only in <a href="/en-US/docs/Web/Security/Secure_Contexts">secure contexts</a> (HTTPS), in some or all <a href="#browser_compatibility">supporting browsers</a>.</p></div> <p>The <strong><code>getUserMedia()</code></strong> method of the <a href="/en-US/docs/Web/API/MediaDevices"><code>MediaDevices</code></a> interface prompts the user for permission to use a media input which produces a <a href="/en-US/docs/Web/API/MediaStream"><code>MediaStream</code></a> with tracks containing the requested types of media.</p> <p>That stream can include, for example, a video track (produced by either a hardware or virtual video source such as a camera, video recording device, screen sharing service, and so forth), an audio track (similarly, produced by a physical or virtual audio source like a microphone, A/D converter, or the like), and possibly other track types.</p> <p> It returns a <a href="/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"><code>Promise</code></a> that resolves to a <a href="/en-US/docs/Web/API/MediaStream"><code>MediaStream</code></a> object. If the user denies permission, or matching media is not available, then the promise is rejected with <code>NotAllowedError</code> or <code>NotFoundError</code> <a href="/en-US/docs/Web/API/DOMException"><code>DOMException</code></a> respectively. </p> <div class="notecard note"> <p><strong>Note:</strong> It's possible for the returned promise to <em>neither</em> resolve nor reject, as the user is not required to make a choice at all and may ignore the request.</p> </div></div><section aria-labelledby="syntax"><h2 id="syntax"><a href="#syntax">Syntax</a></h2><div class="section-content"><div class="code-example"><div class="example-header"><span class="language-name">js</span></div><pre class="brush: js notranslate"><code>getUserMedia(constraints) </code></pre></div></div></section><section aria-labelledby="parameters"><h3 id="parameters"><a href="#parameters">Parameters</a></h3><div class="section-content"><dl> <dt id="constraints"><a href="#constraints"><code>constraints</code></a></dt> <dd> <p> An object specifying the types of media to request, along with any requirements for each type. </p> <p> The <code>constraints</code> parameter is an object with two members: <code>video</code> and <code>audio</code>, describing the media types requested. Either or both must be specified. If the browser cannot find all media tracks with the specified types that meet the constraints given, then the returned promise is rejected with <code>NotFoundError</code> <a href="/en-US/docs/Web/API/DOMException"><code>DOMException</code></a>. </p> <p>For both <code>video</code> and <code>audio</code>, its value is either a boolean or an object. The default value is <code>false</code>.</p> <ul> <li>If <code>true</code> is specified for a media type, the resulting stream is <em>required</em> to have that type of track in it. If one cannot be included for any reason, the returned promise will reject.</li> <li>If <code>false</code> is specified for a media type, the resulting stream <em>must not</em> have that type of track, or the returned promise will reject. Because both <code>video</code> and <code>audio</code> default to <code>false</code>, if the <code>constraints</code> object contains neither property or if it's not present at all, the returned promise will always reject.</li> <li>If an object is specified for a media type, the object is read as a <a href="/en-US/docs/Web/API/MediaTrackConstraints"><code>MediaTrackConstraints</code></a> dictionary.</li> </ul> </dd> </dl></div></section><section aria-labelledby="return_value"><h3 id="return_value"><a href="#return_value">Return value</a></h3><div class="section-content"><p> A <a href="/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"><code>Promise</code></a> whose fulfillment handler receives a <a href="/en-US/docs/Web/API/MediaStream"><code>MediaStream</code></a> object when the requested media has successfully been obtained. </p></div></section><section aria-labelledby="exceptions"><h3 id="exceptions"><a href="#exceptions">Exceptions</a></h3><div class="section-content"><dl> <dt id="aborterror"><a href="#aborterror"><code>AbortError</code></a> <a href="/en-US/docs/Web/API/DOMException"><code>DOMException</code></a></dt> <dd> <p> Although the user and operating system both granted access to the hardware device, and no hardware issues occurred that would cause a <code>NotReadableError</code> <a href="/en-US/docs/Web/API/DOMException"><code>DOMException</code></a>, throw if some problem occurred which prevented the device from being used. </p> </dd> <dt id="invalidstateerror"><a href="#invalidstateerror"><code>InvalidStateError</code></a> <a href="/en-US/docs/Web/API/DOMException"><code>DOMException</code></a></dt> <dd> <p>Thrown if current document is not fully active.</p> </dd> <dt id="notallowederror"><a href="#notallowederror"><code>NotAllowedError</code></a> <a href="/en-US/docs/Web/API/DOMException"><code>DOMException</code></a></dt> <dd> <p> Thrown if one or more of the requested source devices cannot be used at this time. This will happen if the browsing context is insecure (that is, the page was loaded using HTTP rather than HTTPS). It also happens if the user has specified that the current browsing instance is not permitted access to the device, the user has denied access for the current session, or the user has denied all access to user media devices globally. On browsers that support managing media permissions with <a href="/en-US/docs/Web/HTTP/Permissions_Policy">Permissions Policy</a>, this error is returned if Permissions Policy is not configured to allow access to the input source(s). </p> <div class="notecard note"> <p> <strong>Note:</strong> Older versions of the specification used <code>SecurityError</code> for this instead; <code>SecurityError</code> has taken on a new meaning. </p> </div> </dd> <dt id="notfounderror"><a href="#notfounderror"><code>NotFoundError</code></a> <a href="/en-US/docs/Web/API/DOMException"><code>DOMException</code></a></dt> <dd> <p>Thrown if no media tracks of the type specified were found that satisfy the given constraints.</p> </dd> <dt id="notreadableerror"><a href="#notreadableerror"><code>NotReadableError</code></a> <a href="/en-US/docs/Web/API/DOMException"><code>DOMException</code></a></dt> <dd> <p> Thrown if, although the user granted permission to use the matching devices, a hardware error occurred at the operating system, browser, or Web page level which prevented access to the device. </p> </dd> <dt id="overconstrainederror"><a href="#overconstrainederror"><code>OverconstrainedError</code></a> <a href="/en-US/docs/Web/API/DOMException"><code>DOMException</code></a></dt> <dd> <p> Thrown if the specified constraints resulted in no candidate devices which met the criteria requested. The error is an object of type <code>OverconstrainedError</code>, and has a <code>constraint</code> property whose string value is the name of a constraint which was impossible to meet, and a <code>message</code> property containing a human-readable string explaining the problem. </p> <div class="notecard note"> <p> <strong>Note:</strong> Because this error can occur even when the user has not yet granted permission to use the underlying device, it can potentially be used as a <a href="/en-US/docs/Glossary/Fingerprinting">fingerprinting</a> surface. </p> </div> </dd> <dt id="securityerror"><a href="#securityerror"><code>SecurityError</code></a> <a href="/en-US/docs/Web/API/DOMException"><code>DOMException</code></a></dt> <dd> <p> Thrown if user media support is disabled on the <a href="/en-US/docs/Web/API/Document"><code>Document</code></a> on which <code>getUserMedia()</code> was called. The mechanism by which user media support is enabled and disabled is left up to the individual user agent. </p> </dd> <dt id="typeerror"><a href="/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypeError"><code>TypeError</code></a></dt> <dd> <p> Thrown if the list of constraints specified is empty, or has all constraints set to <code>false</code>. This can also happen if you try to call <code>getUserMedia()</code> in an insecure context, since <a href="/en-US/docs/Web/API/Navigator/mediaDevices"><code>navigator.mediaDevices</code></a> is <code>undefined</code> in an insecure context. </p> </dd> </dl></div></section><section aria-labelledby="privacy_and_security"><h2 id="privacy_and_security"><a href="#privacy_and_security">Privacy and security</a></h2><div class="section-content"><p> As an API that may involve significant privacy concerns, <code>getUserMedia()</code>'s specification lays out a wide array of privacy and security requirements that browsers are obligated to meet. </p> <p> <code>getUserMedia()</code> is a powerful feature that can only be used in <a href="/en-US/docs/Web/Security/Secure_Contexts">secure contexts</a>; in insecure contexts, <code>navigator.mediaDevices</code> is <code>undefined</code>, preventing access to <code>getUserMedia()</code>. A secure context is, in short, a page loaded using HTTPS or the <code>file:///</code> URL scheme, or a page loaded from <code>localhost</code>. </p> <p> In addition, user permission is always required to access the user's audio and video inputs. Only a window's top-level document context for a valid origin can even request permission to use <code>getUserMedia()</code>, unless the top-level context expressly grants permission for a given <a href="/en-US/docs/Web/HTML/Element/iframe"><code><iframe></code></a> to do so using <a href="/en-US/docs/Web/HTTP/Permissions_Policy">Permissions Policy</a>. Otherwise, the user will never even be asked for permission to use the input devices. </p> <p> For additional details on these requirements and rules, how they are reflected in the context in which your code is running, and about how browsers manage user privacy and security issues, read on. </p></div></section><section aria-labelledby="user_privacy"><h3 id="user_privacy"><a href="#user_privacy">User privacy</a></h3><div class="section-content"><p> As an API that may involve significant privacy concerns, <code>getUserMedia()</code> is held by the specification to very specific requirements for user notification and permission management. First, <code>getUserMedia()</code> must always get user permission before opening any media gathering input such as a webcam or microphone. Browsers may offer a once-per-domain permission feature, but they must ask at least the first time, and the user must specifically grant ongoing permission if they choose to do so. </p> <p> Of equal importance are the rules around notification. Browsers are required to display an indicator that shows that a camera or microphone is in use, above and beyond any hardware indicator that may exist. They must also show an indicator that permission has been granted to use a device for input, even if the device is not actively recording at the moment. </p> <p> For example in Firefox, the URL bar displays a pulsing red icon to indicate that recording is underway. The icon is gray if the permission is in place but recording is not currently underway. The device's physical light is used to indicate whether or not recording is currently active. If you've muted your camera (so-called "facemuting"), your camera's activity light goes out to indicate that the camera is not actively recording you, without discarding the permission to resume using the camera once muting is over. </p></div></section><section aria-labelledby="security"><h3 id="security"><a href="#security">Security</a></h3><div class="section-content"><p>There are a number of ways security management and controls in a <a href="/en-US/docs/Glossary/User_agent">user agent</a> can cause <code>getUserMedia()</code> to return a security-related error.</p> <h4 id="permissions_policy">Permissions Policy</h4> <p> The two <a href="/en-US/docs/Web/HTTP/Permissions_Policy">Permissions Policy</a> directives that apply to <code>getUserMedia()</code> are <code>camera</code> and <code>microphone</code>. </p> <p> For example, this HTTP header will enable use of a camera by the document and any embedded <a href="/en-US/docs/Web/HTML/Element/iframe"><code><iframe></code></a> elements that are loaded from the same origin: </p> <div class="code-example"><div class="example-header"><span class="language-name">http</span></div><pre class="brush: http notranslate"><code>Permissions-Policy: camera=(self) </code></pre></div> <p> This will request access to the microphone for the current origin and the specific origin <code>https://developer.mozilla.org</code>: </p> <div class="code-example"><div class="example-header"><span class="language-name">http</span></div><pre class="brush: http notranslate"><code>Permissions-Policy: microphone=(self "https://developer.mozilla.org") </code></pre></div> <p> If you're using <code>getUserMedia()</code> within an <code><iframe></code>, you can request permission just for that frame, which is clearly more secure than requesting a more general permission. Here, indicate we need the ability to use both camera and microphone: </p> <div class="code-example"><div class="example-header"><span class="language-name">html</span></div><pre class="brush: html notranslate"><code><iframe src="https://mycode.example.net/etc" allow="camera; microphone"> </iframe> </code></pre></div> <h4 id="encryption_based_security">Encryption based security</h4> <p> The <code>getUserMedia()</code> method is only available in <a href="/en-US/docs/Web/Security/Secure_Contexts">secure contexts</a>. A secure context is one the browser is reasonably confident contains a document which was loaded securely, using HTTPS/TLS, and has limited exposure to insecure contexts. If a document isn't loaded in a secure context, the <a href="/en-US/docs/Web/API/Navigator/mediaDevices"><code>navigator.mediaDevices</code></a> property is <code>undefined</code>, making access to <code>getUserMedia()</code> impossible. </p> <p> Attempting to access <code>getUserMedia()</code> in this situation will result in a <a href="/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypeError"><code>TypeError</code></a>. </p> <h4 id="document_source_security">Document source security</h4> <p> Because of the obvious security concern associated with <code>getUserMedia()</code> if used unexpectedly or without security being carefully managed, it can only be used in secure contexts. There are a number of insecure ways to load a document that might, in turn, attempt to call <code>getUserMedia()</code>. The following are examples of situations in which <code>getUserMedia()</code> is not permitted to be called: </p> <ul> <li> A document loaded into a sandboxed <a href="/en-US/docs/Web/HTML/Element/iframe"><code><iframe></code></a> element cannot call <code>getUserMedia()</code> unless the <code><iframe></code> has its <a href="/en-US/docs/Web/HTML/Element/iframe#sandbox"><code>sandbox</code></a> attribute set to <code>allow-same-origin</code>. </li> <li> A document loaded using a <code>data://</code> or <code>blob://</code> URL which has no origin (such as when one of these URLs is typed by the user into the address bar) cannot call <code>getUserMedia()</code>. These kinds of URLs loaded from JavaScript code inherit the script's permissions. </li> <li> Any other situation in which there is no origin, such as when the <a href="/en-US/docs/Web/HTML/Element/iframe#srcdoc"><code>srcdoc</code></a> attribute is used to specify the contents of a frame. </li> </ul></div></section><section aria-labelledby="examples"><h2 id="examples"><a href="#examples">Examples</a></h2><div class="section-content"></div></section><section aria-labelledby="using_getusermedia"><h3 id="using_getusermedia"><a href="#using_getusermedia">Using getUserMedia()</a></h3><div class="section-content"><p>Generally, you will access the <a href="/en-US/docs/Web/API/MediaDevices"><code>MediaDevices</code></a> singleton object using <a href="/en-US/docs/Web/API/Navigator/mediaDevices"><code>navigator.mediaDevices</code></a>, like this:</p> <div class="code-example"><div class="example-header"><span class="language-name">js</span></div><pre class="brush: js notranslate"><code>async function getMedia(constraints) { let stream = null; try { stream = await navigator.mediaDevices.getUserMedia(constraints); /* use the stream */ } catch (err) { /* handle the error */ } } </code></pre></div> <p>Similarly, using the raw promises directly, the code looks like this:</p> <div class="code-example"><div class="example-header"><span class="language-name">js</span></div><pre class="brush: js notranslate"><code>navigator.mediaDevices .getUserMedia(constraints) .then((stream) => { /* use the stream */ }) .catch((err) => { /* handle the error */ }); </code></pre></div> <div class="notecard note"> <p> <strong>Note:</strong> If the current document isn't loaded securely, <code>navigator.mediaDevices</code> will be <code>undefined</code>, and you cannot use <code>getUserMedia()</code>. See <a href="#security">Security</a> for more information on this and other security issues related to using <code>getUserMedia()</code>. </p> </div> <p>Below are some examples of the <code>constraints</code> parameter.</p> <p>The following requests both audio and video without any specific requirements:</p> <div class="code-example"><div class="example-header"><span class="language-name">js</span></div><pre class="brush: js notranslate"><code>getUserMedia({ audio: true, video: true, }); </code></pre></div> <p> While information about a user's cameras and microphones are inaccessible for privacy reasons, an application can request the camera and microphone capabilities it needs and wants, using additional constraints. The following expresses a preference for 1280x720 camera resolution: </p> <div class="code-example"><div class="example-header"><span class="language-name">js</span></div><pre class="brush: js notranslate"><code>getUserMedia({ audio: true, video: { width: 1280, height: 720 }, }); </code></pre></div> <p> The browser will try to honor this, but may return other resolutions if an exact match is not available, or the user overrides it. </p> <p> To <em>require</em> a capability, use the keywords <code>min</code>, <code>max</code>, or <code>exact</code> (a.k.a. <code>min === max</code>). The following demands a minimum resolution of 1280x720: </p> <div class="code-example"><div class="example-header"><span class="language-name">js</span></div><pre class="brush: js notranslate"><code>getUserMedia({ audio: true, video: { width: { min: 1280 }, height: { min: 720 }, }, }); </code></pre></div> <p> If no camera exists with this resolution or higher, then the returned promise will be rejected with <code>OverconstrainedError</code>, and the user will not be prompted. </p> <p> The reason for the difference in behavior is that the keywords <code>min</code>, <code>max</code>, and <code>exact</code> are inherently mandatory — whereas plain values and a keyword called <code>ideal</code> are not. Here's a full example: </p> <div class="code-example"><div class="example-header"><span class="language-name">js</span></div><pre class="brush: js notranslate"><code>getUserMedia({ audio: true, video: { width: { min: 1024, ideal: 1280, max: 1920 }, height: { min: 576, ideal: 720, max: 1080 }, }, }); </code></pre></div> <p> An <code>ideal</code> value, when used, has gravity — which means that the browser will try to find the setting (and camera, if you have more than one), with the smallest <a href="https://w3c.github.io/mediacapture-main/#dfn-fitness-distance" class="external" target="_blank">fitness distance</a> from the ideal values given. </p> <p> Plain values are inherently ideal, which means that the first of our resolution examples above could have been written like this: </p> <div class="code-example"><div class="example-header"><span class="language-name">js</span></div><pre class="brush: js notranslate"><code>getUserMedia({ audio: true, video: { width: { ideal: 1280 }, height: { ideal: 720 }, }, }); </code></pre></div> <p> Not all constraints are numbers. For example, on mobile devices, the following will prefer the front camera (if one is available) over the rear one: </p> <div class="code-example"><div class="example-header"><span class="language-name">js</span></div><pre class="brush: js notranslate"><code>getUserMedia({ audio: true, video: { facingMode: "user" }, }); </code></pre></div> <p>To <em>require</em> the rear camera, use:</p> <div class="code-example"><div class="example-header"><span class="language-name">js</span></div><pre class="brush: js notranslate"><code>getUserMedia({ audio: true, video: { facingMode: { exact: "environment" }, }, }); </code></pre></div> <p> Another non-number constraint is the <code>deviceId</code> constraint. If you have a <code>deviceId</code> from <a href="/en-US/docs/Web/API/MediaDevices/enumerateDevices"><code>mediaDevices.enumerateDevices()</code></a>, you can use it to request a specific device: </p> <div class="code-example"><div class="example-header"><span class="language-name">js</span></div><pre class="brush: js notranslate"><code>getUserMedia({ video: { deviceId: myPreferredCameraDeviceId, }, }); </code></pre></div> <p> The above will return the camera you requested, or a different camera if that specific camera is no longer available. Again, to <em>require</em> the specific camera, you would use: </p> <div class="code-example"><div class="example-header"><span class="language-name">js</span></div><pre class="brush: js notranslate"><code>getUserMedia({ video: { deviceId: { exact: myExactCameraOrBustDeviceId, }, }, }); </code></pre></div></div></section><section aria-labelledby="width_and_height"><h3 id="width_and_height"><a href="#width_and_height">Width and height</a></h3><div class="section-content"><p> This example gives a preference for camera resolution, and assigns the resulting <a href="/en-US/docs/Web/API/MediaStream"><code>MediaStream</code></a> object to a video element. </p> <div class="code-example"><div class="example-header"><span class="language-name">js</span></div><pre class="brush: js notranslate"><code>// Prefer camera resolution nearest to 1280x720. const constraints = { audio: true, video: { width: 1280, height: 720 }, }; navigator.mediaDevices .getUserMedia(constraints) .then((mediaStream) => { const video = document.querySelector("video"); video.srcObject = mediaStream; video.onloadedmetadata = () => { video.play(); }; }) .catch((err) => { // always check for errors at the end. console.error(`${err.name}: ${err.message}`); }); </code></pre></div></div></section><section aria-labelledby="frame_rate"><h3 id="frame_rate"><a href="#frame_rate">Frame rate</a></h3><div class="section-content"><p> Lower frame-rates may be desirable in some cases, like WebRTC transmissions with bandwidth restrictions. </p> <div class="code-example"><div class="example-header"><span class="language-name">js</span></div><pre class="brush: js notranslate"><code>const constraints = { video: { frameRate: { ideal: 10, max: 15 } }, }; </code></pre></div></div></section><section aria-labelledby="front_and_back_camera"><h3 id="front_and_back_camera"><a href="#front_and_back_camera">Front and back camera</a></h3><div class="section-content"><p>On mobile phones.</p> <div class="code-example"><div class="example-header"><span class="language-name">js</span></div><pre class="brush: js notranslate"><code>let front = false; document.getElementById("flip-button").onclick = () => { front = !front; }; const constraints = { video: { facingMode: front ? "user" : "environment" }, }; </code></pre></div> <div class="notecard note"> <p><strong>Note:</strong> In certain cases, it may be necessary to release the current camera facing mode before you can switch to a different one. To ensure the camera switch, it is advisable to free up the media resources by invoking the "stop()" method on the track before requesting a different facing mode.</p> </div></div></section><h2 id="specifications"><a href="#specifications">Specifications</a></h2><table class="standard-table"><thead><tr><th scope="col">Specification</th></tr></thead><tbody><tr><td><a href="https://w3c.github.io/mediacapture-main/#dom-mediadevices-getusermedia">Media Capture and Streams <br/><small># dom-mediadevices-getusermedia</small></a></td></tr></tbody></table><h2 id="browser_compatibility"><a href="#browser_compatibility">Browser compatibility</a></h2><p>BCD tables only load in the browser<noscript> with JavaScript enabled. Enable JavaScript to view data.</noscript></p><section aria-labelledby="see_also"><h2 id="see_also"><a href="#see_also">See also</a></h2><div class="section-content"><ul> <li>The older <a href="/en-US/docs/Web/API/Navigator/getUserMedia"><code>Navigator.getUserMedia()</code></a> legacy API</li> <li><a href="/en-US/docs/Web/API/MediaDevices/enumerateDevices"><code>MediaDevices.enumerateDevices()</code></a>: Listing available media devices</li> <li><a href="/en-US/docs/Web/API/WebRTC_API">WebRTC API</a></li> <li><a href="/en-US/docs/Web/API/Media_Capture_and_Streams_API">Media Capture and Streams API</a></li> <li><a href="/en-US/docs/Web/API/Screen_Capture_API">Screen Capture API</a>: Capturing screen contents as a <a href="/en-US/docs/Web/API/MediaStream"><code>MediaStream</code></a></li> <li><a href="/en-US/docs/Web/API/MediaDevices/getDisplayMedia"><code>MediaDevices.getDisplayMedia()</code></a>: Getting a stream containing screen contents</li> <li><a href="/en-US/docs/Web/API/Media_Capture_and_Streams_API/Taking_still_photos" title="Taking webcam photos">Taking webcam photos</a>: A tutorial on using <code>getUserMedia()</code> to take still photos rather than video</li> </ul></div></section></article><aside class="article-footer"><div class="article-footer-inner"><div class="svg-container"><svg xmlns="http://www.w3.org/2000/svg" width="162" height="162" viewBox="0 0 162 162" fill="none" role="none"><mask id="b" fill="#fff"><path d="M97.203 47.04c8.113-7.886 18.004-13.871 28.906-17.492a78 78 0 0 1 33.969-3.39c11.443 1.39 22.401 5.295 32.024 11.411s17.656 14.28 23.476 23.86c5.819 9.579 9.269 20.318 10.083 31.385a69.85 69.85 0 0 1-5.387 32.44c-4.358 10.272-11.115 19.443-19.747 26.801-8.632 7.359-18.908 12.709-30.034 15.637l-6.17-21.698c7.666-2.017 14.746-5.703 20.694-10.773 5.948-5.071 10.603-11.389 13.606-18.467a48.14 48.14 0 0 0 3.712-22.352c-.561-7.625-2.938-15.025-6.948-21.625s-9.544-12.226-16.175-16.44-14.181-6.904-22.065-7.863a53.75 53.75 0 0 0-23.405 2.336c-7.513 2.495-14.327 6.62-19.918 12.053z"></path></mask><path stroke="url(#a)" stroke-dasharray="6, 6" stroke-width="2" d="M97.203 47.04c8.113-7.886 18.004-13.871 28.906-17.492a78 78 0 0 1 33.969-3.39c11.443 1.39 22.401 5.295 32.024 11.411s17.656 14.28 23.476 23.86c5.819 9.579 9.269 20.318 10.083 31.385a69.85 69.85 0 0 1-5.387 32.44c-4.358 10.272-11.115 19.443-19.747 26.801-8.632 7.359-18.908 12.709-30.034 15.637l-6.17-21.698c7.666-2.017 14.746-5.703 20.694-10.773 5.948-5.071 10.603-11.389 13.606-18.467a48.14 48.14 0 0 0 3.712-22.352c-.561-7.625-2.938-15.025-6.948-21.625s-9.544-12.226-16.175-16.44-14.181-6.904-22.065-7.863a53.75 53.75 0 0 0-23.405 2.336c-7.513 2.495-14.327 6.62-19.918 12.053z" mask="url(#b)" style="stroke:url(#a)" transform="translate(-63.992 -25.587)"></path><ellipse cx="8.066" cy="111.597" fill="var(--background-tertiary)" rx="53.677" ry="53.699" transform="matrix(.71707 -.697 .7243 .6895 0 0)"></ellipse><g clip-path="url(#c)" transform="translate(-63.992 -25.587)"><path fill="#9abff5" d="m144.256 137.379 32.906 12.434a4.41 4.41 0 0 1 2.559 5.667l-9.326 24.679a4.41 4.41 0 0 1-5.667 2.559l-8.226-3.108-2.332 6.17c-.466 1.233-.375 1.883-1.609 1.417l-2.253-.527c-.411-.155-.95-.594-1.206-1.161l-4.734-10.484-12.545-4.741a4.41 4.41 0 0 1-2.559-5.667l9.325-24.679a4.41 4.41 0 0 1 5.667-2.559m9.961 29.617 8.227 3.108 3.264-8.638-.498-6.768-4.113-1.555.548 7.258-4.319-1.632zm-12.339-4.663 8.226 3.108 3.264-8.637-.498-6.769-4.113-1.554.548 7.257-4.319-1.632z"></path></g><g clip-path="url(#d)" transform="translate(-63.992 -25.587)"><path fill="#81b0f3" d="M135.35 60.136 86.67 41.654c-3.346-1.27-7.124.428-8.394 3.775L64.414 81.938c-1.27 3.347.428 7.125 3.774 8.395l12.17 4.62-3.465 9.128c-.693 1.826-1.432 2.457.394 3.15l3.014 1.625c.609.231 1.637.274 2.477-.104l15.53-6.983 18.56 7.047c3.346 1.27 7.124-.428 8.395-3.775l13.862-36.51c1.27-3.346-.428-7.124-3.775-8.395M95.261 83.207l-12.17-4.62 4.852-12.779 7.19-7.017 6.085 2.31-7.725 7.51 6.389 2.426zm18.255 6.93-12.17-4.62 4.852-12.778 7.189-7.017 6.085 2.31-7.725 7.51 6.39 2.426z"></path></g><defs><clipPath id="c"><path fill="#fff" d="m198.638 146.586-65.056-24.583-24.583 65.057 65.056 24.582z"></path></clipPath><clipPath id="d"><path fill="#fff" d="m66.438 14.055 96.242 36.54-36.54 96.243-96.243-36.54z"></path></clipPath><linearGradient id="a" x1="97.203" x2="199.995" y1="47.04" y2="152.793" gradientUnits="userSpaceOnUse"><stop stop-color="#086DFC"></stop><stop offset="0.246" stop-color="#2C81FA"></stop><stop offset="0.516" stop-color="#5497F8"></stop><stop offset="0.821" stop-color="#80B0F6"></stop><stop offset="1" stop-color="#9ABFF5"></stop></linearGradient></defs></svg></div><h2>Help improve MDN</h2><fieldset class="feedback"><label>Was this page helpful to you?</label><div class="button-container"><button type="button" class="button primary has-icon yes"><span class="button-wrap"><span class="icon icon-thumbs-up "></span>Yes</span></button><button type="button" class="button primary has-icon no"><span class="button-wrap"><span class="icon icon-thumbs-down "></span>No</span></button></div></fieldset><a class="contribute" href="https://github.com/mdn/content/blob/main/CONTRIBUTING.md" title="This will take you to our contribution guidelines on GitHub." target="_blank" rel="noopener noreferrer">Learn how to contribute</a>.<p class="last-modified-date">This page was last modified on <time dateTime="2024-07-26T03:44:38.000Z">Jul 26, 2024</time> by <a href="/en-US/docs/Web/API/MediaDevices/getUserMedia/contributors.txt" rel="nofollow">MDN contributors</a>.</p><div id="on-github" class="on-github"><a href="https://github.com/mdn/content/blob/main/files/en-us/web/api/mediadevices/getusermedia/index.md?plain=1" title="Folder: en-us/web/api/mediadevices/getusermedia (Opens in a new tab)" target="_blank" rel="noopener noreferrer">View this page on GitHub</a> • <a href="https://github.com/mdn/content/issues/new?template=page-report.yml&mdn-url=https%3A%2F%2Fdeveloper.mozilla.org%2Fen-US%2Fdocs%2FWeb%2FAPI%2FMediaDevices%2FgetUserMedia&metadata=%3C%21--+Do+not+make+changes+below+this+line+--%3E%0A%3Cdetails%3E%0A%3Csummary%3EPage+report+details%3C%2Fsummary%3E%0A%0A*+Folder%3A+%60en-us%2Fweb%2Fapi%2Fmediadevices%2Fgetusermedia%60%0A*+MDN+URL%3A+https%3A%2F%2Fdeveloper.mozilla.org%2Fen-US%2Fdocs%2FWeb%2FAPI%2FMediaDevices%2FgetUserMedia%0A*+GitHub+URL%3A+https%3A%2F%2Fgithub.com%2Fmdn%2Fcontent%2Fblob%2Fmain%2Ffiles%2Fen-us%2Fweb%2Fapi%2Fmediadevices%2Fgetusermedia%2Findex.md%0A*+Last+commit%3A+https%3A%2F%2Fgithub.com%2Fmdn%2Fcontent%2Fcommit%2Fcfb7587e3e3122630ad6cbd94d834ecadbe0a746%0A*+Document+last+modified%3A+2024-07-26T03%3A44%3A38.000Z%0A%0A%3C%2Fdetails%3E" title="This will take you to GitHub to file a new issue." target="_blank" rel="noopener noreferrer">Report a problem with this content</a></div></div></aside></main></div></div><footer id="nav-footer" class="page-footer"><div class="page-footer-grid"><div class="page-footer-logo-col"><a href="/" class="mdn-footer-logo" aria-label="MDN homepage"><svg width="48" height="17" viewBox="0 0 48 17" fill="none" xmlns="http://www.w3.org/2000/svg"><title id="mdn-footer-logo-svg">MDN logo</title><path d="M20.04 16.512H15.504V10.416C15.504 9.488 15.344 8.824 15.024 8.424C14.72 8.024 14.264 7.824 13.656 7.824C12.92 7.824 12.384 8.064 12.048 8.544C11.728 9.024 11.568 9.64 11.568 10.392V14.184H13.008V16.512H8.472V10.416C8.472 9.488 8.312 8.824 7.992 8.424C7.688 8.024 7.232 7.824 6.624 7.824C5.872 7.824 5.336 8.064 5.016 8.544C4.696 9.024 4.536 9.64 4.536 10.392V14.184H6.6V16.512H0V14.184H1.44V8.04H0.024V5.688H4.536V7.32C5.224 6.088 6.32 5.472 7.824 5.472C8.608 5.472 9.328 5.664 9.984 6.048C10.64 6.432 11.096 7.016 11.352 7.8C11.992 6.248 13.168 5.472 14.88 5.472C15.856 5.472 16.72 5.776 17.472 6.384C18.224 6.992 18.6 7.936 18.6 9.216V14.184H20.04V16.512Z" fill="currentColor"></path><path d="M33.6714 16.512H29.1354V14.496C28.8314 15.12 28.3834 15.656 27.7914 16.104C27.1994 16.536 26.4154 16.752 25.4394 16.752C24.0154 16.752 22.8954 16.264 22.0794 15.288C21.2634 14.312 20.8554 12.984 20.8554 11.304C20.8554 9.688 21.2554 8.312 22.0554 7.176C22.8554 6.04 24.0634 5.472 25.6794 5.472C26.5594 5.472 27.2794 5.648 27.8394 6C28.3994 6.352 28.8314 6.8 29.1354 7.344V2.352H26.9754V0H32.2314V14.184H33.6714V16.512ZM29.1354 11.04V10.776C29.1354 9.88 28.8954 9.184 28.4154 8.688C27.9514 8.176 27.3674 7.92 26.6634 7.92C25.9754 7.92 25.3674 8.176 24.8394 8.688C24.3274 9.2 24.0714 10.008 24.0714 11.112C24.0714 12.152 24.3114 12.944 24.7914 13.488C25.2714 14.032 25.8394 14.304 26.4954 14.304C27.3114 14.304 27.9514 13.96 28.4154 13.272C28.8954 12.584 29.1354 11.84 29.1354 11.04Z" fill="currentColor"></path><path d="M47.9589 16.512H41.9829V14.184H43.4229V10.416C43.4229 9.488 43.2629 8.824 42.9429 8.424C42.6389 8.024 42.1829 7.824 41.5749 7.824C40.8389 7.824 40.2709 8.056 39.8709 8.52C39.4709 8.968 39.2629 9.56 39.2469 10.296V14.184H40.6869V16.512H34.7109V14.184H36.1509V8.04H34.5909V5.688H39.2469V7.344C39.9669 6.096 41.1269 5.472 42.7269 5.472C43.7509 5.472 44.6389 5.776 45.3909 6.384C46.1429 6.992 46.5189 7.936 46.5189 9.216V14.184H47.9589V16.512Z" fill="currentColor"></path></svg></a><p>Your blueprint for a better internet.</p><ul class="social-icons"><li><a href="https://mozilla.social/@mdn" target="_blank" rel="me noopener noreferrer"><span class="icon icon-mastodon"></span><span class="visually-hidden">MDN on Mastodon</span></a></li><li><a href="https://twitter.com/mozdevnet" target="_blank" rel="noopener noreferrer"><span class="icon icon-twitter-x"></span><span class="visually-hidden">MDN on X (formerly Twitter)</span></a></li><li><a href="https://github.com/mdn/" target="_blank" rel="noopener noreferrer"><span class="icon icon-github-mark-small"></span><span class="visually-hidden">MDN on GitHub</span></a></li><li><a href="/en-US/blog/rss.xml" target="_blank"><span class="icon icon-feed"></span><span class="visually-hidden">MDN Blog RSS Feed</span></a></li></ul></div><div class="page-footer-nav-col-1"><h2 class="footer-nav-heading">MDN</h2><ul class="footer-nav-list"><li class="footer-nav-item"><a href="/en-US/about">About</a></li><li class="footer-nav-item"><a href="/en-US/blog/">Blog</a></li><li class="footer-nav-item"><a href="https://www.mozilla.org/en-US/careers/listings/?team=ProdOps" target="_blank" rel="noopener noreferrer">Careers</a></li><li class="footer-nav-item"><a href="/en-US/advertising">Advertise with us</a></li></ul></div><div class="page-footer-nav-col-2"><h2 class="footer-nav-heading">Support</h2><ul class="footer-nav-list"><li class="footer-nav-item"><a class="footer-nav-link" href="https://support.mozilla.org/products/mdn-plus">Product help</a></li><li class="footer-nav-item"><a class="footer-nav-link" href="/en-US/docs/MDN/Community/Issues">Report an issue</a></li></ul></div><div class="page-footer-nav-col-3"><h2 class="footer-nav-heading">Our communities</h2><ul class="footer-nav-list"><li class="footer-nav-item"><a class="footer-nav-link" href="/en-US/community">MDN Community</a></li><li class="footer-nav-item"><a class="footer-nav-link" href="https://discourse.mozilla.org/c/mdn/236" target="_blank" rel="noopener noreferrer">MDN Forum</a></li><li class="footer-nav-item"><a class="footer-nav-link" href="/discord" target="_blank" rel="noopener noreferrer">MDN Chat</a></li></ul></div><div class="page-footer-nav-col-4"><h2 class="footer-nav-heading">Developers</h2><ul class="footer-nav-list"><li class="footer-nav-item"><a class="footer-nav-link" href="/en-US/docs/Web">Web Technologies</a></li><li class="footer-nav-item"><a class="footer-nav-link" href="/en-US/docs/Learn">Learn Web Development</a></li><li class="footer-nav-item"><a class="footer-nav-link" href="/en-US/plus">MDN Plus</a></li><li class="footer-nav-item"><a href="https://hacks.mozilla.org/" target="_blank" rel="noopener noreferrer">Hacks Blog</a></li></ul></div><div class="page-footer-moz"><a href="https://www.mozilla.org/" class="footer-moz-logo-link" target="_blank" rel="noopener noreferrer"><svg width="112" height="32" fill="none" xmlns="http://www.w3.org/2000/svg"><title id="mozilla-footer-logo-svg">Mozilla logo</title><path d="M41.753 14.218c-2.048 0-3.324 1.522-3.324 4.157 0 2.423 1.119 4.286 3.29 4.286 2.082 0 3.447-1.678 3.447-4.347 0-2.826-1.522-4.096-3.413-4.096Zm54.89 7.044c0 .901.437 1.618 1.645 1.618 1.427 0 2.949-1.024 3.044-3.352-.649-.095-1.365-.185-2.02-.185-1.426-.005-2.668.397-2.668 1.92Z" fill="currentColor"></path><path d="M0 0v32h111.908V0H0Zm32.56 25.426h-5.87v-7.884c0-2.423-.806-3.352-2.39-3.352-1.924 0-2.702 1.365-2.702 3.324v4.868h1.864v3.044h-5.864v-7.884c0-2.423-.806-3.352-2.39-3.352-1.924 0-2.702 1.365-2.702 3.324v4.868h2.669v3.044H6.642v-3.044h1.863v-7.918H6.642V11.42h5.864v2.11c.839-1.489 2.3-2.39 4.252-2.39 2.02 0 3.878.963 4.566 3.01.778-1.862 2.361-3.01 4.566-3.01 2.512 0 4.812 1.522 4.812 4.84v6.402h1.863v3.044h-.005Zm9.036.307c-4.314 0-7.296-2.635-7.296-7.106 0-4.096 2.484-7.481 7.514-7.481s7.481 3.38 7.481 7.29c0 4.472-3.228 7.297-7.699 7.297Zm22.578-.307H51.942l-.403-2.11 7.7-8.846h-4.376l-.621 2.17-2.888-.313.498-4.907h12.294l.313 2.11-7.767 8.852h4.533l.654-2.172 3.167.308-.872 4.908Zm7.99 0h-4.191v-5.03h4.19v5.03Zm0-8.976h-4.191v-5.03h4.19v5.03Zm2.618 8.976 6.054-21.358h3.945l-6.054 21.358h-3.945Zm8.136 0 6.048-21.358h3.945l-6.054 21.358h-3.939Zm21.486.307c-1.863 0-2.887-1.085-3.072-2.792-.805 1.427-2.232 2.792-4.498 2.792-2.02 0-4.314-1.085-4.314-4.006 0-3.447 3.323-4.253 6.518-4.253.778 0 1.584.034 2.3.124v-.465c0-1.427-.034-3.133-2.3-3.133-.84 0-1.488.061-2.143.402l-.453 1.578-3.195-.34.549-3.224c2.45-.996 3.692-1.27 5.992-1.27 3.01 0 5.556 1.55 5.556 4.75v6.083c0 .805.314 1.085.963 1.085.184 0 .375-.034.587-.095l.034 2.11a5.432 5.432 0 0 1-2.524.654Z" fill="currentColor"></path></svg></a><ul class="footer-moz-list"><li class="footer-moz-item"><a href="https://www.mozilla.org/privacy/websites/" class="footer-moz-link" target="_blank" rel="noopener noreferrer">Website Privacy Notice</a></li><li class="footer-moz-item"><a href="https://www.mozilla.org/privacy/websites/#cookies" class="footer-moz-link" target="_blank" rel="noopener noreferrer">Cookies</a></li><li class="footer-moz-item"><a href="https://www.mozilla.org/about/legal/terms/mozilla" class="footer-moz-link" target="_blank" rel="noopener noreferrer">Legal</a></li><li class="footer-moz-item"><a href="https://www.mozilla.org/about/governance/policies/participation/" class="footer-moz-link" target="_blank" rel="noopener noreferrer">Community Participation Guidelines</a></li></ul></div><div class="page-footer-legal"><p id="license" class="page-footer-legal-text">Visit <a href="https://www.mozilla.org" target="_blank" rel="noopener noreferrer">Mozilla Corporation’s</a> not-for-profit parent, the <a target="_blank" rel="noopener noreferrer" href="https://foundation.mozilla.org/">Mozilla Foundation</a>.<br/>Portions of this content are ©1998–2024 by individual mozilla.org contributors. Content available under <a href="/en-US/docs/MDN/Writing_guidelines/Attrib_copyright_license">a Creative Commons license</a>.</p></div></div></footer></div><script type="application/json" id="hydration">{"url":"/en-US/docs/Web/API/MediaDevices/getUserMedia","doc":{"isMarkdown":true,"isTranslated":false,"isActive":true,"flaws":{},"title":"MediaDevices: getUserMedia() method","mdn_url":"/en-US/docs/Web/API/MediaDevices/getUserMedia","locale":"en-US","native":"English (US)","browserCompat":["api.MediaDevices.getUserMedia"],"baseline":{"baseline":"high","baseline_high_date":"2020-03-19","baseline_low_date":"2017-09-19","support":{"chrome":"53","chrome_android":"53","edge":"12","firefox":"36","firefox_android":"36","safari":"11","safari_ios":"11"}},"sidebarHTML":"<ol><li class=\"section\"><a href=\"/en-US/docs/Web/API/Media_Capture_and_Streams_API\">Media Capture and Streams API</a></li><li class=\"section\"><a href=\"/en-US/docs/Web/API/MediaDevices\"><code>MediaDevices</code></a></li><li class=\"toggle\"><details open=\"\"><summary>Instance methods</summary><ol><li><a href=\"/en-US/docs/Web/API/MediaDevices/enumerateDevices\"><code>enumerateDevices()</code></a></li><li><a href=\"/en-US/docs/Web/API/MediaDevices/getDisplayMedia\"><code>getDisplayMedia()</code></a></li><li><a href=\"/en-US/docs/Web/API/MediaDevices/getSupportedConstraints\"><code>getSupportedConstraints()</code></a></li><li><em><code>getUserMedia()</code> </em></li><li><a href=\"/en-US/docs/Web/API/MediaDevices/selectAudioOutput\"><code>selectAudioOutput()</code></a><abbr class=\"icon icon-experimental\" title=\"Experimental. Expect behavior to change in the future.\">\n <span class=\"visually-hidden\">Experimental</span>\n</abbr></li></ol></details></li><li class=\"toggle\"><details open=\"\"><summary>Events</summary><ol><li><a href=\"/en-US/docs/Web/API/MediaDevices/devicechange_event\"><code>devicechange</code></a></li></ol></details></li><li class=\"toggle\"><details open=\"\"><summary>Inheritance</summary><ol><li><a href=\"/en-US/docs/Web/API/EventTarget\"><code>EventTarget</code></a></li></ol></details></li><li class=\"toggle\"><details open=\"\"><summary>Related pages for Media Capture and Streams</summary><ol><li><a href=\"/en-US/docs/Web/API/CanvasCaptureMediaStreamTrack\"><code>CanvasCaptureMediaStreamTrack</code></a></li><li><a href=\"/en-US/docs/Web/API/HTMLCanvasElement/captureStream\"><code>HTMLCanvasElement.captureStream()</code></a></li><li><a href=\"/en-US/docs/Web/API/HTMLMediaElement/captureStream\"><code>HTMLMediaElement.captureStream()</code></a></li><li><a href=\"/en-US/docs/Web/API/InputDeviceInfo\"><code>InputDeviceInfo</code></a></li><li><a href=\"/en-US/docs/Web/API/MediaDeviceInfo\"><code>MediaDeviceInfo</code></a></li><li><a href=\"/en-US/docs/Web/API/MediaStream\"><code>MediaStream</code></a></li><li><a href=\"/en-US/docs/Web/API/MediaStreamTrack\"><code>MediaStreamTrack</code></a></li><li><a href=\"/en-US/docs/Web/API/MediaStreamTrackEvent\"><code>MediaStreamTrackEvent</code></a></li><li><a href=\"/en-US/docs/Web/API/MediaTrackConstraints\"><code>MediaTrackConstraints</code></a></li><li><a href=\"/en-US/docs/Web/API/MediaTrackSettings\"><code>MediaTrackSettings</code></a></li><li><a href=\"/en-US/docs/Web/API/MediaTrackSupportedConstraints\"><code>MediaTrackSupportedConstraints</code></a></li><li><a href=\"/en-US/docs/Web/API/Navigator/mediaDevices\"><code>Navigator.mediaDevices</code></a></li><li><a href=\"/en-US/docs/Web/API/OverconstrainedError\"><code>OverconstrainedError</code></a></li></ol></details></li></ol>","sidebarMacro":"APIRef","body":[{"type":"prose","value":{"id":null,"title":null,"isH3":false,"content":"<div class=\"notecard secure\"><p><strong>Secure context:</strong> This feature is available only in <a href=\"/en-US/docs/Web/Security/Secure_Contexts\">secure contexts</a> (HTTPS), in some or all <a href=\"#browser_compatibility\">supporting browsers</a>.</p></div>\n<p>The <strong><code>getUserMedia()</code></strong> method of the <a href=\"/en-US/docs/Web/API/MediaDevices\"><code>MediaDevices</code></a> interface prompts the user for permission to use a media input which produces a <a href=\"/en-US/docs/Web/API/MediaStream\"><code>MediaStream</code></a> with tracks containing the requested types of media.</p>\n<p>That stream can include, for example, a video track (produced by either a hardware or virtual video source such as a camera, video recording device, screen sharing service, and so forth), an audio track (similarly, produced by a physical or virtual audio source like a microphone, A/D converter, or the like), and possibly other track types.</p>\n<p>\n It returns a <a href=\"/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\"><code>Promise</code></a> that resolves to a <a href=\"/en-US/docs/Web/API/MediaStream\"><code>MediaStream</code></a> object.\n If the user denies permission, or matching media is not available, then the promise is rejected with <code>NotAllowedError</code> or <code>NotFoundError</code> <a href=\"/en-US/docs/Web/API/DOMException\"><code>DOMException</code></a> respectively.\n</p>\n<div class=\"notecard note\">\n <p><strong>Note:</strong> It's possible for the returned promise to <em>neither</em> resolve nor reject, as the user is not required to make a choice at all and may ignore the request.</p>\n</div>"}},{"type":"prose","value":{"id":"syntax","title":"Syntax","isH3":false,"content":"<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">js</span></div><pre class=\"brush: js notranslate\"><code>getUserMedia(constraints)\n</code></pre></div>"}},{"type":"prose","value":{"id":"parameters","title":"Parameters","isH3":true,"content":"<dl>\n <dt id=\"constraints\"><a href=\"#constraints\"><code>constraints</code></a></dt>\n <dd>\n <p>\n An object specifying the types of media to\n request, along with any requirements for each type.\n </p>\n <p>\n The <code>constraints</code> parameter is an object with two members: <code>video</code> and\n <code>audio</code>, describing the media types requested. Either or both must be\n specified. If the browser cannot find all media tracks with the specified types that\n meet the constraints given, then the returned promise is rejected with\n <code>NotFoundError</code> <a href=\"/en-US/docs/Web/API/DOMException\"><code>DOMException</code></a>.\n </p>\n <p>For both <code>video</code> and <code>audio</code>, its value is either a boolean or an object. The default value is <code>false</code>.</p>\n <ul>\n <li>If <code>true</code> is specified for a media type, the resulting stream is <em>required</em> to have that type of track in it. If one cannot be included for any reason, the returned promise will reject.</li>\n <li>If <code>false</code> is specified for a media type, the resulting stream <em>must not</em> have that type of track, or the returned promise will reject. Because both <code>video</code> and <code>audio</code> default to <code>false</code>, if the <code>constraints</code> object contains neither property or if it's not present at all, the returned promise will always reject.</li>\n <li>If an object is specified for a media type, the object is read as a <a href=\"/en-US/docs/Web/API/MediaTrackConstraints\"><code>MediaTrackConstraints</code></a> dictionary.</li>\n </ul>\n </dd>\n</dl>"}},{"type":"prose","value":{"id":"return_value","title":"Return value","isH3":true,"content":"<p>\n A <a href=\"/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\"><code>Promise</code></a> whose fulfillment handler receives a <a href=\"/en-US/docs/Web/API/MediaStream\"><code>MediaStream</code></a>\n object when the requested media has successfully been obtained.\n</p>"}},{"type":"prose","value":{"id":"exceptions","title":"Exceptions","isH3":true,"content":"<dl>\n <dt id=\"aborterror\"><a href=\"#aborterror\"><code>AbortError</code></a> <a href=\"/en-US/docs/Web/API/DOMException\"><code>DOMException</code></a></dt>\n <dd>\n <p>\n Although the user and operating system both granted access to the hardware device,\n and no hardware issues occurred that would cause a <code>NotReadableError</code> <a href=\"/en-US/docs/Web/API/DOMException\"><code>DOMException</code></a>, throw if some\n problem occurred which prevented the device from being used.\n </p>\n </dd>\n <dt id=\"invalidstateerror\"><a href=\"#invalidstateerror\"><code>InvalidStateError</code></a> <a href=\"/en-US/docs/Web/API/DOMException\"><code>DOMException</code></a></dt>\n <dd>\n <p>Thrown if current document is not fully active.</p>\n </dd>\n <dt id=\"notallowederror\"><a href=\"#notallowederror\"><code>NotAllowedError</code></a> <a href=\"/en-US/docs/Web/API/DOMException\"><code>DOMException</code></a></dt>\n <dd>\n <p>\n Thrown if one or more of the requested source devices cannot be used at this time. This will\n happen if the browsing context is insecure (that is, the page was loaded using HTTP\n rather than HTTPS). It also happens if the user has specified that the current\n browsing instance is not permitted access to the device, the user has denied access\n for the current session, or the user has denied all access to user media devices\n globally. On browsers that support managing media permissions with <a href=\"/en-US/docs/Web/HTTP/Permissions_Policy\">Permissions Policy</a>, this error is\n returned if Permissions Policy is not configured to allow access to the input source(s).\n </p>\n <div class=\"notecard note\">\n <p>\n <strong>Note:</strong> Older versions of the specification used <code>SecurityError</code>\n for this instead; <code>SecurityError</code> has taken on a new meaning.\n </p>\n </div>\n </dd>\n <dt id=\"notfounderror\"><a href=\"#notfounderror\"><code>NotFoundError</code></a> <a href=\"/en-US/docs/Web/API/DOMException\"><code>DOMException</code></a></dt>\n <dd>\n <p>Thrown if no media tracks of the type specified were found that satisfy the given constraints.</p>\n </dd>\n <dt id=\"notreadableerror\"><a href=\"#notreadableerror\"><code>NotReadableError</code></a> <a href=\"/en-US/docs/Web/API/DOMException\"><code>DOMException</code></a></dt>\n <dd>\n <p>\n Thrown if, although the user granted permission to use the matching devices, a hardware error\n occurred at the operating system, browser, or Web page level which prevented access to\n the device.\n </p>\n </dd>\n <dt id=\"overconstrainederror\"><a href=\"#overconstrainederror\"><code>OverconstrainedError</code></a> <a href=\"/en-US/docs/Web/API/DOMException\"><code>DOMException</code></a></dt>\n <dd>\n <p>\n Thrown if the specified constraints resulted in no candidate devices which met the criteria\n requested. The error is an object of type <code>OverconstrainedError</code>, and has a\n <code>constraint</code> property whose string value is the name of a constraint which\n was impossible to meet, and a <code>message</code> property containing a\n human-readable string explaining the problem.\n </p>\n <div class=\"notecard note\">\n <p>\n <strong>Note:</strong> Because this error can occur even when the user has not yet granted\n permission to use the underlying device, it can potentially be used as a\n <a href=\"/en-US/docs/Glossary/Fingerprinting\">fingerprinting</a> surface.\n </p>\n </div>\n </dd>\n <dt id=\"securityerror\"><a href=\"#securityerror\"><code>SecurityError</code></a> <a href=\"/en-US/docs/Web/API/DOMException\"><code>DOMException</code></a></dt>\n <dd>\n <p>\n Thrown if user media support is disabled on the <a href=\"/en-US/docs/Web/API/Document\"><code>Document</code></a> on which\n <code>getUserMedia()</code> was called. The mechanism by which user media support is\n enabled and disabled is left up to the individual user agent.\n </p>\n </dd>\n <dt id=\"typeerror\"><a href=\"/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypeError\"><code>TypeError</code></a></dt>\n <dd>\n <p>\n Thrown if the list of constraints specified is empty, or has all constraints set to\n <code>false</code>. This can also happen if you try to call\n <code>getUserMedia()</code> in an insecure context, since\n <a href=\"/en-US/docs/Web/API/Navigator/mediaDevices\"><code>navigator.mediaDevices</code></a> is <code>undefined</code> in an insecure\n context.\n </p>\n </dd>\n</dl>"}},{"type":"prose","value":{"id":"privacy_and_security","title":"Privacy and security","isH3":false,"content":"<p>\n As an API that may involve significant privacy concerns, <code>getUserMedia()</code>'s\n specification lays out a wide array of privacy and security requirements that browsers\n are obligated to meet.\n</p>\n<p>\n <code>getUserMedia()</code> is a powerful feature that can only be used in <a href=\"/en-US/docs/Web/Security/Secure_Contexts\">secure contexts</a>; in insecure\n contexts, <code>navigator.mediaDevices</code> is <code>undefined</code>, preventing\n access to <code>getUserMedia()</code>. A secure context is, in short, a page loaded\n using HTTPS or the <code>file:///</code> URL scheme, or a page loaded from\n <code>localhost</code>.\n</p>\n<p>\n In addition, user permission is always required to access the user's audio and video\n inputs. Only a window's top-level document context for a valid origin can even request\n permission to use <code>getUserMedia()</code>, unless the top-level context expressly\n grants permission for a given <a href=\"/en-US/docs/Web/HTML/Element/iframe\"><code><iframe></code></a> to do so using <a href=\"/en-US/docs/Web/HTTP/Permissions_Policy\">Permissions Policy</a>. Otherwise, the user\n will never even be asked for permission to use the input devices.\n</p>\n<p>\n For additional details on these requirements and rules, how they are reflected in the\n context in which your code is running, and about how browsers manage user privacy and\n security issues, read on.\n</p>"}},{"type":"prose","value":{"id":"user_privacy","title":"User privacy","isH3":true,"content":"<p>\n As an API that may involve significant privacy concerns, <code>getUserMedia()</code> is\n held by the specification to very specific requirements for user notification and\n permission management. First, <code>getUserMedia()</code> must always get user\n permission before opening any media gathering input such as a webcam or microphone.\n Browsers may offer a once-per-domain permission feature, but they must ask at least the\n first time, and the user must specifically grant ongoing permission if they choose to do\n so.\n</p>\n<p>\n Of equal importance are the rules around notification. Browsers are required to display\n an indicator that shows that a camera or microphone is in use, above and beyond any\n hardware indicator that may exist. They must also show an indicator that permission has\n been granted to use a device for input, even if the device is not actively recording at\n the moment.\n</p>\n<p>\n For example in Firefox, the URL bar displays a pulsing red icon to indicate that\n recording is underway. The icon is gray if the permission is in place but recording is\n not currently underway. The device's physical light is used to indicate whether or not\n recording is currently active. If you've muted your camera (so-called \"facemuting\"),\n your camera's activity light goes out to indicate that the camera is not actively\n recording you, without discarding the permission to resume using the camera once muting\n is over.\n</p>"}},{"type":"prose","value":{"id":"security","title":"Security","isH3":true,"content":"<p>There are a number of ways security management and controls in a <a href=\"/en-US/docs/Glossary/User_agent\">user agent</a> can cause <code>getUserMedia()</code> to return a security-related error.</p>\n<h4 id=\"permissions_policy\">Permissions Policy</h4>\n<p>\n The two <a href=\"/en-US/docs/Web/HTTP/Permissions_Policy\">Permissions Policy</a> directives that apply to <code>getUserMedia()</code> are <code>camera</code>\n and <code>microphone</code>.\n</p>\n<p>\n For example, this HTTP header will enable use of a camera by the document\n and any embedded <a href=\"/en-US/docs/Web/HTML/Element/iframe\"><code><iframe></code></a> elements that are loaded from the same\n origin:\n</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">http</span></div><pre class=\"brush: http notranslate\"><code>Permissions-Policy: camera=(self)\n</code></pre></div>\n<p>\n This will request access to the microphone for the current origin and the specific\n origin <code>https://developer.mozilla.org</code>:\n</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">http</span></div><pre class=\"brush: http notranslate\"><code>Permissions-Policy: microphone=(self \"https://developer.mozilla.org\")\n</code></pre></div>\n<p>\n If you're using <code>getUserMedia()</code> within an <code><iframe></code>, you\n can request permission just for that frame, which is clearly more secure than requesting\n a more general permission. Here, indicate we need the ability to use both camera and\n microphone:\n</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">html</span></div><pre class=\"brush: html notranslate\"><code><iframe src=\"https://mycode.example.net/etc\" allow=\"camera; microphone\">\n</iframe>\n</code></pre></div>\n<h4 id=\"encryption_based_security\">Encryption based security</h4>\n<p>\n The <code>getUserMedia()</code> method is only available in <a href=\"/en-US/docs/Web/Security/Secure_Contexts\">secure contexts</a>. A secure context\n is one the browser is reasonably confident contains a document which was loaded\n securely, using HTTPS/TLS, and has limited exposure to insecure contexts. If a document\n isn't loaded in a secure context, the <a href=\"/en-US/docs/Web/API/Navigator/mediaDevices\"><code>navigator.mediaDevices</code></a> property is\n <code>undefined</code>, making access to <code>getUserMedia()</code> impossible.\n</p>\n<p>\n Attempting to access <code>getUserMedia()</code> in this situation will result in a\n <a href=\"/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypeError\"><code>TypeError</code></a>.\n</p>\n<h4 id=\"document_source_security\">Document source security</h4>\n<p>\n Because of the obvious security concern associated with <code>getUserMedia()</code> if\n used unexpectedly or without security being carefully managed, it can only be used in\n secure contexts. There are a number of insecure ways to load a document that might, in\n turn, attempt to call <code>getUserMedia()</code>. The following are examples of\n situations in which <code>getUserMedia()</code> is not permitted to be called:\n</p>\n<ul>\n <li>\n A document loaded into a sandboxed <a href=\"/en-US/docs/Web/HTML/Element/iframe\"><code><iframe></code></a> element cannot call\n <code>getUserMedia()</code> unless the <code><iframe></code> has its\n <a href=\"/en-US/docs/Web/HTML/Element/iframe#sandbox\"><code>sandbox</code></a> attribute set to <code>allow-same-origin</code>.\n </li>\n <li>\n A document loaded using a <code>data://</code> or <code>blob://</code> URL which has\n no origin (such as when one of these URLs is typed by the user into the address bar)\n cannot call <code>getUserMedia()</code>. These kinds of URLs loaded from JavaScript\n code inherit the script's permissions.\n </li>\n <li>\n Any other situation in which there is no origin, such as when the\n <a href=\"/en-US/docs/Web/HTML/Element/iframe#srcdoc\"><code>srcdoc</code></a> attribute is used to specify the contents of a\n frame.\n </li>\n</ul>"}},{"type":"prose","value":{"id":"examples","title":"Examples","isH3":false,"content":""}},{"type":"prose","value":{"id":"using_getusermedia","title":"Using getUserMedia()","isH3":true,"content":"<p>Generally, you will access the <a href=\"/en-US/docs/Web/API/MediaDevices\"><code>MediaDevices</code></a> singleton object using <a href=\"/en-US/docs/Web/API/Navigator/mediaDevices\"><code>navigator.mediaDevices</code></a>, like this:</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">js</span></div><pre class=\"brush: js notranslate\"><code>async function getMedia(constraints) {\n let stream = null;\n\n try {\n stream = await navigator.mediaDevices.getUserMedia(constraints);\n /* use the stream */\n } catch (err) {\n /* handle the error */\n }\n}\n</code></pre></div>\n<p>Similarly, using the raw promises directly, the code looks like this:</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">js</span></div><pre class=\"brush: js notranslate\"><code>navigator.mediaDevices\n .getUserMedia(constraints)\n .then((stream) => {\n /* use the stream */\n })\n .catch((err) => {\n /* handle the error */\n });\n</code></pre></div>\n<div class=\"notecard note\">\n <p>\n <strong>Note:</strong> If the current document isn't loaded securely,\n <code>navigator.mediaDevices</code> will be <code>undefined</code>, and you cannot use\n <code>getUserMedia()</code>. See <a href=\"#security\">Security</a> for more information on this and\n other security issues related to using <code>getUserMedia()</code>.\n </p>\n</div>\n<p>Below are some examples of the <code>constraints</code> parameter.</p>\n<p>The following requests both audio and video without any specific requirements:</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">js</span></div><pre class=\"brush: js notranslate\"><code>getUserMedia({\n audio: true,\n video: true,\n});\n</code></pre></div>\n<p>\n While information about a user's cameras and microphones are inaccessible for\n privacy reasons, an application can request the camera and microphone capabilities\n it needs and wants, using additional constraints. The following expresses a\n preference for 1280x720 camera resolution:\n</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">js</span></div><pre class=\"brush: js notranslate\"><code>getUserMedia({\n audio: true,\n video: { width: 1280, height: 720 },\n});\n</code></pre></div>\n<p>\n The browser will try to honor this, but may return other\n resolutions if an exact match is not available, or the user overrides it.\n</p>\n<p>\n To <em>require</em> a capability, use the keywords <code>min</code>,\n <code>max</code>, or <code>exact</code> (a.k.a. <code>min === max</code>). The\n following demands a minimum resolution of 1280x720:\n</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">js</span></div><pre class=\"brush: js notranslate\"><code>getUserMedia({\n audio: true,\n video: {\n width: { min: 1280 },\n height: { min: 720 },\n },\n});\n</code></pre></div>\n<p>\n If no camera exists with this resolution or higher, then the returned promise will\n be rejected with <code>OverconstrainedError</code>, and the user will not be\n prompted.\n</p>\n<p>\n The reason for the difference in behavior is that the keywords <code>min</code>,\n <code>max</code>, and <code>exact</code> are inherently mandatory — whereas plain\n values and a keyword called <code>ideal</code> are not. Here's a full example:\n</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">js</span></div><pre class=\"brush: js notranslate\"><code>getUserMedia({\n audio: true,\n video: {\n width: { min: 1024, ideal: 1280, max: 1920 },\n height: { min: 576, ideal: 720, max: 1080 },\n },\n});\n</code></pre></div>\n<p>\n An <code>ideal</code> value, when used, has gravity — which means that the browser\n will try to find the setting (and camera, if you have more than one), with the\n smallest <a href=\"https://w3c.github.io/mediacapture-main/#dfn-fitness-distance\" class=\"external\" target=\"_blank\">fitness distance</a> from the ideal values given.\n</p>\n<p>\n Plain values are inherently ideal, which means that the first of our resolution\n examples above could have been written like this:\n</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">js</span></div><pre class=\"brush: js notranslate\"><code>getUserMedia({\n audio: true,\n video: {\n width: { ideal: 1280 },\n height: { ideal: 720 },\n },\n});\n</code></pre></div>\n<p>\n Not all constraints are numbers. For example, on mobile devices, the following will\n prefer the front camera (if one is available) over the rear one:\n</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">js</span></div><pre class=\"brush: js notranslate\"><code>getUserMedia({\n audio: true,\n video: { facingMode: \"user\" },\n});\n</code></pre></div>\n<p>To <em>require</em> the rear camera, use:</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">js</span></div><pre class=\"brush: js notranslate\"><code>getUserMedia({\n audio: true,\n video: {\n facingMode: { exact: \"environment\" },\n },\n});\n</code></pre></div>\n<p>\n Another non-number constraint is the <code>deviceId</code> constraint. If you have\n a <code>deviceId</code> from <a href=\"/en-US/docs/Web/API/MediaDevices/enumerateDevices\"><code>mediaDevices.enumerateDevices()</code></a>, you can\n use it to request a specific device:\n</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">js</span></div><pre class=\"brush: js notranslate\"><code>getUserMedia({\n video: {\n deviceId: myPreferredCameraDeviceId,\n },\n});\n</code></pre></div>\n<p>\n The above will return the camera you requested, or a different camera if that\n specific camera is no longer available. Again, to <em>require</em> the specific\n camera, you would use:\n</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">js</span></div><pre class=\"brush: js notranslate\"><code>getUserMedia({\n video: {\n deviceId: {\n exact: myExactCameraOrBustDeviceId,\n },\n },\n});\n</code></pre></div>"}},{"type":"prose","value":{"id":"width_and_height","title":"Width and height","isH3":true,"content":"<p>\n This example gives a preference for camera resolution, and assigns the resulting\n <a href=\"/en-US/docs/Web/API/MediaStream\"><code>MediaStream</code></a> object to a video element.\n</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">js</span></div><pre class=\"brush: js notranslate\"><code>// Prefer camera resolution nearest to 1280x720.\nconst constraints = {\n audio: true,\n video: { width: 1280, height: 720 },\n};\n\nnavigator.mediaDevices\n .getUserMedia(constraints)\n .then((mediaStream) => {\n const video = document.querySelector(\"video\");\n video.srcObject = mediaStream;\n video.onloadedmetadata = () => {\n video.play();\n };\n })\n .catch((err) => {\n // always check for errors at the end.\n console.error(`${err.name}: ${err.message}`);\n });\n</code></pre></div>"}},{"type":"prose","value":{"id":"frame_rate","title":"Frame rate","isH3":true,"content":"<p>\n Lower frame-rates may be desirable in some cases, like WebRTC transmissions with\n bandwidth restrictions.\n</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">js</span></div><pre class=\"brush: js notranslate\"><code>const constraints = {\n video: { frameRate: { ideal: 10, max: 15 } },\n};\n</code></pre></div>"}},{"type":"prose","value":{"id":"front_and_back_camera","title":"Front and back camera","isH3":true,"content":"<p>On mobile phones.</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">js</span></div><pre class=\"brush: js notranslate\"><code>let front = false;\ndocument.getElementById(\"flip-button\").onclick = () => {\n front = !front;\n};\n\nconst constraints = {\n video: { facingMode: front ? \"user\" : \"environment\" },\n};\n</code></pre></div>\n<div class=\"notecard note\">\n <p><strong>Note:</strong> In certain cases, it may be necessary to release the current camera facing mode before you can switch to a different one. To ensure the camera switch, it is advisable to free up the media resources by invoking the \"stop()\" method on the track before requesting a different facing mode.</p>\n</div>"}},{"type":"specifications","value":{"title":"Specifications","id":"specifications","isH3":false,"specifications":[{"bcdSpecificationURL":"https://w3c.github.io/mediacapture-main/#dom-mediadevices-getusermedia","title":"Media Capture and Streams"}],"query":"api.MediaDevices.getUserMedia"}},{"type":"browser_compatibility","value":{"title":"Browser compatibility","id":"browser_compatibility","isH3":false,"query":"api.MediaDevices.getUserMedia"}},{"type":"prose","value":{"id":"see_also","title":"See also","isH3":false,"content":"<ul>\n <li>The older <a href=\"/en-US/docs/Web/API/Navigator/getUserMedia\"><code>Navigator.getUserMedia()</code></a> legacy API</li>\n <li><a href=\"/en-US/docs/Web/API/MediaDevices/enumerateDevices\"><code>MediaDevices.enumerateDevices()</code></a>: Listing available media devices</li>\n <li><a href=\"/en-US/docs/Web/API/WebRTC_API\">WebRTC API</a></li>\n <li><a href=\"/en-US/docs/Web/API/Media_Capture_and_Streams_API\">Media Capture and Streams API</a></li>\n <li><a href=\"/en-US/docs/Web/API/Screen_Capture_API\">Screen Capture API</a>: Capturing screen contents as a <a href=\"/en-US/docs/Web/API/MediaStream\"><code>MediaStream</code></a></li>\n <li><a href=\"/en-US/docs/Web/API/MediaDevices/getDisplayMedia\"><code>MediaDevices.getDisplayMedia()</code></a>: Getting a stream containing screen contents</li>\n <li><a href=\"/en-US/docs/Web/API/Media_Capture_and_Streams_API/Taking_still_photos\" title=\"Taking webcam photos\">Taking webcam photos</a>: A tutorial on using <code>getUserMedia()</code> to take still photos rather than video</li>\n</ul>"}}],"toc":[{"text":"Syntax","id":"syntax"},{"text":"Privacy and security","id":"privacy_and_security"},{"text":"Examples","id":"examples"},{"text":"Specifications","id":"specifications"},{"text":"Browser compatibility","id":"browser_compatibility"},{"text":"See also","id":"see_also"}],"summary":"The getUserMedia() method of the MediaDevices interface prompts the user for permission to use a media input which produces a MediaStream with tracks containing the requested types of media.","popularity":0.1096,"modified":"2024-07-26T03:44:38.000Z","other_translations":[{"locale":"de","title":"MediaDevices: Methode getUserMedia()","native":"Deutsch"},{"locale":"es","title":"MediaDevices.getUserMedia()","native":"Español"},{"locale":"fr","title":"MediaDevices.getUserMedia()","native":"Français"},{"locale":"ja","title":"MediaDevices: getUserMedia() メソッド","native":"日本語"},{"locale":"ru","title":"MediaDevices.getUserMedia()","native":"Русский"},{"locale":"zh-CN","title":"MediaDevices.getUserMedia()","native":"中文 (简体)"}],"pageType":"web-api-instance-method","source":{"folder":"en-us/web/api/mediadevices/getusermedia","github_url":"https://github.com/mdn/content/blob/main/files/en-us/web/api/mediadevices/getusermedia/index.md","last_commit_url":"https://github.com/mdn/content/commit/cfb7587e3e3122630ad6cbd94d834ecadbe0a746","filename":"index.md"},"short_title":"getUserMedia()","parents":[{"uri":"/en-US/docs/Web","title":"References"},{"uri":"/en-US/docs/Web/API","title":"Web APIs"},{"uri":"/en-US/docs/Web/API/MediaDevices","title":"MediaDevices"},{"uri":"/en-US/docs/Web/API/MediaDevices/getUserMedia","title":"getUserMedia()"}],"pageTitle":"MediaDevices: getUserMedia() method - Web APIs | MDN","noIndexing":false}}</script></body></html>