@snap/camera-kit
Version:
Camera Kit Web
17 lines (15 loc) • 10.1 kB
HTML
<html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>createExtension | CameraKit Web SDK - v1.17.0</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/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><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"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><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 - v1.17.0</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"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">CameraKit Web SDK</a></li><li><a href="createExtension.html">createExtension</a></li></ul><h1>Function createExtension</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createextension" class="tsd-anchor"></a><span class="tsd-kind-call-signature">createExtension</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PartialContainer</span><a href="#createextension" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Extensions offer a way to provide custom implementations of certain parts of the CameraKit SDK.</p>
<p>This enables more advanced use-cases, in which the default behavior of the SDK is substantially altered. For example,
replacing the default implementation that loads remote lens assets with a custom implementation that returns
different assets based on some business logic within the application.</p>
<p>An extension is implemented as a PartialContainer – a collection of factory functions, each with its own
dependencies, which each provide some "Service". A Service can be of any type, and the CameraKit SDK defines its
own Services, some of which can be overridden by providing a custom implementation of the type via an extension.</p>
<p>Here's an example of how extensions might be used:</p>
<pre><code class="ts"><span class="hl-2">import</span><span class="hl-1"> { </span><span class="hl-0">bootstrapCameraKit</span><span class="hl-1">, </span><span class="hl-0">createExtension</span><span class="hl-1">, </span><span class="hl-0">remoteMediaAssetLoaderFactory</span><span class="hl-1"> } </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">'@snap/camera-kit'</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">myCustomRemoteAssetLoader</span><span class="hl-1"> = </span><span class="hl-5">Injectable</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-0">remoteMediaAssetLoaderFactory</span><span class="hl-1">.</span><span class="hl-0">token</span><span class="hl-1">,</span><br/><span class="hl-1"> [</span><span class="hl-0">remoteMediaAssetLoaderFactory</span><span class="hl-1">.</span><span class="hl-0">token</span><span class="hl-1">] </span><span class="hl-2">as</span><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1">,</span><br/><span class="hl-1"> (</span><span class="hl-0">defaultLoader</span><span class="hl-1">: </span><span class="hl-12">AssetLoader</span><span class="hl-1">): </span><span class="hl-12">AssetLoader</span><span class="hl-1"> </span><span class="hl-4">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">return</span><span class="hl-1"> </span><span class="hl-4">async</span><span class="hl-1"> (</span><span class="hl-0">asset</span><span class="hl-1">, </span><span class="hl-0">lens</span><span class="hl-1">) </span><span class="hl-4">=></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">lens</span><span class="hl-1">?.</span><span class="hl-0">id</span><span class="hl-1"> === </span><span class="hl-6">MY_SPECIAL_LENS</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-2">return</span><span class="hl-1"> (</span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-5">fetch</span><span class="hl-1">(</span><span class="hl-3">'my/asset.glb'</span><span class="hl-1">)).</span><span class="hl-5">arrayBuffer</span><span class="hl-1">()</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> </span><span class="hl-2">return</span><span class="hl-1"> </span><span class="hl-5">defaultLoader</span><span class="hl-1">(</span><span class="hl-0">asset</span><span class="hl-1">, </span><span class="hl-0">lens</span><span class="hl-1">)</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> },</span><br/><span class="hl-1">)</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">myExtension</span><span class="hl-1"> = </span><span class="hl-5">createExtension</span><span class="hl-1">().</span><span class="hl-5">provides</span><span class="hl-1">(</span><span class="hl-0">myCustomRemoteAssetLoader</span><span class="hl-1">);</span><br/><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-5">bootstrapCameraKit</span><span class="hl-1">(</span><span class="hl-0">config</span><span class="hl-1">, </span><span class="hl-0">container</span><span class="hl-1"> </span><span class="hl-4">=></span><span class="hl-1"> </span><span class="hl-0">container</span><span class="hl-1">.</span><span class="hl-5">provides</span><span class="hl-1">(</span><span class="hl-0">myExtension</span><span class="hl-1">));</span>
</code><button type="button">Copy</button></pre>
<p>This also enables greater modularity – the person/team creating the extension can do so in their own package, which
could be shared by many applications that all require the same functionality.</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PartialContainer</span></h4><p>A PartialContainer which can be used to create a collection of Services, and can later be provided
to CameraKit's DI container during <a href="bootstrapCameraKit.html" class="tsd-kind-function">bootstrapCameraKit</a>.</p>
<div class="tsd-comment tsd-typography"></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">CameraKit Web SDK - v1.17.0</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>