npm - @snap/camera-kit - Versions diffs - 0.11.0 → 0.13.0 - Mend

@snap/camera-kit 0.11.0 → 0.13.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (319) hide show

package/docs/html/index.html CHANGED Viewed

@@ -1,4 +1,4 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CameraKit Web SDK - v0.11.0-alpha.1</title><meta name="description" content="Documentation for CameraKit Web SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
+<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CameraKit Web SDK - v0.13.0-alpha.1</title><meta name="description" content="Documentation for CameraKit Web SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
 <div class="tsd-toolbar-contents container">
 <div class="table-cell" id="tsd-search" data-base=".">
 <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
@@ -6,56 +6,172 @@
 <div id="tsd-toolbar-links"></div></div>
 <ul class="results">
 <li class="state loading">Preparing search index...</li>
-<li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">CameraKit Web SDK - v0.11.0-alpha.1</a></div>
+<li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">CameraKit Web SDK - v0.13.0-alpha.1</a></div>
 <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
 <div class="container container-main">
 <div class="col-content">
 <div class="tsd-page-title">
-<h2>CameraKit Web SDK - v0.11.0-alpha.1</h2></div>
+<h2>CameraKit Web SDK - v0.13.0-alpha.1</h2></div>
 <div class="tsd-panel tsd-typography"><a id="md:snap-camera-kit-web-sdk" class="tsd-anchor"></a><h1><a href="#md:snap-camera-kit-web-sdk">Snap Camera Kit Web SDK</a></h1><p>The Camera Kit Web SDK allows web developers to build Snap&#39;s core AR Lens technology into their applications.</p>
-<a id="md:getting-started" class="tsd-anchor"></a><h2><a href="#md:getting-started">Getting started</a></h2><p>First, familiarize yourself with the <a href="https://docs.snap.com/camera-kit/home">Camera Kit docs</a>. This covers access to the Camera Kit Portal, where to find your API Token, how to manage lenses and lens groups, etc.</p>
-<p>Most of the content found here can also be found on the <a href="https://docs.snap.com/camera-kit/quick-start/integrate-sdk/integrate-sdk-web/web-configuration">Camera Kit docs</a> site.</p>
-<a id="md:installing-the-sdk" class="tsd-anchor"></a><h3><a href="#md:installing-the-sdk">Installing the SDK</a></h3><pre><code><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-0">install</span><span class="hl-1"> @</span><span class="hl-0">snap</span><span class="hl-1">/</span><span class="hl-0">camera</span><span class="hl-1">-</span><span class="hl-0">kit</span>
-</code><button>Copy</button></pre>
-<a id="md:using-the-sdk-in-a-javascript-project" class="tsd-anchor"></a><h3><a href="#md:using-the-sdk-in-a-javascript-project">Using the SDK in a Javascript project</a></h3><p>The SDK is authored in TypeScript, and distributes type definitions. All the examples here are presented in TypeScript. We encourage the use of TypeScript in projects that consume the SDK – but it&#39;s also fully compatible with Javascript projects as well.</p>
-<a id="md:importing-the-sdk" class="tsd-anchor"></a><h3><a href="#md:importing-the-sdk">Importing the SDK</a></h3><p>Currently, the SDK distributes <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules">Javascript modules</a>. We may support other module formats in the future (e.g. CommonJS), but for now you&#39;ll need to use <code>import</code> syntax to use the Camera Kit Web SDK.</p>
-<p>If you&#39;re working in a project that uses a bundler (e.g. Webpack or Rollup), or builds using the TypeScript compiler, this shouldn&#39;t be an issue. If you&#39;re not using a bundler, many browsers now support <code>import</code> syntax natively – if you don&#39;t need support for older browsers (or IE), no bundler is necessary.</p>
-<a id="md:bootstrapping-the-sdk" class="tsd-anchor"></a><h3><a href="#md:bootstrapping-the-sdk">Bootstrapping the SDK</a></h3><p>With the SDK installed and capable of being imported, the first thing to do is bootstrap the SDK. This tells the SDK to download the LensCore WebAssembly runtime, which will be used to render Lenses. It also allows you to configure the SDK according to your needs.</p>
+<a id="md:minimum-browser-requirements" class="tsd-anchor"></a><h2><a href="#md:minimum-browser-requirements">Minimum browser requirements</a></h2><ul>
+<li><strong>Chrome 73+</strong></li>
+<li><strong>Safari 15+</strong><ul>
+<li>MacOS 12+, iOS 15+, iPadOS 15+</li>
+<li>SIMD: Unsupported</li>
+<li>Web Worker Mode*: Unsupported</li>
+</ul>
+</li>
+<li><strong>Edge 79+</strong><ul>
+<li>Edge is still currently under evaluation. However, since New Edge is Chromium based, the expectations are similar to that of Chrome.</li>
+</ul>
+</li>
+<li><strong>Firefox</strong> - Under Evaluation<ul>
+<li>Web Worker Mode*: Firefox 105+</li>
+</ul>
+</li>
+</ul>
+<p>*Web Worker Mode requires <code>OffscreenCanvas</code> support.</p>
+<a id="md:prerequisites" class="tsd-anchor"></a><h2><a href="#md:prerequisites">Prerequisites</a></h2><a id="md:snap-developer-set-up" class="tsd-anchor"></a><h3><a href="#md:snap-developer-set-up">Snap Developer set up</a></h3><p>You&#39;ll need a Snap Developer account, and you&#39;ll need to apply for access to Camera Kit Web SDK. You can find more info on that <a href="camera-kit/quick-start/setting-up-accounts">here</a>.</p>
+<p>You may also want to familiarize yourself with how to access and manage AR content (i.e. Lenses). You read about that <a href="/camera-kit/quick-start/build-manage-ar-content/camera-kit-portal">here</a>.</p>
+<a id="md:development-environment" class="tsd-anchor"></a><h3><a href="#md:development-environment">Development environment</a></h3><p>This guide assumes you&#39;ve already set up an <a href="https://www.npmjs.com/">NPM</a> package, you&#39;re using <a href="https://www.typescriptlang.org/">TypeScript</a>, and have some way to build and host your project during development (e.g. using <a href="https://webpack.js.org/">Webpack</a>).</p>
+<a id="md:using-the-sdk-in-a-javascript-project" class="tsd-anchor"></a><h4><a href="#md:using-the-sdk-in-a-javascript-project">Using the SDK in a JavaScript project</a></h4><p>The SDK is authored in TypeScript, and distributes type definitions. All the examples here are presented in TypeScript. We encourage the use of TypeScript in projects that consume the SDK – but it&#39;s also fully compatible with JavaScript projects as well.</p>
+<a id="md:content-security-policy" class="tsd-anchor"></a><h3><a href="#md:content-security-policy">Content Security Policy</a></h3><p>If your project already has a <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy">Content Security Policy</a> in place, you&#39;ll likely need to make some changes in order for Camera Kit Web SDK to work.</p>
+<p>When it bootstraps, Camera Kit Web SDK downloads an executable WebAssembly file containing the Lens rendering engine. This file is served from an optimized CDN managed by Snap. You&#39;ll need to make sure your Content Security Policy allows this file to be executed.</p>
+<ul>
+<li><code>connect-src</code> must include <code>https://*.snapar.com</code>, otherwise Camera Kit Web will fail to initialize.</li>
+<li><code>script-src</code> must include <code>https://cf-st.sc-cdn.net/ blob: &#39;wasm-unsafe-eval&#39;</code>.</li>
+</ul>
+<p><em>Note: Some older browser versions may not support the <code>&#39;wasm-unsafe-eval&#39;</code> source value, and it may be necessary to use <code>&#39;unsafe-eval&#39;</code> to allow Camera Kit&#39;s downloaded WebAssembly to run.</em></p>
+<a id="md:installing-the-sdk" class="tsd-anchor"></a><h2><a href="#md:installing-the-sdk">Installing the SDK</a></h2><pre><code><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-0">install</span><span class="hl-1"> @</span><span class="hl-0">snap</span><span class="hl-1">/</span><span class="hl-0">camera</span><span class="hl-1">-</span><span class="hl-0">kit</span>
+</code><button>Copy</button></pre>
+<p>You can find the Camera Kit Web SDK package on npmjs.com <a href="https://www.npmjs.com/package/@snap/camera-kit">here</a>.</p>
+<a id="md:importing-camera-kit" class="tsd-anchor"></a><h3><a href="#md:importing-camera-kit">Importing Camera Kit</a></h3><p>Currently, the SDK distributes <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules">JavaScript modules</a>. We may support other module formats in the future (e.g. CommonJS), but for now you&#39;ll need to use <code>import</code> syntax to use the Camera Kit Web SDK.</p>
+<a id="md:bootstrapping-the-sdk" class="tsd-anchor"></a><h2><a href="#md:bootstrapping-the-sdk">Bootstrapping the SDK</a></h2><p>With the SDK installed and imported, the first thing to do is bootstrap the SDK. When bootstrapping, the SDK will download the WebAssembly runtime which is used to render Lenses. This is also where you&#39;ll configure the SDK according to your needs.</p>
 <p>To call <a href="functions/bootstrapCameraKit.html" class="tsd-kind-function">bootstrapCameraKit</a>, you&#39;ll need to provide a <code>apiToken</code>. Once you&#39;ve completed the <a href="https://docs.snap.com/camera-kit/guides/quick-start/integrate-sdk/setting-up-accounts">Getting set up in our portals</a> section of the Getting Started guide, you&#39;ll be able to find this in the <a href="https://devportal.snap.com/manage">Snap Kit Portal</a>.</p>
