@snap/camera-kit 0.10.0 → 0.11.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.
- package/docs/html/assets/search.js +1 -1
- package/docs/html/classes/CameraKit.html +116 -100
- package/docs/html/classes/CameraKitSession.html +175 -153
- package/docs/html/classes/CameraKitSource.html +109 -101
- package/docs/html/classes/LensPerformanceMeasurement.html +98 -94
- package/docs/html/classes/LensPerformanceMetrics.html +83 -81
- package/docs/html/classes/LensRepository.html +120 -109
- package/docs/html/classes/LensSources.html +86 -82
- package/docs/html/classes/Transform2D.html +98 -94
- package/docs/html/classes/TypedCustomEvent.html +83 -82
- package/docs/html/classes/TypedEventTarget.html +92 -91
- package/docs/html/functions/Injectable.html +87 -80
- package/docs/html/functions/bootstrapCameraKit.html +89 -86
- package/docs/html/functions/createExtension.html +76 -75
- package/docs/html/functions/createImageSource.html +80 -77
- package/docs/html/functions/createMediaStreamSource.html +80 -77
- package/docs/html/functions/createUserMediaSource.html +84 -81
- package/docs/html/functions/createVideoSource.html +80 -77
- package/docs/html/functions/estimateLensPerformance.html +76 -75
- package/docs/html/functions/getRequiredBootstrapURLs.html +78 -76
- package/docs/html/functions/lensSourcesFactory.html +74 -74
- package/docs/html/functions/uriHandlersFactory.html +76 -75
- package/docs/html/index.html +75 -75
- package/docs/html/interfaces/CameraKitBootstrapConfiguration.html +107 -100
- package/docs/html/interfaces/CameraKitSourceSubscriber.html +82 -81
- package/docs/html/interfaces/ComputedFrameMetrics.html +94 -84
- package/docs/html/interfaces/CreateSessionOptions.html +86 -83
- package/docs/html/interfaces/EstimatedLensPerformance.html +85 -84
- package/docs/html/interfaces/Lens.html +114 -106
- package/docs/html/interfaces/LensSource.html +102 -94
- package/docs/html/interfaces/MediaStreamSourceOptions.html +80 -80
- package/docs/html/interfaces/Preview.html +81 -79
- package/docs/html/interfaces/Snapcode.html +86 -83
- package/docs/html/interfaces/UriCancelRequest.html +80 -80
- package/docs/html/interfaces/UriHandler.html +102 -93
- package/docs/html/interfaces/UriRequest.html +89 -89
- package/docs/html/interfaces/UriResponse.html +89 -89
- package/docs/html/interfaces/VideoSourceOptions.html +77 -77
- package/docs/html/modules.html +153 -153
- package/docs/html/types/AssetLoader.html +75 -74
- package/docs/html/types/AssetTiming.html +75 -74
- package/docs/html/types/BenchmarkError.html +73 -73
- package/docs/html/types/BootstrapError.html +75 -74
- package/docs/html/types/CacheKeyNotFoundError.html +73 -73
- package/docs/html/types/CameraKitDeviceInfo.html +75 -74
- package/docs/html/types/CameraKitSessionEventListener.html +75 -74
- package/docs/html/types/CameraKitSessionEvents.html +82 -74
- package/docs/html/types/CameraKitSourceError.html +73 -73
- package/docs/html/types/CameraKitSourceInfo.html +73 -73
- package/docs/html/types/CameraKitSourceOptions.html +75 -74
- package/docs/html/types/ConfigurationError.html +75 -74
- package/docs/html/types/Keyboard.html +85 -80
- package/docs/html/types/KeyboardEvents.html +84 -74
- package/docs/html/types/LegalError.html +73 -73
- package/docs/html/types/LensAssetError.html +75 -74
- package/docs/html/types/LensContentValidationError.html +73 -73
- package/docs/html/types/LensError.html +73 -73
- package/docs/html/types/LensExecutionError.html +75 -74
- package/docs/html/types/LensImagePickerError.html +75 -74
- package/docs/html/types/LensLaunchParams.html +75 -74
- package/docs/html/types/LensMetricsEvents.html +75 -74
- package/docs/html/types/LensPerformanceCluster.html +75 -74
- package/docs/html/types/LensView.html +75 -74
- package/docs/html/types/LensWait.html +75 -74
- package/docs/html/types/PersistentStoreError.html +75 -74
- package/docs/html/types/PlatformNotSupportedError.html +75 -74
- package/docs/html/types/PublicContainer.html +75 -74
- package/docs/html/types/RenderTarget.html +75 -74
- package/docs/html/types/Uri.html +73 -73
- package/docs/html/types/UriHandlers.html +75 -74
- package/docs/html/types/WebGLError.html +73 -73
- package/docs/html/variables/extensionRequestContext.html +75 -74
- package/docs/md/classes/CameraKit.md +14 -1
- package/docs/md/classes/CameraKitSession.md +1 -1
- package/docs/md/classes/CameraKitSource.md +1 -1
- package/docs/md/classes/LensPerformanceMeasurement.md +1 -1
- package/docs/md/classes/LensPerformanceMetrics.md +1 -1
- package/docs/md/classes/LensRepository.md +1 -1
- package/docs/md/classes/LensSources.md +1 -1
- package/docs/md/classes/Transform2D.md +1 -1
- package/docs/md/classes/TypedCustomEvent.md +1 -1
- package/docs/md/classes/TypedEventTarget.md +1 -1
- package/docs/md/interfaces/CameraKitBootstrapConfiguration.md +1 -1
- package/docs/md/interfaces/CameraKitSourceSubscriber.md +1 -1
- package/docs/md/interfaces/ComputedFrameMetrics.md +15 -1
- package/docs/md/interfaces/CreateSessionOptions.md +1 -1
- package/docs/md/interfaces/EstimatedLensPerformance.md +1 -1
- package/docs/md/interfaces/Lens.md +1 -1
- package/docs/md/interfaces/LensSource.md +1 -1
- package/docs/md/interfaces/MediaStreamSourceOptions.md +1 -1
- package/docs/md/interfaces/Preview.md +1 -1
- package/docs/md/interfaces/Snapcode.md +1 -1
- package/docs/md/interfaces/UriCancelRequest.md +1 -1
- package/docs/md/interfaces/UriHandler.md +1 -1
- package/docs/md/interfaces/UriRequest.md +1 -1
- package/docs/md/interfaces/UriResponse.md +1 -1
- package/docs/md/interfaces/VideoSourceOptions.md +1 -1
- package/docs/md/modules.md +2 -2
- package/lib/CameraKit.d.ts +21 -12
- package/lib/CameraKit.js +32 -4
- package/lib/CameraKit.js.map +1 -1
- package/lib/bootstrapCameraKit.js +5 -3
- package/lib/bootstrapCameraKit.js.map +1 -1
- package/lib/common/__mocks__/loadScript.d.ts +1 -1
- package/lib/common/__mocks__/loadScript.js +1 -1
- package/lib/common/__mocks__/loadScript.js.map +1 -1
- package/lib/common/dialog.d.ts +16 -0
- package/lib/common/dialog.js +146 -0
- package/lib/common/dialog.js.map +1 -0
- package/lib/common/hash.d.ts +5 -0
- package/lib/common/hash.js +17 -0
- package/lib/common/hash.js.map +1 -0
- package/lib/common/loadScript.d.ts +6 -1
- package/lib/common/loadScript.js +9 -2
- package/lib/common/loadScript.js.map +1 -1
- package/lib/common/localization.d.ts +17 -10
- package/lib/common/localization.js +653 -18
- package/lib/common/localization.js.map +1 -1
- package/lib/common/pageVisibility.d.ts +34 -20
- package/lib/common/pageVisibility.js +57 -48
- package/lib/common/pageVisibility.js.map +1 -1
- package/lib/dependency-injection/Container.d.ts +2 -2
- package/lib/dependency-injection/Container.js +10 -10
- package/lib/dependency-injection/Container.js.map +1 -1
- package/lib/dependency-injection/RootServices.d.ts +3 -1
- package/lib/dependency-injection/RootServices.js.map +1 -1
- package/lib/environment.json +1 -1
- package/lib/extensions/LensSources.d.ts +5 -5
- package/lib/extensions/LensSources.js +9 -9
- package/lib/extensions/LensSources.js.map +1 -1
- package/lib/extensions/UriHandlers.d.ts +1 -1
- package/lib/generated-proto/pb_schema/camera_kit/v3/legal_prompt.d.ts +5 -0
- package/lib/generated-proto/pb_schema/camera_kit/v3/legal_prompt.js +61 -0
- package/lib/generated-proto/pb_schema/camera_kit/v3/legal_prompt.js.map +1 -1
- package/lib/generated-proto/pb_schema/camera_kit/v3/service.d.ts +49 -0
- package/lib/generated-proto/pb_schema/camera_kit/v3/service.js +17 -1
- package/lib/generated-proto/pb_schema/camera_kit/v3/service.js.map +1 -1
- package/lib/generated-proto/pb_schema/cdp/cof/circumstance_service.d.ts +578 -0
- package/lib/generated-proto/pb_schema/cdp/cof/config_response.d.ts +84 -0
- package/lib/generated-proto/pb_schema/cdp/cof/config_result.d.ts +222 -1
- package/lib/generated-proto/pb_schema/cdp/cof/config_result.js +98 -2
- package/lib/generated-proto/pb_schema/cdp/cof/config_result.js.map +1 -1
- package/lib/handlers/HandlerChainBuilder.js +7 -2
- package/lib/handlers/HandlerChainBuilder.js.map +1 -1
- package/lib/handlers/batchingHandler.d.ts +8 -2
- package/lib/handlers/batchingHandler.js +5 -8
- package/lib/handlers/batchingHandler.js.map +1 -1
- package/lib/handlers/mappingHandler.d.ts +5 -1
- package/lib/handlers/mappingHandler.js +6 -4
- package/lib/handlers/mappingHandler.js.map +1 -1
- package/lib/handlers/rateLimitingHandler.d.ts +5 -1
- package/lib/handlers/rateLimitingHandler.js +6 -4
- package/lib/handlers/rateLimitingHandler.js.map +1 -1
- package/lib/handlers/responseCachingHandler.d.ts +1 -1
- package/lib/handlers/responseCachingHandler.js.map +1 -1
- package/lib/handlers/retryingHandler.d.ts +5 -1
- package/lib/handlers/retryingHandler.js +13 -9
- package/lib/handlers/retryingHandler.js.map +1 -1
- package/lib/legal/legalPrompt.d.ts +7 -4
- package/lib/legal/legalPrompt.js +122 -133
- package/lib/legal/legalPrompt.js.map +1 -1
- package/lib/legal/legalState.d.ts +2 -2
- package/lib/legal/legalState.js +52 -38
- package/lib/legal/legalState.js.map +1 -1
- package/lib/lens-core-module/loader/lensCoreFactory.js +3 -1
- package/lib/lens-core-module/loader/lensCoreFactory.js.map +1 -1
- package/lib/lensCoreWasmVersions.json +3 -3
- package/lib/logger/logEntries.d.ts +1 -1
- package/lib/logger/logEntries.js +3 -3
- package/lib/logger/logEntries.js.map +1 -1
- package/lib/logger/logger.d.ts +7 -2
- package/lib/logger/logger.js +9 -4
- package/lib/logger/logger.js.map +1 -1
- package/lib/media-sources/MediaStreamSource.js +9 -4
- package/lib/media-sources/MediaStreamSource.js.map +1 -1
- package/lib/metrics/businessEventsReporter.d.ts +3 -2
- package/lib/metrics/businessEventsReporter.js +16 -9
- package/lib/metrics/businessEventsReporter.js.map +1 -1
- package/lib/metrics/metricsHandler.d.ts +3 -2
- package/lib/metrics/metricsHandler.js +3 -3
- package/lib/metrics/metricsHandler.js.map +1 -1
- package/lib/metrics/operational/Count.d.ts +17 -0
- package/lib/metrics/operational/Count.js +28 -0
- package/lib/metrics/operational/Count.js.map +1 -0
- package/lib/metrics/operational/Histogram.d.ts +17 -0
- package/lib/metrics/operational/Histogram.js +23 -0
- package/lib/metrics/operational/Histogram.js.map +1 -0
- package/lib/metrics/operational/Metric.d.ts +20 -0
- package/lib/metrics/operational/Metric.js +26 -0
- package/lib/metrics/operational/Metric.js.map +1 -0
- package/lib/metrics/operational/Timer.d.ts +91 -0
- package/lib/metrics/operational/Timer.js +122 -0
- package/lib/metrics/operational/Timer.js.map +1 -0
- package/lib/metrics/{operationalMetricsReporter.d.ts → operational/operationalMetricsReporter.d.ts} +15 -4
- package/lib/metrics/{operationalMetricsReporter.js → operational/operationalMetricsReporter.js} +24 -8
- package/lib/metrics/operational/operationalMetricsReporter.js.map +1 -0
- package/lib/metrics/reporters/reportBenchmarks.d.ts +1 -1
- package/lib/metrics/reporters/reportBenchmarks.js +1 -1
- package/lib/metrics/reporters/reportBenchmarks.js.map +1 -1
- package/lib/metrics/reporters/reportGlobalException.d.ts +1 -1
- package/lib/metrics/reporters/reportGlobalException.js +1 -1
- package/lib/metrics/reporters/reportGlobalException.js.map +1 -1
- package/lib/metrics/reporters/reportHttpMetrics.d.ts +1 -1
- package/lib/metrics/reporters/reportHttpMetrics.js +1 -1
- package/lib/metrics/reporters/reportHttpMetrics.js.map +1 -1
- package/lib/metrics/reporters/reportLegalState.d.ts +1 -1
- package/lib/metrics/reporters/reportLegalState.js +1 -1
- package/lib/metrics/reporters/reportLegalState.js.map +1 -1
- package/lib/metrics/reporters/reportLensAndAssetDownload.d.ts +1 -1
- package/lib/metrics/reporters/reportLensAndAssetDownload.js +1 -1
- package/lib/metrics/reporters/reportLensAndAssetDownload.js.map +1 -1
- package/lib/metrics/reporters/reportLensValidationFailed.d.ts +1 -1
- package/lib/metrics/reporters/reportLensView.d.ts +2 -2
- package/lib/metrics/reporters/reportLensView.js +23 -17
- package/lib/metrics/reporters/reportLensView.js.map +1 -1
- package/lib/metrics/reporters/reportLensWait.d.ts +2 -2
- package/lib/metrics/reporters/reportLensWait.js +1 -1
- package/lib/metrics/reporters/reportLensWait.js.map +1 -1
- package/lib/metrics/reporters/reportSessionException.d.ts +1 -1
- package/lib/metrics/reporters/reporters.d.ts +6 -6
- package/lib/metrics/reporters/reporters.js +3 -3
- package/lib/metrics/reporters/reporters.js.map +1 -1
- package/lib/observable-operators/unsubscribed.d.ts +12 -0
- package/lib/observable-operators/unsubscribed.js +27 -0
- package/lib/observable-operators/unsubscribed.js.map +1 -0
- package/lib/remote-configuration/cofHandler.d.ts +1 -1
- package/lib/remote-configuration/cofHandler.js.map +1 -1
- package/lib/remote-configuration/remoteConfiguration.d.ts +15 -4
- package/lib/remote-configuration/remoteConfiguration.js +30 -5
- package/lib/remote-configuration/remoteConfiguration.js.map +1 -1
- package/lib/session/CameraKitSession.d.ts +4 -3
- package/lib/session/CameraKitSession.js +6 -5
- package/lib/session/CameraKitSession.js.map +1 -1
- package/lib/session/LensKeyboard.d.ts +1 -1
- package/lib/session/LensPerformanceMeasurement.d.ts +2 -0
- package/lib/session/LensPerformanceMeasurement.js +27 -4
- package/lib/session/LensPerformanceMeasurement.js.map +1 -1
- package/lib/session/lensState.d.ts +5 -4
- package/lib/session/lensState.js +94 -39
- package/lib/session/lensState.js.map +1 -1
- package/package.json +12 -12
- package/lib/metrics/operationalMetricsReporter.js.map +0 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CameraKitSession | CameraKit Web SDK - v0.
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CameraKitSession | 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">
|
|
2
2
|
<div class="tsd-toolbar-contents container">
|
|
3
3
|
<div class="table-cell" id="tsd-search" data-base="..">
|
|
4
4
|
<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,7 +6,7 @@
|
|
|
6
6
|
<div id="tsd-toolbar-links"></div></div>
|
|
7
7
|
<ul class="results">
|
|
8
8
|
<li class="state loading">Preparing search index...</li>
|
|
9
|
-
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">CameraKit Web SDK - v0.
|
|
9
|
+
<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>
|
|
10
10
|
<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>
|
|
11
11
|
<div class="container container-main">
|
|
12
12
|
<div class="col-content">
|
|
@@ -21,8 +21,9 @@ elements. When a Lens is applied to the session, CameraKit uses the Lens to tran
|
|
|
21
21
|
output.</p>
|
|
22
22
|
<p>CameraKitSession is the primary object that applications interact with when integrating the CameraKit SDK.</p>
|
|
23
23
|
<p>A CameraKitSession instance is obtained by calling <a href="CameraKit.html#createSession" class="tsd-kind-method">createSession</a>.</p>
|
|
24
|
-
|
|
25
|
-
<
|
|
24
|
+
</div>
|
|
25
|
+
<div class="tsd-comment tsd-typography">
|
|
26
|
+
<h4>Example</h4><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><span class="hl-0">config</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>
|
|
26
27
|
</code><button>Copy</button></pre>
|
|
27
28
|
</div></section>
|
|
28
29
|
<section class="tsd-panel tsd-hierarchy">
|
|
@@ -36,28 +37,28 @@ output.</p>
|
|
|
36
37
|
<div class="tsd-accordion-details">
|
|
37
38
|
<section class="tsd-index-section">
|
|
38
39
|
<h3 class="tsd-index-heading">Properties</h3>
|
|
39
|
-
<div class="tsd-index-list"><a href="CameraKitSession.html#output" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
40
|
-
<a href="CameraKitSession.html#playing" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
41
|
-
<a href="CameraKitSession.html#events" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
42
|
-
<a href="CameraKitSession.html#metrics" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
43
|
-
<a href="CameraKitSession.html#keyboard" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
40
|
+
<div class="tsd-index-list"><a href="CameraKitSession.html#output" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-1024"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g></svg><span>output</span></a>
|
|
41
|
+
<a href="CameraKitSession.html#playing" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>playing</span></a>
|
|
42
|
+
<a href="CameraKitSession.html#events" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>events</span></a>
|
|
43
|
+
<a href="CameraKitSession.html#metrics" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>metrics</span></a>
|
|
44
|
+
<a href="CameraKitSession.html#keyboard" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>keyboard</span></a>
|
|
44
45
|
</div></section>
|
|
45
46
|
<section class="tsd-index-section">
|
|
46
47
|
<h3 class="tsd-index-heading">Methods</h3>
|
|
47
|
-
<div class="tsd-index-list"><a href="CameraKitSession.html#applyLens" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
48
|
-
<a href="CameraKitSession.html#removeLens" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
49
|
-
<a href="CameraKitSession.html#play" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
50
|
-
<a href="CameraKitSession.html#pause" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
51
|
-
<a href="CameraKitSession.html#mute" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
52
|
-
<a href="CameraKitSession.html#unmute" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
53
|
-
<a href="CameraKitSession.html#setSource" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
54
|
-
<a href="CameraKitSession.html#setFPSLimit" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
55
|
-
<a href="CameraKitSession.html#destroy" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
48
|
+
<div class="tsd-index-list"><a href="CameraKitSession.html#applyLens" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-2048"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)"></path></g></svg><span>apply<wbr/>Lens</span></a>
|
|
49
|
+
<a href="CameraKitSession.html#removeLens" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>remove<wbr/>Lens</span></a>
|
|
50
|
+
<a href="CameraKitSession.html#play" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>play</span></a>
|
|
51
|
+
<a href="CameraKitSession.html#pause" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>pause</span></a>
|
|
52
|
+
<a href="CameraKitSession.html#mute" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>mute</span></a>
|
|
53
|
+
<a href="CameraKitSession.html#unmute" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>unmute</span></a>
|
|
54
|
+
<a href="CameraKitSession.html#setSource" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Source</span></a>
|
|
55
|
+
<a href="CameraKitSession.html#setFPSLimit" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>setFPSLimit</span></a>
|
|
56
|
+
<a href="CameraKitSession.html#destroy" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>destroy</span></a>
|
|
56
57
|
</div></section></div></details></section></section>
|
|
57
58
|
<section class="tsd-panel-group tsd-member-group">
|
|
58
59
|
<h2>Properties</h2>
|
|
59
60
|
<section class="tsd-panel tsd-member"><a id="output" class="tsd-anchor"></a>
|
|
60
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>output</span><a href="#output" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
61
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>output</span><a href="#output" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3>
|
|
61
62
|
<div class="tsd-signature"><span class="tsd-kind-property">output</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">live</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">HTMLCanvasElement</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">capture</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">HTMLCanvasElement</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
|
|
62
63
|
<div class="tsd-comment tsd-typography"><p>CameraKitSession renders video output to a <code><canvas></code> element. In fact, each session contains two canvas outputs
|
|
63
64
|
corresponding to the RenderTargets used by Lens creators, when using LensStudio to create a Lens.</p>
|
|
@@ -73,40 +74,45 @@ use-case.</p>
|
|
|
73
74
|
<li class="tsd-parameter">
|
|
74
75
|
<h5><span class="tsd-kind-property">live</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">HTMLCanvasElement</span></h5></li>
|
|
75
76
|
<li class="tsd-parameter">
|
|
76
|
-
<h5><span class="tsd-kind-property">capture</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">HTMLCanvasElement</span></h5></li></ul></div
|
|
77
|
+
<h5><span class="tsd-kind-property">capture</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">HTMLCanvasElement</span></h5></li></ul></div>
|
|
78
|
+
<div class="tsd-comment tsd-typography"></div></section>
|
|
77
79
|
<section class="tsd-panel tsd-member"><a id="playing" class="tsd-anchor"></a>
|
|
78
|
-
<h3 class="tsd-anchor-link"><span>playing</span><a href="#playing" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
80
|
+
<h3 class="tsd-anchor-link"><span>playing</span><a href="#playing" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
79
81
|
<div class="tsd-signature"><span class="tsd-kind-property">playing</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><a href="../types/RenderTarget.html" class="tsd-signature-type tsd-kind-type-alias">RenderTarget</a></div>
|
|
80
82
|
<div class="tsd-comment tsd-typography"><p>Indicates whether or not the session is currently rendering. If <code>false</code>, rendering is stopped. Otherwise the
|
|
81
83
|
value indicates which output is being rendered.</p>
|
|
82
|
-
</div
|
|
84
|
+
</div>
|
|
85
|
+
<div class="tsd-comment tsd-typography"></div></section>
|
|
83
86
|
<section class="tsd-panel tsd-member"><a id="events" class="tsd-anchor"></a>
|
|
84
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>events</span><a href="#events" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
87
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>events</span><a href="#events" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
85
88
|
<div class="tsd-signature"><span class="tsd-kind-property">events</span><span class="tsd-signature-symbol">:</span> <a href="TypedEventTarget.html" class="tsd-signature-type tsd-kind-class">TypedEventTarget</a><span class="tsd-signature-symbol"><</span><a href="../types/CameraKitSessionEvents.html" class="tsd-signature-type tsd-kind-type-alias">CameraKitSessionEvents</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></div>
|
|
86
89
|
<div class="tsd-comment tsd-typography"><p>Add event listeners here to handle events which occur during the CameraKitSession.</p>
|
|
87
90
|
<p><strong>Note:</strong> Applications may want to handle the <code>error</code> event, and check the contained error type -- if the type
|
|
88
91
|
is <a href="../types/LensExecutionError.html" class="tsd-kind-type-alias">LensExecutionError</a>, this means the current lens was unable to render and CameraKit will automatically
|
|
89
92
|
remove the lens.</p>
|
|
90
|
-
|
|
91
|
-
<
|
|
93
|
+
</div>
|
|
94
|
+
<div class="tsd-comment tsd-typography">
|
|
95
|
+
<h4>Example</h4><pre><code class="language-ts"><span class="hl-0">cameraKitSession</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">'error'</span><span class="hl-1">, ({ </span><span class="hl-0">detail</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">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">'LensExecutionError'</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">`Lens </span><span class="hl-4">${</span><span class="hl-0">detail</span><span class="hl-9">.</span><span class="hl-0">lens</span><span class="hl-9">.</span><span class="hl-0">name</span><span class="hl-4">}</span><span class="hl-3"> encountered an error and was removed. Please pick a different lens.`</span><span class="hl-1">)</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">})</span>
|
|
92
96
|
</code><button>Copy</button></pre>
|
|
93
97
|
</div></section>
|
|
94
98
|
<section class="tsd-panel tsd-member"><a id="metrics" class="tsd-anchor"></a>
|
|
95
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>metrics</span><a href="#metrics" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
99
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>metrics</span><a href="#metrics" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
96
100
|
<div class="tsd-signature"><span class="tsd-kind-property">metrics</span><span class="tsd-signature-symbol">:</span> <a href="LensPerformanceMetrics.html" class="tsd-signature-type tsd-kind-class">LensPerformanceMetrics</a></div>
|
|
97
101
|
<div class="tsd-comment tsd-typography"><p>Use this to measure current lens performance.</p>
|
|
98
|
-
</div
|
|
102
|
+
</div>
|
|
103
|
+
<div class="tsd-comment tsd-typography"></div></section>
|
|
99
104
|
<section class="tsd-panel tsd-member"><a id="keyboard" class="tsd-anchor"></a>
|
|
100
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>keyboard</span><a href="#keyboard" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
105
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>keyboard</span><a href="#keyboard" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
101
106
|
<div class="tsd-signature"><span class="tsd-kind-property">keyboard</span><span class="tsd-signature-symbol">:</span> <a href="../types/Keyboard.html" class="tsd-signature-type tsd-kind-type-alias">Keyboard</a></div>
|
|
102
107
|
<div class="tsd-comment tsd-typography"><p>Use this to interact with lenses which require text input.</p>
|
|
103
|
-
</div
|
|
108
|
+
</div>
|
|
109
|
+
<div class="tsd-comment tsd-typography"></div></section></section>
|
|
104
110
|
<section class="tsd-panel-group tsd-member-group">
|
|
105
111
|
<h2>Methods</h2>
|
|
106
112
|
<section class="tsd-panel tsd-member"><a id="applyLens" class="tsd-anchor"></a>
|
|
107
|
-
<h3 class="tsd-anchor-link"><span>apply<wbr/>Lens</span><a href="#applyLens" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
113
|
+
<h3 class="tsd-anchor-link"><span>apply<wbr/>Lens</span><a href="#applyLens" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
108
114
|
<ul class="tsd-signatures">
|
|
109
|
-
<li class="tsd-signature tsd-anchor-link" id="applyLens.applyLens-1"><span class="tsd-kind-call-signature">apply<wbr/>Lens</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">lens</span>, <span class="tsd-kind-parameter">launchParams</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#applyLens.applyLens-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
115
|
+
<li class="tsd-signature tsd-anchor-link" id="applyLens.applyLens-1"><span class="tsd-kind-call-signature">apply<wbr/>Lens</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">lens</span>, <span class="tsd-kind-parameter">launchParams</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#applyLens.applyLens-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
110
116
|
<li class="tsd-description">
|
|
111
117
|
<div class="tsd-comment tsd-typography"><p>Apply a Lens to this session.</p>
|
|
112
118
|
<p>This method will download (and cache) the Lens executable, and then use that Lens for rendering. If the session
|
|
@@ -126,7 +132,8 @@ prevent the Lens from being selected again by the user.</p>
|
|
|
126
132
|
<li>
|
|
127
133
|
<h5><span class="tsd-kind-parameter">lens</span>: <a href="../interfaces/Lens.html" class="tsd-signature-type tsd-kind-interface">Lens</a></h5>
|
|
128
134
|
<div class="tsd-comment tsd-typography"><p>The Lens to apply to this session.</p>
|
|
129
|
-
</div
|
|
135
|
+
</div>
|
|
136
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
130
137
|
<li>
|
|
131
138
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">launchParams</span>: <a href="../types/LensLaunchParams.html" class="tsd-signature-type tsd-kind-type-alias">LensLaunchParams</a></h5></li></ul></div>
|
|
132
139
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><p>A promise which can have the following results:</p>
|
|
@@ -142,11 +149,12 @@ method)</li>
|
|
|
142
149
|
<li>Lens content download fails, or the download of any required lens assets fails.</li>
|
|
143
150
|
<li>An internal failure occurs in the Lens rendering engine when attempting to apply the lens.</li>
|
|
144
151
|
</ul>
|
|
145
|
-
|
|
152
|
+
|
|
153
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
146
154
|
<section class="tsd-panel tsd-member"><a id="removeLens" class="tsd-anchor"></a>
|
|
147
|
-
<h3 class="tsd-anchor-link"><span>remove<wbr/>Lens</span><a href="#removeLens" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
155
|
+
<h3 class="tsd-anchor-link"><span>remove<wbr/>Lens</span><a href="#removeLens" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
148
156
|
<ul class="tsd-signatures">
|
|
149
|
-
<li class="tsd-signature tsd-anchor-link" id="removeLens.removeLens-1"><span class="tsd-kind-call-signature">remove<wbr/>Lens</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#removeLens.removeLens-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
157
|
+
<li class="tsd-signature tsd-anchor-link" id="removeLens.removeLens-1"><span class="tsd-kind-call-signature">remove<wbr/>Lens</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#removeLens.removeLens-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
150
158
|
<li class="tsd-description">
|
|
151
159
|
<div class="tsd-comment tsd-typography"><p>Remove a Lens from this session.</p>
|
|
152
160
|
<p>When a Lens is removed, rendering continues if the session is playing. It will just render the session input
|
|
@@ -160,18 +168,16 @@ session's rendered output will still have a (new) lens applied.</li>
|
|
|
160
168
|
<li>Rejected: the lens has failed to be removed. This can happen if an internal failure occurs in the Lens
|
|
161
169
|
rendering engine when attempting to remove the lens.</li>
|
|
162
170
|
</ol>
|
|
163
|
-
|
|
171
|
+
|
|
172
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
164
173
|
<section class="tsd-panel tsd-member"><a id="play" class="tsd-anchor"></a>
|
|
165
|
-
<h3 class="tsd-anchor-link"><span>play</span><a href="#play" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
174
|
+
<h3 class="tsd-anchor-link"><span>play</span><a href="#play" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
166
175
|
<ul class="tsd-signatures">
|
|
167
|
-
<li class="tsd-signature tsd-anchor-link" id="play.play-1"><span class="tsd-kind-call-signature">play</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#play.play-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
176
|
+
<li class="tsd-signature tsd-anchor-link" id="play.play-1"><span class="tsd-kind-call-signature">play</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#play.play-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
168
177
|
<li class="tsd-description">
|
|
169
178
|
<div class="tsd-comment tsd-typography"><p>Start/resume session playback – LensCore will begin rendering frames to the output.</p>
|
|
170
179
|
<p>If no source has been set for the session, calling <code>play()</code> will update the playing state, but no actual image
|
|
171
180
|
processing will occur until <code>setSource()</code> is called.</p>
|
|
172
|
-
|
|
173
|
-
<h3>Example</h3><pre><code class="language-ts"><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">cameraKitSession</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-2">await</span><span class="hl-1"> </span><span class="hl-0">cameraKitSession</span><span class="hl-1">.</span><span class="hl-5">setSource</span><span class="hl-1">(</span><span class="hl-0">mySource</span><span class="hl-1">)</span><br/><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">cameraKitSession</span><span class="hl-1">.</span><span class="hl-5">play</span><span class="hl-1">()</span><br/><br/><span class="hl-7">// If you call `play` before `setSource`, the call to `play` will resolve but playback will only begin once a</span><br/><span class="hl-7">// media source has been set.</span>
|
|
174
|
-
</code><button>Copy</button></pre>
|
|
175
181
|
</div>
|
|
176
182
|
<div class="tsd-parameters">
|
|
177
183
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -179,14 +185,19 @@ processing will occur until <code>setSource()</code> is called.</p>
|
|
|
179
185
|
<li>
|
|
180
186
|
<h5><span class="tsd-kind-parameter">target</span>: <a href="../types/RenderTarget.html" class="tsd-signature-type tsd-kind-type-alias">RenderTarget</a><span class="tsd-signature-symbol"> = "live"</span></h5>
|
|
181
187
|
<div class="tsd-comment tsd-typography"><p>Specify the <a href="../types/RenderTarget.html" class="tsd-kind-type-alias">RenderTarget</a> to render. Defaults to the <code>live</code> RenderTarget.</p>
|
|
182
|
-
</div
|
|
188
|
+
</div>
|
|
189
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
183
190
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>Promise resolves when playback state has been updated. If no source has been set, this means <code>play</code> will
|
|
184
191
|
resolve before any frames are processed -- but once a source is set, frames will immediately begin processing.</p>
|
|
185
|
-
|
|
192
|
+
|
|
193
|
+
<div class="tsd-comment tsd-typography">
|
|
194
|
+
<h4>Example</h4><pre><code class="language-ts"><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">cameraKitSession</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-2">await</span><span class="hl-1"> </span><span class="hl-0">cameraKitSession</span><span class="hl-1">.</span><span class="hl-5">setSource</span><span class="hl-1">(</span><span class="hl-0">mySource</span><span class="hl-1">)</span><br/><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">cameraKitSession</span><span class="hl-1">.</span><span class="hl-5">play</span><span class="hl-1">()</span><br/><br/><span class="hl-7">// If you call `play` before `setSource`, the call to `play` will resolve but playback will only begin once a</span><br/><span class="hl-7">// media source has been set.</span>
|
|
195
|
+
</code><button>Copy</button></pre>
|
|
196
|
+
</div></li></ul></section>
|
|
186
197
|
<section class="tsd-panel tsd-member"><a id="pause" class="tsd-anchor"></a>
|
|
187
|
-
<h3 class="tsd-anchor-link"><span>pause</span><a href="#pause" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
198
|
+
<h3 class="tsd-anchor-link"><span>pause</span><a href="#pause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
188
199
|
<ul class="tsd-signatures">
|
|
189
|
-
<li class="tsd-signature tsd-anchor-link" id="pause.pause-1"><span class="tsd-kind-call-signature">pause</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#pause.pause-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
200
|
+
<li class="tsd-signature tsd-anchor-link" id="pause.pause-1"><span class="tsd-kind-call-signature">pause</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#pause.pause-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
190
201
|
<li class="tsd-description">
|
|
191
202
|
<div class="tsd-comment tsd-typography"><p>Pause session playback – LensCore will stop rendering frames to the output.</p>
|
|
192
203
|
</div>
|
|
@@ -197,13 +208,15 @@ resolve before any frames are processed -- but once a source is set, frames will
|
|
|
197
208
|
<h5><span class="tsd-kind-parameter">target</span>: <a href="../types/RenderTarget.html" class="tsd-signature-type tsd-kind-type-alias">RenderTarget</a><span class="tsd-signature-symbol"> = "live"</span></h5>
|
|
198
209
|
<div class="tsd-comment tsd-typography"><p>Specify the RenderTarget to pause playback. May be either <code>'live'</code> or <code>'capture'</code>.
|
|
199
210
|
Default is <code>'live'</code>.</p>
|
|
200
|
-
</div
|
|
211
|
+
</div>
|
|
212
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
201
213
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>Promise resolves when playback has stopped.</p>
|
|
202
|
-
|
|
214
|
+
|
|
215
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
203
216
|
<section class="tsd-panel tsd-member"><a id="mute" class="tsd-anchor"></a>
|
|
204
|
-
<h3 class="tsd-anchor-link"><span>mute</span><a href="#mute" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
217
|
+
<h3 class="tsd-anchor-link"><span>mute</span><a href="#mute" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
205
218
|
<ul class="tsd-signatures">
|
|
206
|
-
<li class="tsd-signature tsd-anchor-link" id="mute.mute-1"><span class="tsd-kind-call-signature">mute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fade</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#mute.mute-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
219
|
+
<li class="tsd-signature tsd-anchor-link" id="mute.mute-1"><span class="tsd-kind-call-signature">mute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fade</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#mute.mute-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
207
220
|
<li class="tsd-description">
|
|
208
221
|
<div class="tsd-comment tsd-typography"><p>Mute all sounds (default SDK state is unmuted).</p>
|
|
209
222
|
</div>
|
|
@@ -213,12 +226,14 @@ Default is <code>'live'</code>.</p>
|
|
|
213
226
|
<li>
|
|
214
227
|
<h5><span class="tsd-kind-parameter">fade</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
|
|
215
228
|
<div class="tsd-comment tsd-typography"><p>Do we want audio to fade out?</p>
|
|
216
|
-
</div
|
|
217
|
-
<
|
|
229
|
+
</div>
|
|
230
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
231
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
232
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
218
233
|
<section class="tsd-panel tsd-member"><a id="unmute" class="tsd-anchor"></a>
|
|
219
|
-
<h3 class="tsd-anchor-link"><span>unmute</span><a href="#unmute" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
234
|
+
<h3 class="tsd-anchor-link"><span>unmute</span><a href="#unmute" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
220
235
|
<ul class="tsd-signatures">
|
|
221
|
-
<li class="tsd-signature tsd-anchor-link" id="unmute.unmute-1"><span class="tsd-kind-call-signature">unmute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fade</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#unmute.unmute-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
236
|
+
<li class="tsd-signature tsd-anchor-link" id="unmute.unmute-1"><span class="tsd-kind-call-signature">unmute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fade</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#unmute.unmute-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
222
237
|
<li class="tsd-description">
|
|
223
238
|
<div class="tsd-comment tsd-typography"><p>Unmute all sounds.</p>
|
|
224
239
|
</div>
|
|
@@ -228,12 +243,14 @@ Default is <code>'live'</code>.</p>
|
|
|
228
243
|
<li>
|
|
229
244
|
<h5><span class="tsd-kind-parameter">fade</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
|
|
230
245
|
<div class="tsd-comment tsd-typography"><p>Do we want audio to fade in?</p>
|
|
231
|
-
</div
|
|
232
|
-
<
|
|
246
|
+
</div>
|
|
247
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
248
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
249
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
233
250
|
<section class="tsd-panel tsd-member"><a id="setSource" class="tsd-anchor"></a>
|
|
234
|
-
<h3 class="tsd-anchor-link"><span>set<wbr/>Source</span><a href="#setSource" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
251
|
+
<h3 class="tsd-anchor-link"><span>set<wbr/>Source</span><a href="#setSource" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
235
252
|
<ul class="tsd-signatures">
|
|
236
|
-
<li class="tsd-signature tsd-anchor-link" id="setSource.setSource-1"><span class="tsd-kind-call-signature">set<wbr/>Source</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">source</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><a href="CameraKitSource.html" class="tsd-signature-type tsd-kind-class">CameraKitSource</a><span class="tsd-signature-symbol">></span><a href="#setSource.setSource-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
253
|
+
<li class="tsd-signature tsd-anchor-link" id="setSource.setSource-1"><span class="tsd-kind-call-signature">set<wbr/>Source</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">source</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><a href="CameraKitSource.html" class="tsd-signature-type tsd-kind-class">CameraKitSource</a><span class="tsd-signature-symbol">></span><a href="#setSource.setSource-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
237
254
|
<li class="tsd-description">
|
|
238
255
|
<div class="tsd-comment tsd-typography"><p>Set the media source for this session.</p>
|
|
239
256
|
<p>Sessions may only have one source at a time - if <code>setSource</code> is called multiple times, subsequent calls replace
|
|
@@ -255,12 +272,14 @@ following functions:</p>
|
|
|
255
272
|
<div class="tsd-comment tsd-typography"><p>A CameraKitSource object representing input media (e.g. a webcam stream, video, or some other
|
|
256
273
|
source of image data), which CameraKit will supply to Lenses in order for them to render effects on top of that
|
|
257
274
|
source.</p>
|
|
258
|
-
</div
|
|
275
|
+
</div>
|
|
276
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
259
277
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><a href="CameraKitSource.html" class="tsd-signature-type tsd-kind-class">CameraKitSource</a><span class="tsd-signature-symbol">></span></h4><p>Promise is resolved when the source has successfully be set. If the session was already in the playing
|
|
260
278
|
state, the Promise resolves when the first frame from the new source has been rendered. The resolved value is
|
|
261
279
|
the <a href="CameraKitSource.html" class="tsd-kind-class">CameraKitSource</a> object attached to the session.</p>
|
|
262
|
-
|
|
263
|
-
<
|
|
280
|
+
|
|
281
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
282
|
+
<li class="tsd-signature tsd-anchor-link" id="setSource.setSource-2"><span class="tsd-kind-call-signature">set<wbr/>Source</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">source</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><a href="CameraKitSource.html" class="tsd-signature-type tsd-kind-class">CameraKitSource</a><span class="tsd-signature-symbol">></span><a href="#setSource.setSource-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
264
283
|
<li class="tsd-description">
|
|
265
284
|
<div class="tsd-parameters">
|
|
266
285
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -271,9 +290,9 @@ the <a href="CameraKitSource.html" class="tsd-kind-class">CameraKitSource</a> ob
|
|
|
271
290
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">Partial</span><span class="tsd-signature-symbol"><</span><a href="../types/CameraKitDeviceInfo.html" class="tsd-signature-type tsd-kind-type-alias">CameraKitDeviceInfo</a><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
272
291
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><a href="CameraKitSource.html" class="tsd-signature-type tsd-kind-class">CameraKitSource</a><span class="tsd-signature-symbol">></span></h4></li></ul></section>
|
|
273
292
|
<section class="tsd-panel tsd-member"><a id="setFPSLimit" class="tsd-anchor"></a>
|
|
274
|
-
<h3 class="tsd-anchor-link"><span>setFPSLimit</span><a href="#setFPSLimit" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
293
|
+
<h3 class="tsd-anchor-link"><span>setFPSLimit</span><a href="#setFPSLimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
275
294
|
<ul class="tsd-signatures">
|
|
276
|
-
<li class="tsd-signature tsd-anchor-link" id="setFPSLimit.setFPSLimit-1"><span class="tsd-kind-call-signature">setFPSLimit</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fpsLimit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#setFPSLimit.setFPSLimit-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
295
|
+
<li class="tsd-signature tsd-anchor-link" id="setFPSLimit.setFPSLimit-1"><span class="tsd-kind-call-signature">setFPSLimit</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fpsLimit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#setFPSLimit.setFPSLimit-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
277
296
|
<li class="tsd-description">
|
|
278
297
|
<div class="tsd-comment tsd-typography"><p>Set an FPS limit.</p>
|
|
279
298
|
<p>This may be useful to reduce CPU/GPU resource usage by CameraKit if, for example, the input
|
|
@@ -288,23 +307,26 @@ alternatives.</p>
|
|
|
288
307
|
<li>
|
|
289
308
|
<h5><span class="tsd-kind-parameter">fpsLimit</span>: <span class="tsd-signature-type">number</span></h5>
|
|
290
309
|
<div class="tsd-comment tsd-typography"><p>A maximum FPS, rendering will not exceed this limit</p>
|
|
291
|
-
</div
|
|
310
|
+
</div>
|
|
311
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
292
312
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>Promise is resolved when the limit is successfully set.</p>
|
|
293
|
-
|
|
313
|
+
|
|
314
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
294
315
|
<section class="tsd-panel tsd-member"><a id="destroy" class="tsd-anchor"></a>
|
|
295
|
-
<h3 class="tsd-anchor-link"><span>destroy</span><a href="#destroy" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
316
|
+
<h3 class="tsd-anchor-link"><span>destroy</span><a href="#destroy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
296
317
|
<ul class="tsd-signatures">
|
|
297
|
-
<li class="tsd-signature tsd-anchor-link" id="destroy.destroy-1"><span class="tsd-kind-call-signature">destroy</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#destroy.destroy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
318
|
+
<li class="tsd-signature tsd-anchor-link" id="destroy.destroy-1"><span class="tsd-kind-call-signature">destroy</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#destroy.destroy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
298
319
|
<li class="tsd-description">
|
|
299
320
|
<div class="tsd-comment tsd-typography"><p>Destroy the session.</p>
|
|
300
321
|
<p>The session will become inoperable. Frame processing stops, and any session-scoped graphical resources are freed.</p>
|
|
301
322
|
</div>
|
|
302
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4
|
|
323
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
|
324
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section></section></div>
|
|
303
325
|
<div class="col-sidebar">
|
|
304
326
|
<div class="page-menu">
|
|
305
327
|
<div class="tsd-navigation settings">
|
|
306
328
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
307
|
-
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg>Settings</h3></summary>
|
|
329
|
+
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)" id="icon-chevronDown"></path></svg>Settings</h3></summary>
|
|
308
330
|
<div class="tsd-accordion-details">
|
|
309
331
|
<div class="tsd-filter-visibility">
|
|
310
332
|
<h4 class="uppercase">Member Visibility</h4><form>
|
|
@@ -314,95 +336,95 @@ alternatives.</p>
|
|
|
314
336
|
<div class="tsd-theme-toggle">
|
|
315
337
|
<h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
316
338
|
<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
|
|
317
|
-
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><
|
|
339
|
+
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary>
|
|
318
340
|
<div class="tsd-accordion-details">
|
|
319
341
|
<ul>
|
|
320
|
-
<li><a href="#output" class=""><svg class="tsd-kind-icon"
|
|
321
|
-
<li><a href="#playing" class=""><svg class="tsd-kind-icon"
|
|
322
|
-
<li><a href="#events" class=""><svg class="tsd-kind-icon"
|
|
323
|
-
<li><a href="#metrics" class=""><svg class="tsd-kind-icon"
|
|
324
|
-
<li><a href="#keyboard" class=""><svg class="tsd-kind-icon"
|
|
325
|
-
<li><a href="#applyLens" class=""><svg class="tsd-kind-icon"
|
|
326
|
-
<li><a href="#removeLens" class=""><svg class="tsd-kind-icon"
|
|
327
|
-
<li><a href="#play" class=""><svg class="tsd-kind-icon"
|
|
328
|
-
<li><a href="#pause" class=""><svg class="tsd-kind-icon"
|
|
329
|
-
<li><a href="#mute" class=""><svg class="tsd-kind-icon"
|
|
330
|
-
<li><a href="#unmute" class=""><svg class="tsd-kind-icon"
|
|
331
|
-
<li><a href="#setSource" class=""><svg class="tsd-kind-icon"
|
|
332
|
-
<li><a href="#setFPSLimit" class=""><svg class="tsd-kind-icon"
|
|
333
|
-
<li><a href="#destroy" class=""><svg class="tsd-kind-icon"
|
|
342
|
+
<li><a href="#output" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>output</span></a></li>
|
|
343
|
+
<li><a href="#playing" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>playing</span></a></li>
|
|
344
|
+
<li><a href="#events" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>events</span></a></li>
|
|
345
|
+
<li><a href="#metrics" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>metrics</span></a></li>
|
|
346
|
+
<li><a href="#keyboard" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>keyboard</span></a></li>
|
|
347
|
+
<li><a href="#applyLens" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>apply<wbr/>Lens</span></a></li>
|
|
348
|
+
<li><a href="#removeLens" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>remove<wbr/>Lens</span></a></li>
|
|
349
|
+
<li><a href="#play" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>play</span></a></li>
|
|
350
|
+
<li><a href="#pause" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>pause</span></a></li>
|
|
351
|
+
<li><a href="#mute" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>mute</span></a></li>
|
|
352
|
+
<li><a href="#unmute" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>unmute</span></a></li>
|
|
353
|
+
<li><a href="#setSource" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Source</span></a></li>
|
|
354
|
+
<li><a href="#setFPSLimit" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>setFPSLimit</span></a></li>
|
|
355
|
+
<li><a href="#destroy" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>destroy</span></a></li></ul></div></details></div>
|
|
334
356
|
<div class="site-menu">
|
|
335
|
-
<nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon"
|
|
357
|
+
<nav class="tsd-navigation"><a href="../modules.html"><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>
|
|
336
358
|
<ul class="tsd-small-nested-navigation">
|
|
337
|
-
<li><a href="CameraKit.html"><svg class="tsd-kind-icon"
|
|
338
|
-
<li><a href="TypedCustomEvent.html"><svg class="tsd-kind-icon"
|
|
339
|
-
<li><a href="TypedEventTarget.html"><svg class="tsd-kind-icon"
|
|
340
|
-
<li><a href="LensSources.html"><svg class="tsd-kind-icon"
|
|
341
|
-
<li><a href="LensRepository.html"><svg class="tsd-kind-icon"
|
|
342
|
-
<li><a href="CameraKitSource.html"><svg class="tsd-kind-icon"
|
|
343
|
-
<li><a href="CameraKitSession.html" class="current"><svg class="tsd-kind-icon"
|
|
344
|
-
<li><a href="LensPerformanceMeasurement.html"><svg class="tsd-kind-icon"
|
|
345
|
-
<li><a href="LensPerformanceMetrics.html"><svg class="tsd-kind-icon"
|
|
346
|
-
<li><a href="Transform2D.html"><svg class="tsd-kind-icon"
|
|
347
|
-
<li><a href="../interfaces/CreateSessionOptions.html"><svg class="tsd-kind-icon"
|
|
348
|
-
<li><a href="../interfaces/EstimatedLensPerformance.html"><svg class="tsd-kind-icon"
|
|
349
|
-
<li><a href="../interfaces/CameraKitBootstrapConfiguration.html"><svg class="tsd-kind-icon"
|
|
350
|
-
<li><a href="../interfaces/LensSource.html"><svg class="tsd-kind-icon"
|
|
351
|
-
<li><a href="../interfaces/UriHandler.html"><svg class="tsd-kind-icon"
|
|
352
|
-
<li><a href="../interfaces/UriRequest.html"><svg class="tsd-kind-icon"
|
|
353
|
-
<li><a href="../interfaces/UriResponse.html"><svg class="tsd-kind-icon"
|
|
354
|
-
<li><a href="../interfaces/UriCancelRequest.html"><svg class="tsd-kind-icon"
|
|
355
|
-
<li><a href="../interfaces/Lens.html"><svg class="tsd-kind-icon"
|
|
356
|
-
<li><a href="../interfaces/Preview.html"><svg class="tsd-kind-icon"
|
|
357
|
-
<li><a href="../interfaces/Snapcode.html"><svg class="tsd-kind-icon"
|
|
358
|
-
<li><a href="../interfaces/CameraKitSourceSubscriber.html"><svg class="tsd-kind-icon"
|
|
359
|
-
<li><a href="../interfaces/MediaStreamSourceOptions.html"><svg class="tsd-kind-icon"
|
|
360
|
-
<li><a href="../interfaces/VideoSourceOptions.html"><svg class="tsd-kind-icon"
|
|
361
|
-
<li><a href="../interfaces/ComputedFrameMetrics.html"><svg class="tsd-kind-icon"
|
|
362
|
-
<li><a href="../types/LensMetricsEvents.html"><svg class="tsd-kind-icon"
|
|
363
|
-
<li><a href="../types/LensPerformanceCluster.html"><svg class="tsd-kind-icon"
|
|
364
|
-
<li><a href="../types/PublicContainer.html"><svg class="tsd-kind-icon"
|
|
365
|
-
<li><a href="../types/UriHandlers.html"><svg class="tsd-kind-icon"
|
|
366
|
-
<li><a href="../types/Uri.html"><svg class="tsd-kind-icon"
|
|
367
|
-
<li><a href="../types/LensLaunchParams.html"><svg class="tsd-kind-icon"
|
|
368
|
-
<li><a href="../types/AssetTiming.html"><svg class="tsd-kind-icon"
|
|
369
|
-
<li><a href="../types/AssetLoader.html"><svg class="tsd-kind-icon"
|
|
370
|
-
<li><a href="../types/CameraKitDeviceInfo.html"><svg class="tsd-kind-icon"
|
|
371
|
-
<li><a href="../types/CameraKitSourceInfo.html"><svg class="tsd-kind-icon"
|
|
372
|
-
<li><a href="../types/CameraKitSourceOptions.html"><svg class="tsd-kind-icon"
|
|
373
|
-
<li><a href="../types/LensView.html"><svg class="tsd-kind-icon"
|
|
374
|
-
<li><a href="../types/LensWait.html"><svg class="tsd-kind-icon"
|
|
375
|
-
<li><a href="../types/LegalError.html"><svg class="tsd-kind-icon"
|
|
376
|
-
<li><a href="../types/LensContentValidationError.html"><svg class="tsd-kind-icon"
|
|
377
|
-
<li><a href="../types/LensError.html"><svg class="tsd-kind-icon"
|
|
378
|
-
<li><a href="../types/CameraKitSourceError.html"><svg class="tsd-kind-icon"
|
|
379
|
-
<li><a href="../types/LensImagePickerError.html"><svg class="tsd-kind-icon"
|
|
380
|
-
<li><a href="../types/CacheKeyNotFoundError.html"><svg class="tsd-kind-icon"
|
|
381
|
-
<li><a href="../types/ConfigurationError.html"><svg class="tsd-kind-icon"
|
|
382
|
-
<li><a href="../types/WebGLError.html"><svg class="tsd-kind-icon"
|
|
383
|
-
<li><a href="../types/BenchmarkError.html"><svg class="tsd-kind-icon"
|
|
384
|
-
<li><a href="../types/PlatformNotSupportedError.html"><svg class="tsd-kind-icon"
|
|
385
|
-
<li><a href="../types/LensExecutionError.html"><svg class="tsd-kind-icon"
|
|
386
|
-
<li><a href="../types/PersistentStoreError.html"><svg class="tsd-kind-icon"
|
|
387
|
-
<li><a href="../types/LensAssetError.html"><svg class="tsd-kind-icon"
|
|
388
|
-
<li><a href="../types/BootstrapError.html"><svg class="tsd-kind-icon"
|
|
389
|
-
<li><a href="../types/RenderTarget.html"><svg class="tsd-kind-icon"
|
|
390
|
-
<li><a href="../types/CameraKitSessionEvents.html"><svg class="tsd-kind-icon"
|
|
391
|
-
<li><a href="../types/CameraKitSessionEventListener.html"><svg class="tsd-kind-icon"
|
|
392
|
-
<li><a href="../types/KeyboardEvents.html"><svg class="tsd-kind-icon"
|
|
393
|
-
<li><a href="../types/Keyboard.html"><svg class="tsd-kind-icon"
|
|
394
|
-
<li><a href="../variables/extensionRequestContext.html"><svg class="tsd-kind-icon"
|
|
395
|
-
<li><a href="../functions/estimateLensPerformance.html"><svg class="tsd-kind-icon"
|
|
396
|
-
<li><a href="../functions/bootstrapCameraKit.html"><svg class="tsd-kind-icon"
|
|
397
|
-
<li><a href="../functions/createExtension.html"><svg class="tsd-kind-icon"
|
|
398
|
-
<li><a href="../functions/Injectable.html"><svg class="tsd-kind-icon"
|
|
399
|
-
<li><a href="../functions/lensSourcesFactory.html"><svg class="tsd-kind-icon"
|
|
400
|
-
<li><a href="../functions/uriHandlersFactory.html"><svg class="tsd-kind-icon"
|
|
401
|
-
<li><a href="../functions/getRequiredBootstrapURLs.html"><svg class="tsd-kind-icon"
|
|
402
|
-
<li><a href="../functions/createImageSource.html"><svg class="tsd-kind-icon"
|
|
403
|
-
<li><a href="../functions/createUserMediaSource.html"><svg class="tsd-kind-icon"
|
|
404
|
-
<li><a href="../functions/createMediaStreamSource.html"><svg class="tsd-kind-icon"
|
|
405
|
-
<li><a href="../functions/createVideoSource.html"><svg class="tsd-kind-icon"
|
|
359
|
+
<li><a href="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>
|
|
360
|
+
<li><a href="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>
|
|
361
|
+
<li><a href="TypedEventTarget.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Typed<wbr/>Event<wbr/>Target</span></a></li>
|
|
362
|
+
<li><a href="LensSources.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Lens<wbr/>Sources</span></a></li>
|
|
363
|
+
<li><a href="LensRepository.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Lens<wbr/>Repository</span></a></li>
|
|
364
|
+
<li><a href="CameraKitSource.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Camera<wbr/>Kit<wbr/>Source</span></a></li>
|
|
365
|
+
<li><a href="CameraKitSession.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Camera<wbr/>Kit<wbr/>Session</span></a></li>
|
|
366
|
+
<li><a href="LensPerformanceMeasurement.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Lens<wbr/>Performance<wbr/>Measurement</span></a></li>
|
|
367
|
+
<li><a href="LensPerformanceMetrics.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Lens<wbr/>Performance<wbr/>Metrics</span></a></li>
|
|
368
|
+
<li><a href="Transform2D.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Transform2D</span></a></li>
|
|
369
|
+
<li><a href="../interfaces/CreateSessionOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>Create<wbr/>Session<wbr/>Options</span></a></li>
|
|
370
|
+
<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>
|
|
371
|
+
<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>
|
|
372
|
+
<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>
|
|
373
|
+
<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>
|
|
374
|
+
<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>
|
|
375
|
+
<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>
|
|
376
|
+
<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>
|
|
377
|
+
<li><a href="../interfaces/Lens.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Lens</span></a></li>
|
|
378
|
+
<li><a href="../interfaces/Preview.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Preview</span></a></li>
|
|
379
|
+
<li><a href="../interfaces/Snapcode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Snapcode</span></a></li>
|
|
380
|
+
<li><a href="../interfaces/CameraKitSourceSubscriber.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Camera<wbr/>Kit<wbr/>Source<wbr/>Subscriber</span></a></li>
|
|
381
|
+
<li><a href="../interfaces/MediaStreamSourceOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Media<wbr/>Stream<wbr/>Source<wbr/>Options</span></a></li>
|
|
382
|
+
<li><a href="../interfaces/VideoSourceOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Video<wbr/>Source<wbr/>Options</span></a></li>
|
|
383
|
+
<li><a href="../interfaces/ComputedFrameMetrics.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Computed<wbr/>Frame<wbr/>Metrics</span></a></li>
|
|
384
|
+
<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>
|
|
385
|
+
<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>
|
|
386
|
+
<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>
|
|
387
|
+
<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>
|
|
388
|
+
<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>
|
|
389
|
+
<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>
|
|
390
|
+
<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>
|
|
391
|
+
<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>
|
|
392
|
+
<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>
|
|
393
|
+
<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>
|
|
394
|
+
<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>
|
|
395
|
+
<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>
|
|
396
|
+
<li><a href="../types/LensWait.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Lens<wbr/>Wait</span></a></li>
|
|
397
|
+
<li><a href="../types/LegalError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Legal<wbr/>Error</span></a></li>
|
|
398
|
+
<li><a href="../types/LensContentValidationError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Lens<wbr/>Content<wbr/>Validation<wbr/>Error</span></a></li>
|
|
399
|
+
<li><a href="../types/LensError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Lens<wbr/>Error</span></a></li>
|
|
400
|
+
<li><a href="../types/CameraKitSourceError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Camera<wbr/>Kit<wbr/>Source<wbr/>Error</span></a></li>
|
|
401
|
+
<li><a href="../types/LensImagePickerError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Lens<wbr/>Image<wbr/>Picker<wbr/>Error</span></a></li>
|
|
402
|
+
<li><a href="../types/CacheKeyNotFoundError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Cache<wbr/>Key<wbr/>Not<wbr/>Found<wbr/>Error</span></a></li>
|
|
403
|
+
<li><a href="../types/ConfigurationError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Configuration<wbr/>Error</span></a></li>
|
|
404
|
+
<li><a href="../types/WebGLError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>WebGLError</span></a></li>
|
|
405
|
+
<li><a href="../types/BenchmarkError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Benchmark<wbr/>Error</span></a></li>
|
|
406
|
+
<li><a href="../types/PlatformNotSupportedError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Platform<wbr/>Not<wbr/>Supported<wbr/>Error</span></a></li>
|
|
407
|
+
<li><a href="../types/LensExecutionError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Lens<wbr/>Execution<wbr/>Error</span></a></li>
|
|
408
|
+
<li><a href="../types/PersistentStoreError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Persistent<wbr/>Store<wbr/>Error</span></a></li>
|
|
409
|
+
<li><a href="../types/LensAssetError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Lens<wbr/>Asset<wbr/>Error</span></a></li>
|
|
410
|
+
<li><a href="../types/BootstrapError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Bootstrap<wbr/>Error</span></a></li>
|
|
411
|
+
<li><a href="../types/RenderTarget.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Render<wbr/>Target</span></a></li>
|
|
412
|
+
<li><a href="../types/CameraKitSessionEvents.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Camera<wbr/>Kit<wbr/>Session<wbr/>Events</span></a></li>
|
|
413
|
+
<li><a href="../types/CameraKitSessionEventListener.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Camera<wbr/>Kit<wbr/>Session<wbr/>Event<wbr/>Listener</span></a></li>
|
|
414
|
+
<li><a href="../types/KeyboardEvents.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Keyboard<wbr/>Events</span></a></li>
|
|
415
|
+
<li><a href="../types/Keyboard.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Keyboard</span></a></li>
|
|
416
|
+
<li><a href="../variables/extensionRequestContext.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-32"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)"></path></g></svg><span>extension<wbr/>Request<wbr/>Context</span></a></li>
|
|
417
|
+
<li><a href="../functions/estimateLensPerformance.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-64"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g></svg><span>estimate<wbr/>Lens<wbr/>Performance</span></a></li>
|
|
418
|
+
<li><a href="../functions/bootstrapCameraKit.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>bootstrap<wbr/>Camera<wbr/>Kit</span></a></li>
|
|
419
|
+
<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>
|
|
420
|
+
<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>
|
|
421
|
+
<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>
|
|
422
|
+
<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>
|
|
423
|
+
<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>
|
|
424
|
+
<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>
|
|
425
|
+
<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>
|
|
426
|
+
<li><a href="../functions/createMediaStreamSource.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>create<wbr/>Media<wbr/>Stream<wbr/>Source</span></a></li>
|
|
427
|
+
<li><a href="../functions/createVideoSource.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>create<wbr/>Video<wbr/>Source</span></a></li></ul></nav></div></div></div>
|
|
406
428
|
<div class="tsd-generator">
|
|
407
429
|
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
|
|
408
430
|
<div class="overlay"></div></body></html>
|