-<pre><code class="language-ts"><span class="hl-2">import</span><span class="hl-1"> { </span><span class="hl-0">boostrapCameraKit</span><span class="hl-1"> } </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">&quot;@snap/camera-kit&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-1">(</span><span class="hl-4">async</span><span class="hl-1"> </span><span class="hl-4">function</span><span class="hl-1"> </span><span class="hl-5">main</span><span class="hl-1">() {</span><br/><span class="hl-1">    </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">apiToken</span><span class="hl-1"> = </span><span class="hl-3">&quot;API Token value copied from the Camera Kit Portal&quot;</span><span class="hl-1">;</span><br/><span class="hl-1">    </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">cameraKit</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-5">bootstrapCameraKit</span><span class="hl-1">({ </span><span class="hl-0">apiToken</span><span class="hl-1"> });</span><br/><span class="hl-1">})();</span>
+<pre><code class="language-ts"><span class="hl-2">import</span><span class="hl-1"> { </span><span class="hl-0">boostrapCameraKit</span><span class="hl-1"> } </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">&quot;@snap/camera-kit&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-1">(</span><span class="hl-4">async</span><span class="hl-1"> </span><span class="hl-4">function</span><span class="hl-1"> </span><span class="hl-5">main</span><span class="hl-1">() {</span><br/><span class="hl-1">    </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">apiToken</span><span class="hl-1"> = </span><span class="hl-3">&quot;Your API Token value copied from the Camera Kit Portal&quot;</span><span class="hl-1">;</span><br/><span class="hl-1">    </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">cameraKit</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-5">bootstrapCameraKit</span><span class="hl-1">({ </span><span class="hl-0">apiToken</span><span class="hl-1"> });</span><br/><span class="hl-1">})();</span>
 </code><button>Copy</button></pre>
-<a id="md:creating-a-camerakitsession" class="tsd-anchor"></a><h3><a href="#md:creating-a-camerakitsession">Creating a CameraKitSession</a></h3><p>In order to render Lenses, you must first create a <a href="classes/CameraKitSession.html" class="tsd-kind-class">CameraKitSession</a>. Each session represents a rendering pipeline - it connects an input media source (e.g. a webcam) to the LensCore AR engine, applies a Lens, and renders the output to a <code>&lt;canvas&gt;</code> element.</p>
+<a id="md:creating-a-camerakitsession" class="tsd-anchor"></a><h2><a href="#md:creating-a-camerakitsession">Creating a <code>CameraKitSession</code></a></h2><p>In order to render Lenses, you must first create a <a href="classes/CameraKitSession.html" class="tsd-kind-class">CameraKitSession</a>. Each session represents a rendering pipeline - it connects an input media source (e.g. a webcam) to Camera Kit&#39;s AR engine, applies a Lens, and renders the output to a <code>&lt;canvas&gt;</code> element.</p>
 <p>There are two ways to create a session. If you already have a <code>&lt;canvas&gt;</code> element on your page that you&#39;d like for the <a href="classes/CameraKitSession.html" class="tsd-kind-class">CameraKitSession</a> to render into, you can pass it to Camera Kit when creating the session. Otherwise, the session will create a new <code>&lt;canvas&gt;</code> element which you can add to the DOM.</p>
 <pre><code class="language-ts"><span class="hl-7">// Using an existing canvas</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">canvas</span><span class="hl-1"> = </span><span class="hl-0">document</span><span class="hl-1">.</span><span class="hl-5">getElementById</span><span class="hl-1">(</span><span class="hl-3">&quot;my-canvas&quot;</span><span class="hl-1">);</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">session</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">cameraKit</span><span class="hl-1">.</span><span class="hl-5">createSession</span><span class="hl-1">(</span><span class="hl-0">canvas</span><span class="hl-1">);</span><br/><br/><span class="hl-7">// Let Camera Kit create a new canvas, then append it to the DOM</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">canvasContainer</span><span class="hl-1"> = </span><span class="hl-0">document</span><span class="hl-1">.</span><span class="hl-5">getElementById</span><span class="hl-1">(</span><span class="hl-3">&quot;canvas-container&quot;</span><span class="hl-1">);</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">session</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">cameraKit</span><span class="hl-1">.</span><span class="hl-5">createSession</span><span class="hl-1">();</span><br/><span class="hl-0">canvasContainer</span><span class="hl-1">.</span><span class="hl-5">appendChild</span><span class="hl-1">(</span><span class="hl-0">session</span><span class="hl-1">.</span><span class="hl-0">output</span><span class="hl-1">.</span><span class="hl-0">live</span><span class="hl-1">);</span>
 </code><button>Copy</button></pre>
-<p><em>There are actually two different output canvases: <code>live</code> and <code>capture</code>. These correspond to the two different RenderTargets to which a Lens may render. The <code>live</code> output renders a view suitable for presentation to the current user. Some Lenses may also render to the <code>capture</code> output, which renders content suitable for viewing by other users.</em></p>
-<a id="md:obtaining-a-media-source" class="tsd-anchor"></a><h3><a href="#md:obtaining-a-media-source">Obtaining a media source</a></h3><p>The most common source will be the user&#39;s webcam. Camera Kit Web SDK provides helper methods to create a <a href="classes/CameraKitSource.html" class="tsd-kind-class">CameraKitSource</a> object from
-a <a href="https://developer.mozilla.org/en-US/docs/Web/API/MediaStream/MediaStream"><code>MediaStream</code></a>, or directly from a user&#39;s webcam via <a href="https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia"><code>getUserMedia</code></a>.</p>
-<pre><code class="language-ts"><span class="hl-2">import</span><span class="hl-1"> { </span><span class="hl-0">createMediaStreamSource</span><span class="hl-1"> } </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">&quot;@snap/camera-kit&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-7">// ...</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">stream</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">navigator</span><span class="hl-1">.</span><span class="hl-0">mediaDevices</span><span class="hl-1">.</span><span class="hl-5">getUserMedia</span><span class="hl-1">({ </span><span class="hl-0">video:</span><span class="hl-1"> </span><span class="hl-4">true</span><span class="hl-1"> });</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">source</span><span class="hl-1"> = </span><span class="hl-5">createMediaStreamSource</span><span class="hl-1">(</span><span class="hl-0">stream</span><span class="hl-1">, {</span><br/><span class="hl-1">    </span><span class="hl-0">transform:</span><span class="hl-1"> </span><span class="hl-0">Transform2D</span><span class="hl-1">.</span><span class="hl-0">MirrorX</span><span class="hl-1">,</span><br/><span class="hl-1">    </span><span class="hl-0">cameraType:</span><span class="hl-1"> </span><span class="hl-3">&quot;front&quot;</span><span class="hl-1">,</span><br/><span class="hl-1">});</span><br/><span class="hl-0">session</span><span class="hl-1">.</span><span class="hl-5">setSource</span><span class="hl-1">(</span><span class="hl-0">source</span><span class="hl-1">);</span>
+<p>There are actually two different output canvases:</p>
+<ul>
+<li><code>live</code>: This canvas renders content intended for the Lens user. Depending on the Lens being used, this canvas may include UI elements, prompts, or other content that is only meant to be seen by the user of the Lens.</li>
+<li><code>capture</code>: This canvas renders content intended for presenting to other users.</li>
+</ul>
+<p>These two output canvases correspond to the two different <a href="https://docs.snap.com/lens-studio/references/guides/lens-features/scene-set-up/camera#render-target">RenderTargets</a> a Lens may use to render its content. Not all Lenses will render different content to <code>live</code> vs. <code>capture</code>, so it&#39;s important to understand how the Lenses you&#39;ll be using use these two different outputs.</p>
+<blockquote>
+<p>No rendering will happen yet, and the output canvas associated with this new <code>CameraKitSession</code> will be blank. Frames are not processed until you start <a href="#playback">playback</a> by calling the <code>CameraKitSession</code>&#39;s <code>play()</code> method. This will be discussed below.</p>
+</blockquote>
+<a id="md:creating-a-camerakitsource" class="tsd-anchor"></a><h2><a href="#md:creating-a-camerakitsource">Creating a <code>CameraKitSource</code></a></h2><p>In order for Camera Kit Web SDK to render anything, it must have a source of imagery to be processed by the AR engine. The Lens content will be rendered on top of this source media.</p>
+<p>The most common source of input media is the user&#39;s webcam. Camera Kit Web SDK provides a helper method to create a <code>CameraKitSource</code> object from a <a href="https://developer.mozilla.org/en-US/docs/Web/API/MediaStream"><code>MediaStream</code></a>. You can use <a href="https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia"><code>getUserMedia</code></a> to obtain a <code>MediaStream</code> with video from the user&#39;s webcam.</p>
+<blockquote>
+<p>Note that calling <code>getUserMedia</code> will prompt the user to grant the webpage access to their camera.</p>
+</blockquote>
+<p>Once we have a <code>CameraKitSource</code>, we can tell the <code>CameraKitSession</code> to use this source for rendering.</p>
+<pre><code class="language-ts"><span class="hl-2">import</span><span class="hl-1"> { </span><span class="hl-0">createMediaStreamSource</span><span class="hl-1">, </span><span class="hl-0">Transform2D</span><span class="hl-1"> } </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">&quot;@snap/camera-kit&quot;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">stream</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">navigator</span><span class="hl-1">.</span><span class="hl-0">mediaDevices</span><span class="hl-1">.</span><span class="hl-5">getUserMedia</span><span class="hl-1">({ </span><span class="hl-0">video:</span><span class="hl-1"> </span><span class="hl-4">true</span><span class="hl-1"> });</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">source</span><span class="hl-1"> = </span><span class="hl-5">createMediaStreamSource</span><span class="hl-1">(</span><span class="hl-0">stream</span><span class="hl-1">, { </span><span class="hl-0">transform:</span><span class="hl-1"> </span><span class="hl-0">Transform2D</span><span class="hl-1">.</span><span class="hl-0">MirrorX</span><span class="hl-1">, </span><span class="hl-0">cameraType:</span><span class="hl-1"> </span><span class="hl-3">&#39;user&#39;</span><span class="hl-1"> });</span><br/><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">session</span><span class="hl-1">.</span><span class="hl-5">setSource</span><span class="hl-1">(</span><span class="hl-0">source</span><span class="hl-1">);</span>
 </code><button>Copy</button></pre>
-<p><em>Note that calling <code>getUserMedia</code> will prompt the user to grant the webpage access to the webcam.</em></p>
-<a id="md:applying-a-lens" class="tsd-anchor"></a><h3><a href="#md:applying-a-lens">Applying a Lens</a></h3><p>In order to apply a lens to our session, we first have to fetch metadata for the lens we wish to apply. We can configure a group of lenses and get all the lenses in that group – this could be useful if we want to allow the user to select a lens from the group. Or if we know the specific lens we want to apply, we can provide its unique ID (along with the ID of a group that contains that lens) and get back just the single lens.</p>
-<p>In the <a href="https://camera-kit.snapchat.com/">Camera Kit Portal</a>, you can find available lenses and add them to lens groups. Once you&#39;ve chosen a lens or lens group to load, you can use the Lens repository to fetch the lens metadata. Then you can apply the lens to the session.</p>
-<p><em>The <a href="https://docs.snap.com/camera-kit/guides/quick-start/build-manage-ar-content/camera-kit-portal">Camera Kit docs</a> include info on how to set up Lenses and Lens Groups.</em></p>
-<pre><code class="language-ts"><span class="hl-7">// A single lens</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">lens</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">cameraKit</span><span class="hl-1">.</span><span class="hl-0">lensRepository</span><span class="hl-1">.</span><span class="hl-5">loadLens</span><span class="hl-1">(</span><span class="hl-3">&quot;A lens ID found in the Camera Kit Portal&quot;</span><span class="hl-1">, </span><span class="hl-3">&quot;A lens group ID&quot;</span><span class="hl-1">);</span><br/><span class="hl-0">session</span><span class="hl-1">.</span><span class="hl-5">applyLens</span><span class="hl-1">(</span><span class="hl-0">lens</span><span class="hl-1">);</span><br/><br/><span class="hl-7">// One or more lens groups – lenses from all groups are returned as a single array of lenses.</span><br/><span class="hl-4">const</span><span class="hl-1"> { </span><span class="hl-6">lenses</span><span class="hl-1"> } = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">cameraKit</span><span class="hl-1">.</span><span class="hl-0">lensRepository</span><span class="hl-1">.</span><span class="hl-5">loadLensGroups</span><span class="hl-1">([</span><br/><span class="hl-1">    </span><span class="hl-3">&quot;A lens group ID&quot;</span><span class="hl-1">,</span><br/><span class="hl-1">    </span><span class="hl-3">&quot;These can be found in the Camera Kit Portal&quot;</span><span class="hl-1">,</span><br/><span class="hl-1">]);</span><br/><span class="hl-0">session</span><span class="hl-1">.</span><span class="hl-5">applyLens</span><span class="hl-1">(</span><span class="hl-0">lenses</span><span class="hl-1">[</span><span class="hl-8">0</span><span class="hl-1">]);</span>
+<p>In this example, we also mirror the source stream (which feels more natural in most cases), and we indicate this source comes from a front-facing camera. To read more about these options, see <a href="#customizing-camerakitsource">below</a>.</p>
+<p>Camera Kit Web SDK has helper methods to create a <code>CameraKitSource</code> from:</p>
+<ul>
+<li>A <code>MediaStream</code> object, which could come from the user&#39;s camera, a WebRTC connection, a <code>&lt;canvas&gt;</code> via the <a href="https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/captureStream"><code>captureStream()</code> method</a>, or elsewhere.</li>
+<li>A <code>&lt;video&gt;</code> element (i.e. <code>HTMLVideoElement</code>)</li>
+<li>An <code>&lt;img&gt;</code>element (i.e. <code>HTMLImageElement</code>)</li>
+</ul>
+<a id="md:loading-applying-and-removing-lenses" class="tsd-anchor"></a><h2><a href="#md:loading-applying-and-removing-lenses">Loading, applying, and removing Lenses</a></h2><p>In Camera Kit Web SDK -- just like in the Snapchat app itself -- each individual AR experience is called a Lens. Lenses are created using <a href="https://ar.snap.com/en-US/lens-studio">Lens Studio</a>. You can find more information about acquiring Lenses <a href="https://docs.snap.com/camera-kit/quick-start/build-manage-ar-content/ar-overview">here</a>.</p>
+<p>You can find Lens and Lens Groups in the <a href="https://camera-kit.snapchat.com/">Camera Kit Portal</a>. This is where you can manage your Lenses and Lens Groups and where you can find Lens IDs and Lens Group IDs. You can read more about managing Lenses in the Camera Kit Portal <a href="https://docs.snap.com/camera-kit/quick-start/build-manage-ar-content/camera-kit-portal">here</a>.</p>
+<p>Before applying a Lens to our session, we have to load metadata about that Lens. Lenses can be loaded either one at a time, or entire Lens Groups can be loaded at once. You&#39;ll need a Lens ID and its Lens Group ID to complete this step.</p>
+<pre><code class="language-ts"><span class="hl-7">// Loading a single lens</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">lens</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">cameraKit</span><span class="hl-1">.</span><span class="hl-0">lensRepository</span><span class="hl-1">.</span><span class="hl-5">loadLens</span><span class="hl-1">(</span><span class="hl-3">&quot;&lt;Lens ID&gt;&quot;</span><span class="hl-1">, </span><span class="hl-3">&quot;&lt;Lens Group ID&gt;&quot;</span><span class="hl-1">);</span><br/><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">session</span><span class="hl-1">.</span><span class="hl-5">applyLens</span><span class="hl-1">(</span><span class="hl-0">lens</span><span class="hl-1">);</span><br/><br/><span class="hl-7">// Loading one or more Lens Groups – Lenses from all groups are returned as a single array of lenses.</span><br/><span class="hl-4">const</span><span class="hl-1"> { </span><span class="hl-6">lenses</span><span class="hl-1"> } = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">cameraKit</span><span class="hl-1">.</span><span class="hl-0">lensRepository</span><span class="hl-1">.</span><span class="hl-5">loadLensGroups</span><span class="hl-1">([</span><br/><span class="hl-1">    </span><span class="hl-3">&quot;&lt;Lens Group ID 1&gt;&quot;</span><span class="hl-1">,</span><br/><span class="hl-1">    </span><span class="hl-3">&quot;&lt;Lens Group ID 2&gt;&quot;</span><span class="hl-1">,</span><br/><span class="hl-1">]);</span><br/><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">session</span><span class="hl-1">.</span><span class="hl-5">applyLens</span><span class="hl-1">(</span><span class="hl-0">lenses</span><span class="hl-1">[</span><span class="hl-8">0</span><span class="hl-1">]);</span>
 </code><button>Copy</button></pre>
-<a id="md:setting-the-render-size" class="tsd-anchor"></a><h3><a href="#md:setting-the-render-size">Setting the render size</a></h3><p>By default, Camera Kit will render its output at the same resolution as the video input you provided. But you can also tell Camera Kit to render at a different resolution.</p>
-<p>Keep in mind that this controls LensCore&#39;s render resolution, and not (necessarily) the size at which the output canvas is displayed to the user. The output canvas may be sized using HTML and CSS, and may apply its own scaling to the rendered output.</p>
-<p>Most of the time you&#39;ll not need to set the render size – but it could be useful if your video source is, say, very high resolution. In that case, you may observe better performance by telling Camera Kit to render at a lower resolution.</p>
-<pre><code class="language-ts"><span class="hl-0">session</span><span class="hl-1">.</span><span class="hl-5">setRenderSize</span><span class="hl-1">(</span><span class="hl-0">width</span><span class="hl-1">, </span><span class="hl-0">height</span><span class="hl-1">);</span>
+<a id="md:removing-the-lens" class="tsd-anchor"></a><h3><a href="#md:removing-the-lens">Removing the Lens</a></h3><p>You can also remove the currently-applied Lens:</p>
+<pre><code class="language-ts"><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">session</span><span class="hl-1">.</span><span class="hl-5">removeLens</span><span class="hl-1">();</span>
 </code><button>Copy</button></pre>
-<p><em>Note that when calling <a href="https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia"><code>getUserMedia</code></a>, best performance can be achieved by requesting the resolution you want to display. This can be done using <a href="https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia#parameters">constraints</a></em></p>
-<a id="md:session-playback" class="tsd-anchor"></a><h3><a href="#md:session-playback">Session playback</a></h3><p>The <a href="classes/CameraKitSession.html" class="tsd-kind-class">CameraKitSession</a> will only process input video frames and render them to the output when you tell it to do so – this way, you can control when Camera Kit is using a client&#39;s resources (e.g. CPU and GPU compute cycles). You can tell the session to <code>play</code> or <code>pause</code>.</p>
+<p>After removing the Lens, when the session renders it will simply render the input media directly to the output canvas.</p>
+<a id="md:playback" class="tsd-anchor"></a><h2><a href="#md:playback">Playback</a></h2><p>The <a href="classes/CameraKitSession.html" class="tsd-kind-class">CameraKitSession</a> will only process input video frames and render them to the output when you tell it to do so – this way, you can control when Camera Kit is using a client&#39;s resources (e.g. CPU and GPU compute cycles). You can tell the session to <code>play</code> or <code>pause</code>.</p>
 <pre><code class="language-ts"><span class="hl-0">session</span><span class="hl-1">.</span><span class="hl-5">play</span><span class="hl-1">();</span><br/><br/><span class="hl-7">// ...sometime later</span><br/><span class="hl-0">session</span><span class="hl-1">.</span><span class="hl-5">pause</span><span class="hl-1">();</span>
 </code><button>Copy</button></pre>
-<p><em>You can also tell the session which output – <code>live</code> or <code>capture</code> - to play / pause. By default, <code>play</code> will start rendering the <code>live</code> output and <code>pause</code> will pause rendering all outputs.</em></p>
-<a id="md:putting-it-all-together" class="tsd-anchor"></a><h3><a href="#md:putting-it-all-together">Putting it all together</a></h3><p>Using the examples above, here&#39;s a complete example of the minimal Camera Kit Web SDK integration:</p>
-<pre><code class="language-ts"><span class="hl-2">import</span><span class="hl-1"> { </span><span class="hl-0">boostrapCameraKit</span><span class="hl-1">, </span><span class="hl-0">createMediaStreamSource</span><span class="hl-1"> } </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">&quot;@snap/camera-kit&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-1">(</span><span class="hl-4">async</span><span class="hl-1"> </span><span class="hl-4">function</span><span class="hl-1"> </span><span class="hl-5">main</span><span class="hl-1">() {</span><br/><span class="hl-1">    </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">apiToken</span><span class="hl-1"> = </span><span class="hl-3">&quot;API Token value copied from the SnapKit developer portal&quot;</span><span class="hl-1">;</span><br/><span class="hl-1">    </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">cameraKit</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-5">bootstrapCameraKit</span><span class="hl-1">({ </span><span class="hl-0">apiToken</span><span class="hl-1"> });</span><br/><br/><span class="hl-1">    </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">canvas</span><span class="hl-1"> = </span><span class="hl-0">document</span><span class="hl-1">.</span><span class="hl-5">getElementById</span><span class="hl-1">(</span><span class="hl-3">&quot;my-canvas&quot;</span><span class="hl-1">);</span><br/><span class="hl-1">    </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">session</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">cameraKit</span><span class="hl-1">.</span><span class="hl-5">createSession</span><span class="hl-1">(</span><span class="hl-0">canvas</span><span class="hl-1">);</span><br/><br/><span class="hl-1">    </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">stream</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">navigator</span><span class="hl-1">.</span><span class="hl-0">mediaDevices</span><span class="hl-1">.</span><span class="hl-5">getUserMedia</span><span class="hl-1">({ </span><span class="hl-0">video:</span><span class="hl-1"> </span><span class="hl-4">true</span><span class="hl-1"> });</span><br/><span class="hl-1">    </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">source</span><span class="hl-1"> = </span><span class="hl-5">createMediaStreamSource</span><span class="hl-1">(</span><span class="hl-0">stream</span><span class="hl-1">, {</span><br/><span class="hl-1">        </span><span class="hl-0">transform:</span><span class="hl-1"> </span><span class="hl-0">Transform2D</span><span class="hl-1">.</span><span class="hl-0">MirrorX</span><span class="hl-1">,</span><br/><span class="hl-1">        </span><span class="hl-0">cameraType:</span><span class="hl-1"> </span><span class="hl-3">&quot;front&quot;</span><span class="hl-1">,</span><br/><span class="hl-1">    });</span><br/><span class="hl-1">    </span><span class="hl-0">session</span><span class="hl-1">.</span><span class="hl-5">setSource</span><span class="hl-1">(</span><span class="hl-0">source</span><span class="hl-1">);</span><br/><br/><span class="hl-1">    </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">lens</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">cameraKit</span><span class="hl-1">.</span><span class="hl-0">lensRepository</span><span class="hl-1">.</span><span class="hl-5">loadLens</span><span class="hl-1">(</span><span class="hl-3">&quot;A lens ID found in the Camera Kit Portal&quot;</span><span class="hl-1">, </span><span class="hl-3">&quot;A lens group ID&quot;</span><span class="hl-1">);</span><br/><span class="hl-1">    </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">session</span><span class="hl-1">.</span><span class="hl-5">applyLens</span><span class="hl-1">(</span><span class="hl-0">lens</span><span class="hl-1">);</span><br/><br/><span class="hl-1">    </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">session</span><span class="hl-1">.</span><span class="hl-5">play</span><span class="hl-1">();</span><br/><span class="hl-1">    </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-3">&quot;Lens rendering has started!&quot;</span><span class="hl-1">);</span><br/><span class="hl-1">})();</span>
+<a id="md:playing-and-pausing-the-different-rendertargets" class="tsd-anchor"></a><h3><a href="#md:playing-and-pausing-the-different-rendertargets">Playing and pausing the different RenderTargets</a></h3><p>By default, <code>play()</code> will only begin rendering the <code>live</code> output canvas. You can specify which canvas to render by passing an argument:</p>
+<pre><code class="language-ts"><span class="hl-0">session</span><span class="hl-1">.</span><span class="hl-5">play</span><span class="hl-1">(</span><span class="hl-3">&#39;live&#39;</span><span class="hl-1">);</span><br/><span class="hl-0">session</span><span class="hl-1">.</span><span class="hl-5">play</span><span class="hl-1">(</span><span class="hl-3">&#39;capture&#39;</span><span class="hl-1">);</span>
 </code><button>Copy</button></pre>
-<a id="md:content-security-policy" class="tsd-anchor"></a><h3><a href="#md:content-security-policy">Content Security Policy</a></h3><p>Camera Kit Web SDK downloads an executable WebAssembly file containing the Lens rendering engine. This file is served from an optimized CDN. If you have a <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy">Content Security Policy</a> in place on your page, you&#39;ll likely need to make some changes in order for Camera Kit to work.</p>
-<a id="md:connect-src" class="tsd-anchor"></a><h4><a href="#md:connect-src"><code>connect-src</code></a></h4><p>Must include <code>https://*.snapchat.com</code>, otherwise Camera Kit Web will fail to initialize.</p>
-<a id="md:script-src" class="tsd-anchor"></a><h4><a href="#md:script-src"><code>script-src</code></a></h4><p>Must include <code>https://cf-st.sc-cdn.net/ blob: &#39;wasm-unsafe-eval&#39;</code>.</p>
-<p><em>Note: Some older browser versions may not support the <code>&#39;wasm-unsafe-eval&#39;</code> source value, and it may be necessary to use <code>&#39;unsafe-eval&#39;</code> to allow Camera Kit&#39;s downloaded WebAssembly to run.</em></p>
+<p>Calling <code>pause()</code> with no arguments will pause both outputs. But just like with <code>play()</code>, you can pass an argument to select which canvas to pause.</p>
+<pre><code class="language-ts"><span class="hl-0">session</span><span class="hl-1">.</span><span class="hl-5">pause</span><span class="hl-1">(</span><span class="hl-3">&#39;live&#39;</span><span class="hl-1">);</span><br/><span class="hl-0">session</span><span class="hl-1">.</span><span class="hl-5">pause</span><span class="hl-1">(</span><span class="hl-3">&#39;capture&#39;</span><span class="hl-1">);</span>
+</code><button>Copy</button></pre>
+<blockquote>
+<ul>
+<li><em><code>live</code>: This canvas renders content intended for the Lens user. Depending on the Lens being used, this canvas may include UI elements, prompts, or other content that is only meant to be seen by the user of the Lens.</em></li>
+<li><em><code>capture</code>: This canvas renders content intended for presenting to other users.</em></li>
+</ul>
+</blockquote>
+<a id="md:error-handling" class="tsd-anchor"></a><h2><a href="#md:error-handling">Error Handling</a></h2><p>Camera Kit Web SDK methods may throw errors, or return rejected Promises -- these are documented in the <a href="https://kit.snapchat.com/reference/CameraKit/web/0.12.0/index.html">API docs</a>. It is good practice to handle such cases, to provide a good experience to your users.</p>
+<p>Errors may also occur during Lens rendering. For example, Lenses contain their own scripting, which could throw an error. A rendering error could also occur if a Lens attempts to use a feature that is not supported by Camera Kit Web SDK.</p>
+<p>When a <code>LensExecutionError</code> such as these occurs, the Lens is <strong>automatically removed</strong> from the <code>CameraKitSession</code>. An error event is emitted so that your application can respond appropriately. You can listen to these error events like so:</p>
+<pre><code class="language-ts"><span class="hl-0">session</span><span class="hl-1">.</span><span class="hl-0">events</span><span class="hl-1">.</span><span class="hl-5">addEventListener</span><span class="hl-1">(</span><span class="hl-3">&#39;error&#39;</span><span class="hl-1">, (</span><span class="hl-0">event</span><span class="hl-1">) </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1">  </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">error</span><span class="hl-1">(</span><span class="hl-0">event</span><span class="hl-1">.</span><span class="hl-0">detail</span><span class="hl-1">.</span><span class="hl-0">error</span><span class="hl-1">);</span><br/><br/><span class="hl-1">  </span><span class="hl-2">if</span><span class="hl-1"> (</span><span class="hl-0">event</span><span class="hl-1">.</span><span class="hl-0">detail</span><span class="hl-1">.</span><span class="hl-0">error</span><span class="hl-1">.</span><span class="hl-0">name</span><span class="hl-1"> === </span><span class="hl-3">&#39;LensExecutionError&#39;</span><span class="hl-1">) {</span><br/><span class="hl-1">    </span><span class="hl-7">// The currently-applied Lens encountered a problem that is most likely unrecoverable and the Lens has been removed.</span><br/><span class="hl-1">    </span><span class="hl-7">// Your application may want to prevent this Lens from being applied again.</span><br/><span class="hl-1">  }</span><br/><span class="hl-1">});</span>
+</code><button>Copy</button></pre>
+<a id="md:putting-it-all-together" class="tsd-anchor"></a><h2><a href="#md:putting-it-all-together">Putting it all together</a></h2><p>Using the examples above, here&#39;s a complete example of the minimal Camera Kit Web SDK integration:</p>
+<pre><code class="language-ts"><span class="hl-2">import</span><span class="hl-1"> { </span><span class="hl-0">boostrapCameraKit</span><span class="hl-1">, </span><span class="hl-0">createMediaStreamSource</span><span class="hl-1"> } </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">&quot;@snap/camera-kit&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-1">(</span><span class="hl-4">async</span><span class="hl-1"> </span><span class="hl-4">function</span><span class="hl-1"> </span><span class="hl-5">main</span><span class="hl-1">() {</span><br/><span class="hl-1">    </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">apiToken</span><span class="hl-1"> = </span><span class="hl-3">&quot;Your API Token value copied from the SnapKit developer portal&quot;</span><span class="hl-1">;</span><br/><span class="hl-1">    </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">cameraKit</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-5">bootstrapCameraKit</span><span class="hl-1">({ </span><span class="hl-0">apiToken</span><span class="hl-1"> });</span><br/><br/><span class="hl-1">    </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">canvas</span><span class="hl-1"> = </span><span class="hl-0">document</span><span class="hl-1">.</span><span class="hl-5">getElementById</span><span class="hl-1">(</span><span class="hl-3">&quot;my-canvas&quot;</span><span class="hl-1">);</span><br/><span class="hl-1">    </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">session</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">cameraKit</span><span class="hl-1">.</span><span class="hl-5">createSession</span><span class="hl-1">({ </span><span class="hl-0">liveRenderTarget:</span><span class="hl-1"> </span><span class="hl-0">canvas</span><span class="hl-1"> });</span><br/><span class="hl-1">    </span><span class="hl-0">session</span><span class="hl-1">.</span><span class="hl-0">events</span><span class="hl-1">.</span><span class="hl-5">addEventListener</span><span class="hl-1">(</span><span class="hl-3">&#39;error&#39;</span><span class="hl-1">, (</span><span class="hl-0">event</span><span class="hl-1">) </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1">      </span><span class="hl-2">if</span><span class="hl-1"> (</span><span class="hl-0">event</span><span class="hl-1">.</span><span class="hl-0">detail</span><span class="hl-1">.</span><span class="hl-0">error</span><span class="hl-1">.</span><span class="hl-0">name</span><span class="hl-1"> === </span><span class="hl-3">&#39;LensExecutionError&#39;</span><span class="hl-1">) {</span><br/><span class="hl-1">        </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-3">&#39;The current Lens encountered an error and was removed.&#39;</span><span class="hl-1">, </span><span class="hl-0">event</span><span class="hl-1">.</span><span class="hl-0">detail</span><span class="hl-1">.</span><span class="hl-0">error</span><span class="hl-1">);</span><br/><span class="hl-1">      }</span><br/><span class="hl-1">    });</span><br/><br/><span class="hl-1">    </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">stream</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">navigator</span><span class="hl-1">.</span><span class="hl-0">mediaDevices</span><span class="hl-1">.</span><span class="hl-5">getUserMedia</span><span class="hl-1">({ </span><span class="hl-0">video:</span><span class="hl-1"> </span><span class="hl-4">true</span><span class="hl-1"> });</span><br/><span class="hl-1">    </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">source</span><span class="hl-1"> = </span><span class="hl-5">createMediaStreamSource</span><span class="hl-1">(</span><span class="hl-0">stream</span><span class="hl-1">, { </span><span class="hl-0">transform:</span><span class="hl-1"> </span><span class="hl-0">Transform2D</span><span class="hl-1">.</span><span class="hl-0">MirrorX</span><span class="hl-1">, </span><span class="hl-0">cameraType:</span><span class="hl-1"> </span><span class="hl-3">&#39;user&#39;</span><span class="hl-1"> });</span><br/><span class="hl-1">    </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">session</span><span class="hl-1">.</span><span class="hl-5">setSource</span><span class="hl-1">(</span><span class="hl-0">source</span><span class="hl-1">);</span><br/><br/><span class="hl-1">    </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">lens</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">cameraKit</span><span class="hl-1">.</span><span class="hl-0">lensRepository</span><span class="hl-1">.</span><span class="hl-5">loadLens</span><span class="hl-1">(</span><span class="hl-3">&quot;&lt;Lens ID&gt;&quot;</span><span class="hl-1">, </span><span class="hl-3">&quot;&lt;Lens Group ID&gt;&quot;</span><span class="hl-1">);</span><br/><span class="hl-1">    </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">session</span><span class="hl-1">.</span><span class="hl-5">applyLens</span><span class="hl-1">(</span><span class="hl-0">lens</span><span class="hl-1">);</span><br/><br/><span class="hl-1">    </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">session</span><span class="hl-1">.</span><span class="hl-5">play</span><span class="hl-1">();</span><br/><span class="hl-1">    </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-3">&quot;Lens rendering has started!&quot;</span><span class="hl-1">);</span><br/><span class="hl-1">})();</span><br/><br/><span class="hl-5">main</span><span class="hl-1">();</span>
+</code><button>Copy</button></pre>
+<a id="md:advanced-use-cases" class="tsd-anchor"></a><h2><a href="#md:advanced-use-cases">Advanced use cases</a></h2><a id="md:logging" class="tsd-anchor"></a><h3><a href="#md:logging">Logging</a></h3><p>By default, Camera Kit Web SDK does very minimal logging. Specifying <code>&#39;console&#39;</code> as logger will cause more log statements to be printed to the browser&#39;s console, which may be useful during development.</p>
+<pre><code class="language-ts"><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">cameraKit</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-5">bootstrapCameraKit</span><span class="hl-1">({</span><br/><span class="hl-1">  </span><span class="hl-0">apiToken:</span><span class="hl-1"> </span><span class="hl-3">&#39;&lt;apiToken&gt;&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-0">logger:</span><span class="hl-1"> </span><span class="hl-3">&#39;console&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">});</span>
+</code><button>Copy</button></pre>
+<a id="md:keyboard-support-for-lenses" class="tsd-anchor"></a><h3><a href="#md:keyboard-support-for-lenses">Keyboard support for Lenses</a></h3><p>Some Lenses allow for keyboard input. The SDK provides a <code>&lt;textarea&gt;</code> (<code>HTMLTextAreaElement</code>) element that can be added to your page, and will send its text to the active Lens whenever the user presses the <code>Enter</code> key.</p>
+<pre><code class="language-ts"><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">textAreaContainer</span><span class="hl-1"> = </span><span class="hl-0">document</span><span class="hl-1">.</span><span class="hl-5">getElementById</span><span class="hl-1">(</span><span class="hl-3">&#39;text-area-container&#39;</span><span class="hl-1">);</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">textArea</span><span class="hl-1"> = </span><span class="hl-0">session</span><span class="hl-1">.</span><span class="hl-0">keyboard</span><span class="hl-1">.</span><span class="hl-5">getElement</span><span class="hl-1">();</span><br/><span class="hl-0">textAreaContainer</span><span class="hl-1">.</span><span class="hl-5">appendChild</span><span class="hl-1">(</span><span class="hl-0">textArea</span><span class="hl-1">);</span>
+</code><button>Copy</button></pre>
+<p>Alternatively, an event is emitted when a Lens is expecting text input. You can then implement your own UI and logic for obtaining text input from your users, and then send it back to the Lens. For example, something like:</p>
+<pre><code class="language-ts"><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">input</span><span class="hl-1"> = </span><span class="hl-0">document</span><span class="hl-1">.</span><span class="hl-5">getElementById</span><span class="hl-1">(</span><span class="hl-3">&#39;my-text-area&#39;</span><span class="hl-1">);</span><br/><span class="hl-0">session</span><span class="hl-1">.</span><span class="hl-0">keyboard</span><span class="hl-1">.</span><span class="hl-5">addEventListener</span><span class="hl-1">(</span><span class="hl-3">&#39;active&#39;</span><span class="hl-1">, () </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1">  </span><span class="hl-0">input</span><span class="hl-1">.</span><span class="hl-0">classList</span><span class="hl-1">.</span><span class="hl-5">remove</span><span class="hl-1">(</span><span class="hl-3">&#39;hidden&#39;</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-0">input</span><span class="hl-1">.</span><span class="hl-5">addEventListener</span><span class="hl-1">(</span><span class="hl-3">&#39;keyup&#39;</span><span class="hl-1">, () </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1">  </span><span class="hl-0">session</span><span class="hl-1">.</span><span class="hl-0">keyboard</span><span class="hl-1">.</span><span class="hl-5">sendInputToLens</span><span class="hl-1">(</span><span class="hl-0">input</span><span class="hl-1">.</span><span class="hl-0">value</span><span class="hl-1">);</span><br/><span class="hl-1">})</span>
+</code><button>Copy</button></pre>
+<p>See an example of this <a href="https://camera-kit.snapchat.com/websdk/sample/keyboard">here</a>.</p>
+<a id="md:customizing-camerakitsource" class="tsd-anchor"></a><h3><a href="#md:customizing-camerakitsource">Customizing <code>CameraKitSource</code></a></h3><a id="md:setting-the-render-size" class="tsd-anchor"></a><h4><a href="#md:setting-the-render-size">Setting the render size</a></h4><p>By default, Camera Kit will render its output at the same resolution as the video input you provided. But you can also tell Camera Kit to render at a different resolution.</p>
+<p>Keep in mind that this controls Camera Kit&#39;s render resolution, and not (necessarily) the size at which the output canvas is displayed to the user. The output canvas may be sized using HTML and CSS, and may apply its own scaling to the rendered output.</p>
+<p>Most of the time you&#39;ll not need to set the render size – but it could be useful if your video source is, say, very high resolution. In that case, you may observe better performance by telling Camera Kit to render at a lower resolution.</p>
+<pre><code class="language-ts"><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">session</span><span class="hl-1">.</span><span class="hl-5">setSource</span><span class="hl-1">(</span><span class="hl-0">source</span><span class="hl-1">)</span><br/><span class="hl-7">// This must be done *after* calling `setSource()`</span><br/><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">source</span><span class="hl-1">.</span><span class="hl-5">setRenderSize</span><span class="hl-1">(</span><span class="hl-0">width</span><span class="hl-1">, </span><span class="hl-0">height</span><span class="hl-1">);</span>
+</code><button>Copy</button></pre>
+<blockquote>
+<p>When calling <a href="https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia"><code>getUserMedia</code></a>, best performance can be achieved by requesting the resolution at which you want to render. This can be done using <a href="https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia#parameters">constraints</a>. Then you won&#39;t have to use <code>setRenderSize</code> at all.</p>
+</blockquote>
+<a id="md:camera-type" class="tsd-anchor"></a><h4><a href="#md:camera-type">Camera type</a></h4><p>When setting up a <code>CameraKitSource</code>, you can specify whether or not it is a front facing camera or a back facing camera. By default, the media source will be treated as a front facing camera. If it is a back facing camera be sure to specify it as such when you create your source; this ensures that Lenses created for back facing camera&#39;s (e.g. World AR) render properly.</p>
+<pre><code class="language-ts"><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">stream</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">navigator</span><span class="hl-1">.</span><span class="hl-0">mediaDevices</span><span class="hl-1">.</span><span class="hl-5">getUserMedia</span><span class="hl-1">(</span><span class="hl-0">constraints</span><span class="hl-1">);</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">source</span><span class="hl-1"> = </span><span class="hl-5">createMediaStreamSource</span><span class="hl-1">(</span><span class="hl-0">stream</span><span class="hl-1">, { </span><span class="hl-0">cameraType:</span><span class="hl-1"> </span><span class="hl-3">&#39;environment&#39;</span><span class="hl-1"> });</span><br/><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">session</span><span class="hl-1">.</span><span class="hl-5">setSource</span><span class="hl-1">(</span><span class="hl-0">source</span><span class="hl-1">);</span>
+</code><button>Copy</button></pre>
+<a id="md:fps-limit" class="tsd-anchor"></a><h4><a href="#md:fps-limit">FPS limit</a></h4><p>In some cases, it may be desirable to set a limit on the FPS at which Camera Kit renders. By default, Camera Kit will attempt to render frames at the same rate as the source media. But, for example, if your input media source has a very high framerate you may want to limit Camera Kit&#39;s rendering framerate to achieve better performance.</p>
+<p>This can be done at the <code>CameraKitSession</code> level:</p>
+<pre><code class="language-ts"><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">session</span><span class="hl-1">.</span><span class="hl-5">setFPSLimit</span><span class="hl-1">(</span><span class="hl-8">60</span><span class="hl-1">);</span>
+</code><button>Copy</button></pre>
+<p>Or at the <code>CameraKitSource</code> level:</p>
+<pre><code class="language-ts"><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">stream</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">navigator</span><span class="hl-1">.</span><span class="hl-0">mediaDevices</span><span class="hl-1">.</span><span class="hl-5">getUserMedia</span><span class="hl-1">(</span><span class="hl-0">constraints</span><span class="hl-1">);</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">source</span><span class="hl-1"> = </span><span class="hl-5">createMediaStreamSource</span><span class="hl-1">(</span><span class="hl-0">stream</span><span class="hl-1">, { </span><span class="hl-0">fpsLimit:</span><span class="hl-1"> </span><span class="hl-8">60</span><span class="hl-1"> });</span>
+</code><button>Copy</button></pre>
+<p>These options can also be used with any of the <a href="#creating-a-camerakitsource">create source helpers</a>.</p>
+<a id="md:2d-transforms" class="tsd-anchor"></a><h4><a href="#md:2d-transforms">2D transforms</a></h4><p>Any <code>CameraKitSource</code> can be transformed using a matrix, to rotate, scale, or mirror the source media. This is most often used to mirror a front-facing camera stream so that it appears more natural to the user.</p>
+<pre><code class="language-ts"><span class="hl-2">import</span><span class="hl-1"> { </span><span class="hl-0">Transform2D</span><span class="hl-1"> } </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">&quot;@snap/camera-kit&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">session</span><span class="hl-1">.</span><span class="hl-5">setSource</span><span class="hl-1">(</span><span class="hl-0">source</span><span class="hl-1">)</span><br/><span class="hl-7">// This must be done *after* calling `setSource()`</span><br/><span class="hl-0">source</span><span class="hl-1">.</span><span class="hl-5">setTransform</span><span class="hl-1">(</span><span class="hl-0">Transform2D</span><span class="hl-1">.</span><span class="hl-0">MirrorX</span><span class="hl-1">);</span>
+</code><button>Copy</button></pre>
+<a id="md:metrics-reporting" class="tsd-anchor"></a><h3><a href="#md:metrics-reporting">Metrics reporting</a></h3><p>Camera Kit Web SDK reports certain important events which may be of interest to the application.</p>
+<blockquote>
+<p>This is an unstable portion of the Camera Kit Web SDK&#39;s public API -- the specific events and their properties may change between versions of the SDK, without warning. We currently offer these events as a convenient way to gather more information from the SDK, but if you need to report accurate metrics (e.g. number of lens views), that is currently something you will have to implement in your application.</p>
+</blockquote>
+<p>Currently, the only event that may be of interest is the <code>lensView</code> event. It is emitted whenever a lens is <em>removed</em> from the <code>CameraKitSession</code>, indicating a complete lens view. It contains information about the lens&#39; performance (e.g. fps, frame processing times, etc.) and how long the lens was applied.</p>
+<p>You may listen to these events like so:</p>
+<pre><code class="language-ts"><span class="hl-0">cameraKit</span><span class="hl-1">.</span><span class="hl-0">metrics</span><span class="hl-1">.</span><span class="hl-5">addEventListener</span><span class="hl-1">(</span><span class="hl-3">&#39;lensView&#39;</span><span class="hl-1">, (</span><span class="hl-0">event</span><span class="hl-1">) </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1">  </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">debug</span><span class="hl-1">(</span><span class="hl-0">event</span><span class="hl-1">.</span><span class="hl-0">detail</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
+</code><button>Copy</button></pre>
+<p>&lt;&lt;&lt;&lt;&lt;&lt;&lt; HEAD</p>
+<a id="md:error-handling-1" class="tsd-anchor"></a><h3><a href="#md:error-handling-1">Error Handling</a></h3><p>Camera Kit Web SDK methods may throw errors, or return rejected Promises -- these are documented in the <a href="https://kit.snapchat.com/reference/CameraKit/web/0.11.0/index.html">API docs</a>. It is good practice to handle such cases, to provide a good experience to your users.</p>
+<p>Errors may also occur during Lens rendering. For example, if the Lens that has been applied contains a bug -- Lenses have their own internal scripts, which can fail. A rendering error could also occur if a Lens depends on a feature that is not supported by Camera Kit Web SDK.</p>
+<p>When a <code>LensExecutionError</code> such as these occurs, the Lens is <strong>automatically removed</strong> from the <code>CameraKitSession</code>. An error event is emitted so that your application can respond appropriately. You can listen to these error events like so:</p>
+<pre><code class="language-ts"><span class="hl-0">session</span><span class="hl-1">.</span><span class="hl-0">events</span><span class="hl-1">.</span><span class="hl-5">addEventListener</span><span class="hl-1">(</span><span class="hl-3">&#39;error&#39;</span><span class="hl-1">, (</span><span class="hl-0">event</span><span class="hl-1">) </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1">  </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">error</span><span class="hl-1">(</span><span class="hl-0">event</span><span class="hl-1">.</span><span class="hl-0">detail</span><span class="hl-1">.</span><span class="hl-0">error</span><span class="hl-1">);</span><br/><br/><span class="hl-1">  </span><span class="hl-2">if</span><span class="hl-1"> (</span><span class="hl-0">event</span><span class="hl-1">.</span><span class="hl-0">detail</span><span class="hl-1">.</span><span class="hl-0">error</span><span class="hl-1">.</span><span class="hl-0">name</span><span class="hl-1"> === </span><span class="hl-3">&#39;LensExecutionError&#39;</span><span class="hl-1">) {</span><br/><span class="hl-1">    </span><span class="hl-7">// The currently-applied Lens encountered a problem that is most likely unrecoverable and the Lens has been removed.</span><br/><span class="hl-1">    </span><span class="hl-7">// Your application may want to do something to prevent this Lens from being applied again.</span><br/><span class="hl-1">  }</span><br/><span class="hl-1">});</span>
+</code><button>Copy</button></pre>
+<p>=======</p>
+<blockquote>
+<blockquote>
+<blockquote>
+<blockquote>
+<blockquote>
+<blockquote>
+<blockquote>
+<p>76e624ce ([CAMKIT-4384] README: error handling gets greater emphasis)</p>
+</blockquote>
+</blockquote>
+</blockquote>
+</blockquote>
+</blockquote>
+</blockquote>
+</blockquote>
 </div></div>
 <div class="col-sidebar">
 <div class="page-menu">
@@ -79,26 +195,49 @@ a <a href="https://developer.mozilla.org/en-US/docs/Web/API/MediaStream/MediaStr
 <li><a href="#md:snap-camera-kit-web-sdk"><span>Snap <wbr/>Camera <wbr/>Kit <wbr/>Web SDK</span></a></li>
 <li>
 <ul>
-<li><a href="#md:getting-started"><span>Getting started</span></a></li>
+<li><a href="#md:minimum-browser-requirements"><span>Minimum browser requirements</span></a></li>
+<li><a href="#md:prerequisites"><span>Prerequisites</span></a></li>
 <li>
 <ul>
+<li><a href="#md:snap-developer-set-up"><span>Snap <wbr/>Developer set up</span></a></li>
+<li><a href="#md:development-environment"><span>Development environment</span></a></li>
+<li>
+<ul>
+<li><a href="#md:using-the-sdk-in-a-javascript-project"><span>Using the SDK in a <wbr/>Java<wbr/>Script project</span></a></li></ul></li>
+<li><a href="#md:content-security-policy"><span>Content <wbr/>Security <wbr/>Policy</span></a></li></ul></li>
 <li><a href="#md:installing-the-sdk"><span>Installing the SDK</span></a></li>
-<li><a href="#md:using-the-sdk-in-a-javascript-project"><span>Using the SDK in a <wbr/>Javascript project</span></a></li>
-<li><a href="#md:importing-the-sdk"><span>Importing the SDK</span></a></li>
+<li>
+<ul>
+<li><a href="#md:importing-camera-kit"><span>Importing <wbr/>Camera <wbr/>Kit</span></a></li></ul></li>
 <li><a href="#md:bootstrapping-the-sdk"><span>Bootstrapping the SDK</span></a></li>
 <li><a href="#md:creating-a-camerakitsession"><span>Creating a <wbr/>Camera<wbr/>Kit<wbr/>Session</span></a></li>
-<li><a href="#md:obtaining-a-media-source"><span>Obtaining a media source</span></a></li>
-<li><a href="#md:applying-a-lens"><span>Applying a <wbr/>Lens</span></a></li>
-<li><a href="#md:setting-the-render-size"><span>Setting the render size</span></a></li>
-<li><a href="#md:session-playback"><span>Session playback</span></a></li>
+<li><a href="#md:creating-a-camerakitsource"><span>Creating a <wbr/>Camera<wbr/>Kit<wbr/>Source</span></a></li>
+<li><a href="#md:loading-applying-and-removing-lenses"><span>Loading, applying, and removing <wbr/>Lenses</span></a></li>
+<li>
+<ul>
+<li><a href="#md:removing-the-lens"><span>Removing the <wbr/>Lens</span></a></li></ul></li>
+<li><a href="#md:playback"><span>Playback</span></a></li>
+<li>
+<ul>
+<li><a href="#md:playing-and-pausing-the-different-rendertargets"><span>Playing and pausing the different <wbr/>Render<wbr/>Targets</span></a></li></ul></li>
+<li><a href="#md:error-handling"><span>Error <wbr/>Handling</span></a></li>
 <li><a href="#md:putting-it-all-together"><span>Putting it all together</span></a></li>
-<li><a href="#md:content-security-policy"><span>Content <wbr/>Security <wbr/>Policy</span></a></li>
+<li><a href="#md:advanced-use-cases"><span>Advanced use cases</span></a></li>
+<li>
+<ul>
+<li><a href="#md:logging"><span>Logging</span></a></li>
+<li><a href="#md:keyboard-support-for-lenses"><span>Keyboard support for <wbr/>Lenses</span></a></li>
+<li><a href="#md:customizing-camerakitsource"><span>Customizing <wbr/>Camera<wbr/>Kit<wbr/>Source</span></a></li>
 <li>
 <ul>
-<li><a href="#md:connect-src"><span>connect-<wbr/>src</span></a></li>
-<li><a href="#md:script-src"><span>script-<wbr/>src</span></a></li></ul></li></ul></li></ul></li></ul></li></ul></div></details></div>
+<li><a href="#md:setting-the-render-size"><span>Setting the render size</span></a></li>
+<li><a href="#md:camera-type"><span>Camera type</span></a></li>
+<li><a href="#md:fps-limit"><span>FPS limit</span></a></li>
+<li><a href="#md:2d-transforms"><span>2<wbr/>D transforms</span></a></li></ul></li>
+<li><a href="#md:metrics-reporting"><span>Metrics reporting</span></a></li>
+<li><a href="#md:error-handling-1"><span>Error <wbr/>Handling</span></a></li></ul></li></ul></li></ul></li></ul></div></details></div>
 <div class="site-menu">
-<nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>Camera<wbr/>Kit <wbr/>Web SDK -<wbr/> v0.11.0-<wbr/>alpha.1</span></a>
+<nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>Camera<wbr/>Kit <wbr/>Web SDK -<wbr/> v0.13.0-<wbr/>alpha.1</span></a>
 <ul class="tsd-small-nested-navigation">
 <li><a href="classes/CameraKit.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>Camera<wbr/>Kit</span></a></li>
 <li><a href="classes/TypedCustomEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Typed<wbr/>Custom<wbr/>Event</span></a></li>
@@ -114,7 +253,9 @@ a <a href="https://developer.mozilla.org/en-US/docs/Web/API/MediaStream/MediaStr
 <li><a href="interfaces/EstimatedLensPerformance.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Estimated<wbr/>Lens<wbr/>Performance</span></a></li>
 <li><a href="interfaces/CameraKitBootstrapConfiguration.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Camera<wbr/>Kit<wbr/>Bootstrap<wbr/>Configuration</span></a></li>
 <li><a href="interfaces/LensSource.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Lens<wbr/>Source</span></a></li>
-<li><a href="interfaces/UriHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Uri<wbr/>Handler</span></a></li>
+<li><a href="interfaces/RemoteApiRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Remote<wbr/>Api<wbr/>Request</span></a></li>
+<li><a href="interfaces/RemoteApiResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Remote<wbr/>Api<wbr/>Response</span></a></li>
+<li><a href="interfaces/RemoteApiService.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Remote<wbr/>Api<wbr/>Service</span></a></li>
 <li><a href="interfaces/UriRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Uri<wbr/>Request</span></a></li>
 <li><a href="interfaces/UriResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Uri<wbr/>Response</span></a></li>
 <li><a href="interfaces/UriCancelRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Uri<wbr/>Cancel<wbr/>Request</span></a></li>
@@ -128,12 +269,15 @@ a <a href="https://developer.mozilla.org/en-US/docs/Web/API/MediaStream/MediaStr
 <li><a href="types/LensMetricsEvents.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4194304"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g></svg><span>Lens<wbr/>Metrics<wbr/>Events</span></a></li>
 <li><a href="types/LensPerformanceCluster.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Lens<wbr/>Performance<wbr/>Cluster</span></a></li>
 <li><a href="types/PublicContainer.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Public<wbr/>Container</span></a></li>
-<li><a href="types/UriHandlers.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Uri<wbr/>Handlers</span></a></li>
+<li><a href="types/RemoteApiStatus.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Remote<wbr/>Api<wbr/>Status</span></a></li>
+<li><a href="types/RemoteApiRequestHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Remote<wbr/>Api<wbr/>Request<wbr/>Handler</span></a></li>
+<li><a href="types/RemoteApiServices.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Remote<wbr/>Api<wbr/>Services</span></a></li>
 <li><a href="types/Uri.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Uri</span></a></li>
 <li><a href="types/LensLaunchParams.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Lens<wbr/>Launch<wbr/>Params</span></a></li>
 <li><a href="types/AssetTiming.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Asset<wbr/>Timing</span></a></li>
 <li><a href="types/AssetLoader.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Asset<wbr/>Loader</span></a></li>
-<li><a href="types/CameraKitDeviceInfo.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Camera<wbr/>Kit<wbr/>Device<wbr/>Info</span></a></li>
+<li><a href="types/CameraKitDeviceInfo.html" class="deprecated"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Camera<wbr/>Kit<wbr/>Device<wbr/>Info</span></a></li>
+<li><a href="types/CameraKitDeviceOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Camera<wbr/>Kit<wbr/>Device<wbr/>Options</span></a></li>
 <li><a href="types/CameraKitSourceInfo.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Camera<wbr/>Kit<wbr/>Source<wbr/>Info</span></a></li>
 <li><a href="types/CameraKitSourceOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Camera<wbr/>Kit<wbr/>Source<wbr/>Options</span></a></li>
 <li><a href="types/LensView.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Lens<wbr/>View</span></a></li>
@@ -163,7 +307,7 @@ a <a href="https://developer.mozilla.org/en-US/docs/Web/API/MediaStream/MediaStr
 <li><a href="functions/createExtension.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>create<wbr/>Extension</span></a></li>
 <li><a href="functions/Injectable.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>Injectable</span></a></li>
 <li><a href="functions/lensSourcesFactory.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>lens<wbr/>Sources<wbr/>Factory</span></a></li>
-<li><a href="functions/uriHandlersFactory.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>uri<wbr/>Handlers<wbr/>Factory</span></a></li>
+<li><a href="functions/remoteApiServicesFactory.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>remote<wbr/>Api<wbr/>Services<wbr/>Factory</span></a></li>
 <li><a href="functions/getRequiredBootstrapURLs.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>get<wbr/>Required<wbr/>BootstrapURLs</span></a></li>
 <li><a href="functions/createImageSource.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>create<wbr/>Image<wbr/>Source</span></a></li>
 <li><a href="functions/createUserMediaSource.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>create<wbr/>User<wbr/>Media<wbr/>Source</span></a></li>