@snap/camera-kit 0.12.0 → 0.13.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +25 -3
- package/docs/html/assets/search.js +1 -1
- package/docs/html/classes/CameraKit.html +12 -7
- package/docs/html/classes/CameraKitSession.html +27 -7
- package/docs/html/classes/CameraKitSource.html +26 -17
- package/docs/html/classes/LensPerformanceMeasurement.html +12 -7
- package/docs/html/classes/LensPerformanceMetrics.html +12 -7
- package/docs/html/classes/LensRepository.html +12 -7
- package/docs/html/classes/LensSources.html +12 -7
- package/docs/html/classes/Transform2D.html +12 -7
- package/docs/html/classes/TypedCustomEvent.html +12 -7
- package/docs/html/classes/TypedEventTarget.html +12 -7
- package/docs/html/functions/Injectable.html +12 -7
- package/docs/html/functions/bootstrapCameraKit.html +12 -7
- package/docs/html/functions/createExtension.html +12 -7
- package/docs/html/functions/createImageSource.html +12 -7
- package/docs/html/functions/createMediaStreamSource.html +12 -7
- package/docs/html/functions/createUserMediaSource.html +12 -7
- package/docs/html/functions/createVideoSource.html +12 -7
- package/docs/html/functions/estimateLensPerformance.html +12 -7
- package/docs/html/functions/getRequiredBootstrapURLs.html +12 -7
- package/docs/html/functions/lensSourcesFactory.html +12 -7
- package/docs/html/functions/{uriHandlersFactory.html → remoteApiServicesFactory.html} +16 -14
- package/docs/html/index.html +40 -12
- package/docs/html/interfaces/CameraKitBootstrapConfiguration.html +12 -7
- package/docs/html/interfaces/CameraKitSourceSubscriber.html +12 -7
- package/docs/html/interfaces/ComputedFrameMetrics.html +12 -7
- package/docs/html/interfaces/CreateSessionOptions.html +12 -7
- package/docs/html/interfaces/EstimatedLensPerformance.html +12 -7
- package/docs/html/interfaces/Lens.html +12 -7
- package/docs/html/interfaces/LensSource.html +16 -11
- package/docs/html/interfaces/MediaStreamSourceOptions.html +12 -7
- package/docs/html/interfaces/Preview.html +12 -7
- package/docs/html/interfaces/RemoteApiRequest.html +164 -0
- package/docs/html/interfaces/RemoteApiResponse.html +156 -0
- package/docs/html/interfaces/{UriHandler.html → RemoteApiService.html} +34 -68
- package/docs/html/interfaces/Snapcode.html +12 -7
- package/docs/html/interfaces/UriCancelRequest.html +12 -7
- package/docs/html/interfaces/UriRequest.html +13 -8
- package/docs/html/interfaces/UriResponse.html +12 -7
- package/docs/html/interfaces/VideoSourceOptions.html +12 -7
- package/docs/html/modules.html +22 -12
- package/docs/html/types/AssetLoader.html +12 -7
- package/docs/html/types/AssetTiming.html +12 -7
- package/docs/html/types/BenchmarkError.html +12 -7
- package/docs/html/types/BootstrapError.html +12 -7
- package/docs/html/types/CacheKeyNotFoundError.html +12 -7
- package/docs/html/types/CameraKitDeviceInfo.html +19 -9
- package/docs/html/types/CameraKitDeviceOptions.html +119 -0
- package/docs/html/types/CameraKitSessionEventListener.html +12 -7
- package/docs/html/types/CameraKitSessionEvents.html +12 -7
- package/docs/html/types/CameraKitSourceError.html +12 -7
- package/docs/html/types/CameraKitSourceInfo.html +12 -7
- package/docs/html/types/CameraKitSourceOptions.html +13 -8
- package/docs/html/types/ConfigurationError.html +12 -7
- package/docs/html/types/Keyboard.html +12 -7
- package/docs/html/types/KeyboardEvents.html +12 -7
- package/docs/html/types/LegalError.html +12 -7
- package/docs/html/types/LensAssetError.html +12 -7
- package/docs/html/types/LensContentValidationError.html +12 -7
- package/docs/html/types/LensError.html +12 -7
- package/docs/html/types/LensExecutionError.html +12 -7
- package/docs/html/types/LensImagePickerError.html +12 -7
- package/docs/html/types/LensLaunchParams.html +12 -7
- package/docs/html/types/LensMetricsEvents.html +12 -7
- package/docs/html/types/LensPerformanceCluster.html +12 -7
- package/docs/html/types/LensView.html +12 -7
- package/docs/html/types/LensWait.html +12 -7
- package/docs/html/types/PersistentStoreError.html +12 -7
- package/docs/html/types/PlatformNotSupportedError.html +12 -7
- package/docs/html/types/PublicContainer.html +12 -7
- package/docs/html/types/RemoteApiRequestHandler.html +141 -0
- package/docs/html/types/{UriHandlers.html → RemoteApiServices.html} +15 -13
- package/docs/html/types/RemoteApiStatus.html +114 -0
- package/docs/html/types/RenderTarget.html +12 -7
- package/docs/html/types/Uri.html +12 -7
- package/docs/html/types/WebGLError.html +12 -7
- package/docs/html/variables/extensionRequestContext.html +12 -7
- package/docs/md/README.md +25 -3
- package/docs/md/classes/CameraKit.md +1 -1
- package/docs/md/classes/CameraKitSession.md +19 -1
- package/docs/md/classes/CameraKitSource.md +19 -7
- 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 +1 -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 +3 -3
- package/docs/md/interfaces/MediaStreamSourceOptions.md +1 -1
- package/docs/md/interfaces/Preview.md +1 -1
- package/docs/md/interfaces/RemoteApiRequest.md +46 -0
- package/docs/md/interfaces/RemoteApiResponse.md +37 -0
- package/docs/md/interfaces/RemoteApiService.md +45 -0
- package/docs/md/interfaces/Snapcode.md +1 -1
- package/docs/md/interfaces/UriCancelRequest.md +1 -1
- package/docs/md/interfaces/UriRequest.md +2 -2
- package/docs/md/interfaces/UriResponse.md +1 -1
- package/docs/md/interfaces/VideoSourceOptions.md +1 -1
- package/docs/md/modules.md +66 -15
- package/lib/CameraKit.js +3 -1
- package/lib/CameraKit.js.map +1 -1
- package/lib/__tests__/data.d.ts +1 -1
- package/lib/__tests__/data.js +1 -0
- package/lib/__tests__/data.js.map +1 -1
- package/lib/bootstrapCameraKit.js +12 -10
- package/lib/bootstrapCameraKit.js.map +1 -1
- package/lib/common/any.d.ts +17 -0
- package/lib/common/any.js +36 -0
- package/lib/common/any.js.map +1 -0
- package/lib/common/cameraKitUserAgent.d.ts +5 -0
- package/lib/common/cameraKitUserAgent.js +2 -1
- package/lib/common/cameraKitUserAgent.js.map +1 -1
- package/lib/common/date.d.ts +3 -0
- package/lib/common/date.js +13 -0
- package/lib/common/date.js.map +1 -0
- package/lib/common/errorHelpers.js +1 -1
- package/lib/common/errorHelpers.js.map +1 -1
- package/lib/common/time.d.ts +1 -0
- package/lib/common/time.js +1 -0
- package/lib/common/time.js.map +1 -1
- package/lib/common/types.d.ts +8 -0
- package/lib/common/types.js.map +1 -1
- package/lib/dependency-injection/RootServices.d.ts +2 -0
- package/lib/dependency-injection/RootServices.js.map +1 -1
- package/lib/environment.json +1 -1
- package/lib/extensions/LensSources.d.ts +2 -2
- package/lib/extensions/LensSources.js +7 -3
- package/lib/extensions/LensSources.js.map +1 -1
- package/lib/extensions/RemoteApiServices.d.ts +101 -0
- package/lib/extensions/RemoteApiServices.js +198 -0
- package/lib/extensions/RemoteApiServices.js.map +1 -0
- package/lib/extensions/UriHandlers.d.ts +10 -17
- package/lib/extensions/UriHandlers.js +5 -60
- package/lib/extensions/UriHandlers.js.map +1 -1
- package/lib/extensions/uriHandlersRegister.d.ts +21 -0
- package/lib/extensions/uriHandlersRegister.js +72 -0
- package/lib/extensions/uriHandlersRegister.js.map +1 -0
- package/lib/generated-proto/pb_schema/camera_kit/v3/features/remote_api_info.d.ts +31 -0
- package/lib/generated-proto/pb_schema/camera_kit/v3/features/remote_api_info.js +43 -0
- package/lib/generated-proto/pb_schema/camera_kit/v3/features/remote_api_info.js.map +1 -0
- package/lib/generated-proto/pb_schema/cdp/cof/namespace.d.ts +1 -0
- package/lib/generated-proto/pb_schema/cdp/cof/namespace.js +1 -0
- package/lib/generated-proto/pb_schema/cdp/cof/namespace.js.map +1 -1
- package/lib/generated-proto/pb_schema/lenses/remote_api/remote_api_service.d.ts +569 -0
- package/lib/generated-proto/pb_schema/lenses/remote_api/remote_api_service.js +1175 -0
- package/lib/generated-proto/pb_schema/lenses/remote_api/remote_api_service.js.map +1 -0
- package/lib/handlers/defaultFetchHandler.js +17 -4
- package/lib/handlers/defaultFetchHandler.js.map +1 -1
- package/lib/index.d.ts +1 -0
- package/lib/index.js +1 -0
- package/lib/index.js.map +1 -1
- package/lib/legal/legalState.js +1 -1
- package/lib/legal/legalState.js.map +1 -1
- package/lib/lens/lensHttpUtil.js +26 -4
- package/lib/lens/lensHttpUtil.js.map +1 -1
- package/lib/lens-core-module/generated-types.d.ts +24 -4
- package/lib/lens-core-module/generated-types.js.map +1 -1
- package/lib/lensCoreWasmVersions.json +3 -3
- package/lib/logger/registerLogEntriesSubscriber.js +13 -1
- package/lib/logger/registerLogEntriesSubscriber.js.map +1 -1
- package/lib/media-sources/CameraKitSource.d.ts +13 -3
- package/lib/media-sources/CameraKitSource.js +2 -8
- package/lib/media-sources/CameraKitSource.js.map +1 -1
- package/lib/media-sources/FunctionSource.d.ts +1 -1
- package/lib/media-sources/FunctionSource.js +1 -1
- package/lib/media-sources/FunctionSource.js.map +1 -1
- package/lib/media-sources/ImageSource.d.ts +1 -1
- package/lib/media-sources/ImageSource.js +1 -1
- package/lib/media-sources/ImageSource.js.map +1 -1
- package/lib/media-sources/MediaStreamSource.d.ts +1 -1
- package/lib/media-sources/MediaStreamSource.js +2 -1
- package/lib/media-sources/MediaStreamSource.js.map +1 -1
- package/lib/media-sources/VideoSource.d.ts +1 -1
- package/lib/media-sources/VideoSource.js +1 -1
- package/lib/media-sources/VideoSource.js.map +1 -1
- package/lib/metrics/businessEventsReporter.d.ts +3 -2
- package/lib/metrics/businessEventsReporter.js +125 -65
- package/lib/metrics/businessEventsReporter.js.map +1 -1
- package/lib/metrics/operational/operationalMetricsReporter.js +23 -5
- package/lib/metrics/operational/operationalMetricsReporter.js.map +1 -1
- package/lib/metrics/reporters/reportHttpMetrics.d.ts +0 -7
- package/lib/metrics/reporters/reportHttpMetrics.js +3 -2
- package/lib/metrics/reporters/reportHttpMetrics.js.map +1 -1
- package/lib/metrics/reporters/reportLensView.d.ts +1 -1
- package/lib/metrics/reporters/reportLensView.js +41 -13
- package/lib/metrics/reporters/reportLensView.js.map +1 -1
- package/lib/metrics/reporters/reportUserSession.js +15 -16
- package/lib/metrics/reporters/reportUserSession.js.map +1 -1
- package/lib/metrics/reporters/reporters.d.ts +1 -1
- package/lib/persistence/ExpiringPersistence.d.ts +2 -1
- package/lib/persistence/ExpiringPersistence.js +15 -1
- package/lib/persistence/ExpiringPersistence.js.map +1 -1
- package/lib/persistence/IndexedDBPersistence.d.ts +1 -1
- package/lib/persistence/IndexedDBPersistence.js +11 -1
- package/lib/persistence/IndexedDBPersistence.js.map +1 -1
- package/lib/persistence/Persistence.d.ts +1 -1
- package/lib/persistence/Persistence.js.map +1 -1
- package/lib/remote-configuration/preloadConfiguration.d.ts +7 -0
- package/lib/remote-configuration/preloadConfiguration.js +15 -0
- package/lib/remote-configuration/preloadConfiguration.js.map +1 -0
- package/lib/remote-configuration/remoteConfiguration.d.ts +5 -1
- package/lib/remote-configuration/remoteConfiguration.js +10 -2
- package/lib/remote-configuration/remoteConfiguration.js.map +1 -1
- package/lib/session/CameraKitSession.d.ts +7 -2
- package/lib/session/CameraKitSession.js +1 -0
- package/lib/session/CameraKitSession.js.map +1 -1
- package/lib/session/sessionState.d.ts +2 -2
- package/lib/session/sessionState.js +3 -3
- package/lib/session/sessionState.js.map +1 -1
- package/package.json +2 -1
- package/docs/md/interfaces/UriHandler.md +0 -63
|
@@ -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>getRequiredBootstrapURLs | 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>getRequiredBootstrapURLs | CameraKit Web SDK - v0.13.0-alpha.1</title><meta name="description" content="Documentation for CameraKit Web SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
|
|
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.13.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">
|
|
@@ -48,7 +48,7 @@ bootstrapped.</p>
|
|
|
48
48
|
<div class="tsd-theme-toggle">
|
|
49
49
|
<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></div>
|
|
50
50
|
<div class="site-menu">
|
|
51
|
-
<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.
|
|
51
|
+
<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.13.0-<wbr/>alpha.1</span></a>
|
|
52
52
|
<ul class="tsd-small-nested-navigation">
|
|
53
53
|
<li><a href="../classes/CameraKit.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>Camera<wbr/>Kit</span></a></li>
|
|
54
54
|
<li><a href="../classes/TypedCustomEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Typed<wbr/>Custom<wbr/>Event</span></a></li>
|
|
@@ -64,7 +64,9 @@ bootstrapped.</p>
|
|
|
64
64
|
<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>
|
|
65
65
|
<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>
|
|
66
66
|
<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>
|
|
67
|
-
<li><a href="../interfaces/
|
|
67
|
+
<li><a href="../interfaces/RemoteApiRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Remote<wbr/>Api<wbr/>Request</span></a></li>
|
|
68
|
+
<li><a href="../interfaces/RemoteApiResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Remote<wbr/>Api<wbr/>Response</span></a></li>
|
|
69
|
+
<li><a href="../interfaces/RemoteApiService.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Remote<wbr/>Api<wbr/>Service</span></a></li>
|
|
68
70
|
<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>
|
|
69
71
|
<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>
|
|
70
72
|
<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>
|
|
@@ -78,12 +80,15 @@ bootstrapped.</p>
|
|
|
78
80
|
<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>
|
|
79
81
|
<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>
|
|
80
82
|
<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>
|
|
81
|
-
<li><a href="../types/
|
|
83
|
+
<li><a href="../types/RemoteApiStatus.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Remote<wbr/>Api<wbr/>Status</span></a></li>
|
|
84
|
+
<li><a href="../types/RemoteApiRequestHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Remote<wbr/>Api<wbr/>Request<wbr/>Handler</span></a></li>
|
|
85
|
+
<li><a href="../types/RemoteApiServices.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Remote<wbr/>Api<wbr/>Services</span></a></li>
|
|
82
86
|
<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>
|
|
83
87
|
<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>
|
|
84
88
|
<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>
|
|
85
89
|
<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>
|
|
86
|
-
<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>
|
|
90
|
+
<li><a href="../types/CameraKitDeviceInfo.html" class="deprecated"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Camera<wbr/>Kit<wbr/>Device<wbr/>Info</span></a></li>
|
|
91
|
+
<li><a href="../types/CameraKitDeviceOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Camera<wbr/>Kit<wbr/>Device<wbr/>Options</span></a></li>
|
|
87
92
|
<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>
|
|
88
93
|
<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>
|
|
89
94
|
<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>
|
|
@@ -113,7 +118,7 @@ bootstrapped.</p>
|
|
|
113
118
|
<li><a href="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>
|
|
114
119
|
<li><a href="Injectable.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>Injectable</span></a></li>
|
|
115
120
|
<li><a href="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>
|
|
116
|
-
<li><a href="
|
|
121
|
+
<li><a href="remoteApiServicesFactory.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>remote<wbr/>Api<wbr/>Services<wbr/>Factory</span></a></li>
|
|
117
122
|
<li><a href="getRequiredBootstrapURLs.html" class="current"><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>
|
|
118
123
|
<li><a href="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>
|
|
119
124
|
<li><a href="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>
|
|
@@ -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>lensSourcesFactory | 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>lensSourcesFactory | CameraKit Web SDK - v0.13.0-alpha.1</title><meta name="description" content="Documentation for CameraKit Web SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
|
|
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.13.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">
|
|
@@ -39,7 +39,7 @@
|
|
|
39
39
|
<div class="tsd-theme-toggle">
|
|
40
40
|
<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></div>
|
|
41
41
|
<div class="site-menu">
|
|
42
|
-
<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.
|
|
42
|
+
<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.13.0-<wbr/>alpha.1</span></a>
|
|
43
43
|
<ul class="tsd-small-nested-navigation">
|
|
44
44
|
<li><a href="../classes/CameraKit.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>Camera<wbr/>Kit</span></a></li>
|
|
45
45
|
<li><a href="../classes/TypedCustomEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Typed<wbr/>Custom<wbr/>Event</span></a></li>
|
|
@@ -55,7 +55,9 @@
|
|
|
55
55
|
<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>
|
|
56
56
|
<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>
|
|
57
57
|
<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>
|
|
58
|
-
<li><a href="../interfaces/
|
|
58
|
+
<li><a href="../interfaces/RemoteApiRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Remote<wbr/>Api<wbr/>Request</span></a></li>
|
|
59
|
+
<li><a href="../interfaces/RemoteApiResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Remote<wbr/>Api<wbr/>Response</span></a></li>
|
|
60
|
+
<li><a href="../interfaces/RemoteApiService.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Remote<wbr/>Api<wbr/>Service</span></a></li>
|
|
59
61
|
<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>
|
|
60
62
|
<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>
|
|
61
63
|
<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>
|
|
@@ -69,12 +71,15 @@
|
|
|
69
71
|
<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>
|
|
70
72
|
<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>
|
|
71
73
|
<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>
|
|
72
|
-
<li><a href="../types/
|
|
74
|
+
<li><a href="../types/RemoteApiStatus.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Remote<wbr/>Api<wbr/>Status</span></a></li>
|
|
75
|
+
<li><a href="../types/RemoteApiRequestHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Remote<wbr/>Api<wbr/>Request<wbr/>Handler</span></a></li>
|
|
76
|
+
<li><a href="../types/RemoteApiServices.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Remote<wbr/>Api<wbr/>Services</span></a></li>
|
|
73
77
|
<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>
|
|
74
78
|
<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>
|
|
75
79
|
<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>
|
|
76
80
|
<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>
|
|
77
|
-
<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>
|
|
81
|
+
<li><a href="../types/CameraKitDeviceInfo.html" class="deprecated"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Camera<wbr/>Kit<wbr/>Device<wbr/>Info</span></a></li>
|
|
82
|
+
<li><a href="../types/CameraKitDeviceOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Camera<wbr/>Kit<wbr/>Device<wbr/>Options</span></a></li>
|
|
78
83
|
<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>
|
|
79
84
|
<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>
|
|
80
85
|
<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>
|
|
@@ -104,7 +109,7 @@
|
|
|
104
109
|
<li><a href="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>
|
|
105
110
|
<li><a href="Injectable.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>Injectable</span></a></li>
|
|
106
111
|
<li><a href="lensSourcesFactory.html" class="current"><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>
|
|
107
|
-
<li><a href="
|
|
112
|
+
<li><a href="remoteApiServicesFactory.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>remote<wbr/>Api<wbr/>Services<wbr/>Factory</span></a></li>
|
|
108
113
|
<li><a href="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>
|
|
109
114
|
<li><a href="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>
|
|
110
115
|
<li><a href="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>
|
|
@@ -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>
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>remoteApiServicesFactory | CameraKit Web SDK - v0.13.0-alpha.1</title><meta name="description" content="Documentation for CameraKit Web SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
|
|
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,28 +6,25 @@
|
|
|
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.13.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">
|
|
13
13
|
<div class="tsd-page-title">
|
|
14
14
|
<ul class="tsd-breadcrumb">
|
|
15
15
|
<li><a href="../modules.html">CameraKit Web SDK</a></li>
|
|
16
|
-
<li><a href="
|
|
17
|
-
<h1>Function
|
|
16
|
+
<li><a href="remoteApiServicesFactory.html">remoteApiServicesFactory</a></li></ul>
|
|
17
|
+
<h1>Function remoteApiServicesFactory</h1></div>
|
|
18
18
|
<section class="tsd-panel">
|
|
19
19
|
<ul class="tsd-signatures">
|
|
20
|
-
<li class="tsd-signature tsd-anchor-link" id="
|
|
20
|
+
<li class="tsd-signature tsd-anchor-link" id="remoteApiServicesFactory"><span class="tsd-kind-call-signature">remote<wbr/>Api<wbr/>Services<wbr/>Factory</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/RemoteApiServices.html" class="tsd-signature-type tsd-kind-type-alias">RemoteApiServices</a><a href="#remoteApiServicesFactory" 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></li>
|
|
21
21
|
<li class="tsd-description">
|
|
22
|
-
<div class="tsd-comment tsd-typography"><p>An extension point for client URI handlers.</p>
|
|
23
|
-
</div>
|
|
24
22
|
<div class="tsd-parameters">
|
|
25
23
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
26
24
|
<ul class="tsd-parameter-list">
|
|
27
25
|
<li>
|
|
28
26
|
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span></h5></li></ul></div>
|
|
29
|
-
<h4 class="tsd-returns-title">Returns <a href="../types/
|
|
30
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></section></div>
|
|
27
|
+
<h4 class="tsd-returns-title">Returns <a href="../types/RemoteApiServices.html" class="tsd-signature-type tsd-kind-type-alias">RemoteApiServices</a></h4></li></ul></section></div>
|
|
31
28
|
<div class="col-sidebar">
|
|
32
29
|
<div class="page-menu">
|
|
33
30
|
<div class="tsd-navigation settings">
|
|
@@ -42,7 +39,7 @@
|
|
|
42
39
|
<div class="tsd-theme-toggle">
|
|
43
40
|
<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></div>
|
|
44
41
|
<div class="site-menu">
|
|
45
|
-
<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.
|
|
42
|
+
<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.13.0-<wbr/>alpha.1</span></a>
|
|
46
43
|
<ul class="tsd-small-nested-navigation">
|
|
47
44
|
<li><a href="../classes/CameraKit.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>Camera<wbr/>Kit</span></a></li>
|
|
48
45
|
<li><a href="../classes/TypedCustomEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Typed<wbr/>Custom<wbr/>Event</span></a></li>
|
|
@@ -58,7 +55,9 @@
|
|
|
58
55
|
<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>
|
|
59
56
|
<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>
|
|
60
57
|
<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>
|
|
61
|
-
<li><a href="../interfaces/
|
|
58
|
+
<li><a href="../interfaces/RemoteApiRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Remote<wbr/>Api<wbr/>Request</span></a></li>
|
|
59
|
+
<li><a href="../interfaces/RemoteApiResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Remote<wbr/>Api<wbr/>Response</span></a></li>
|
|
60
|
+
<li><a href="../interfaces/RemoteApiService.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Remote<wbr/>Api<wbr/>Service</span></a></li>
|
|
62
61
|
<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>
|
|
63
62
|
<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>
|
|
64
63
|
<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>
|
|
@@ -72,12 +71,15 @@
|
|
|
72
71
|
<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>
|
|
73
72
|
<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>
|
|
74
73
|
<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>
|
|
75
|
-
<li><a href="../types/
|
|
74
|
+
<li><a href="../types/RemoteApiStatus.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Remote<wbr/>Api<wbr/>Status</span></a></li>
|
|
75
|
+
<li><a href="../types/RemoteApiRequestHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Remote<wbr/>Api<wbr/>Request<wbr/>Handler</span></a></li>
|
|
76
|
+
<li><a href="../types/RemoteApiServices.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Remote<wbr/>Api<wbr/>Services</span></a></li>
|
|
76
77
|
<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>
|
|
77
78
|
<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>
|
|
78
79
|
<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>
|
|
79
80
|
<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>
|
|
80
|
-
<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>
|
|
81
|
+
<li><a href="../types/CameraKitDeviceInfo.html" class="deprecated"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Camera<wbr/>Kit<wbr/>Device<wbr/>Info</span></a></li>
|
|
82
|
+
<li><a href="../types/CameraKitDeviceOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Camera<wbr/>Kit<wbr/>Device<wbr/>Options</span></a></li>
|
|
81
83
|
<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>
|
|
82
84
|
<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>
|
|
83
85
|
<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>
|
|
@@ -107,7 +109,7 @@
|
|
|
107
109
|
<li><a href="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>
|
|
108
110
|
<li><a href="Injectable.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>Injectable</span></a></li>
|
|
109
111
|
<li><a href="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>
|
|
110
|
-
<li><a href="
|
|
112
|
+
<li><a href="remoteApiServicesFactory.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>remote<wbr/>Api<wbr/>Services<wbr/>Factory</span></a></li>
|
|
111
113
|
<li><a href="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>
|
|
112
114
|
<li><a href="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>
|
|
113
115
|
<li><a href="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>
|
package/docs/html/index.html
CHANGED
|
@@ -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>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>CameraKit Web SDK - v0.13.0-alpha.1</title><meta name="description" content="Documentation for CameraKit Web SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
|
|
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,12 +6,12 @@
|
|
|
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.13.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">
|
|
13
13
|
<div class="tsd-page-title">
|
|
14
|
-
<h2>CameraKit Web SDK - v0.
|
|
14
|
+
<h2>CameraKit Web SDK - v0.13.0-alpha.1</h2></div>
|
|
15
15
|
<div class="tsd-panel tsd-typography"><a id="md:snap-camera-kit-web-sdk" class="tsd-anchor"></a><h1><a href="#md:snap-camera-kit-web-sdk">Snap Camera Kit Web SDK</a></h1><p>The Camera Kit Web SDK allows web developers to build Snap's core AR Lens technology into their applications.</p>
|
|
16
16
|
<a id="md:minimum-browser-requirements" class="tsd-anchor"></a><h2><a href="#md:minimum-browser-requirements">Minimum browser requirements</a></h2><ul>
|
|
17
17
|
<li><strong>Chrome 73+</strong></li>
|
|
@@ -69,7 +69,7 @@
|
|
|
69
69
|
<p>Note that calling <code>getUserMedia</code> will prompt the user to grant the webpage access to their camera.</p>
|
|
70
70
|
</blockquote>
|
|
71
71
|
<p>Once we have a <code>CameraKitSource</code>, we can tell the <code>CameraKitSession</code> to use this source for rendering.</p>
|
|
72
|
-
<pre><code class="language-ts"><span class="hl-2">import</span><span class="hl-1"> { </span><span class="hl-0">createMediaStreamSource</span><span class="hl-1">, </span><span class="hl-0">Transform2D</span><span class="hl-1"> } </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">"@snap/camera-kit"</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">stream</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">navigator</span><span class="hl-1">.</span><span class="hl-0">mediaDevices</span><span class="hl-1">.</span><span class="hl-5">getUserMedia</span><span class="hl-1">({ </span><span class="hl-0">video:</span><span class="hl-1"> </span><span class="hl-4">true</span><span class="hl-1"> });</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">source</span><span class="hl-1"> = </span><span class="hl-5">createMediaStreamSource</span><span class="hl-1">(</span><span class="hl-0">stream</span><span class="hl-1">, { </span><span class="hl-0">transform:</span><span class="hl-1"> </span><span class="hl-0">Transform2D</span><span class="hl-1">.</span><span class="hl-0">MirrorX</span><span class="hl-1">, </span><span class="hl-0">cameraType:</span><span class="hl-1"> </span><span class="hl-3">'
|
|
72
|
+
<pre><code class="language-ts"><span class="hl-2">import</span><span class="hl-1"> { </span><span class="hl-0">createMediaStreamSource</span><span class="hl-1">, </span><span class="hl-0">Transform2D</span><span class="hl-1"> } </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">"@snap/camera-kit"</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">stream</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">navigator</span><span class="hl-1">.</span><span class="hl-0">mediaDevices</span><span class="hl-1">.</span><span class="hl-5">getUserMedia</span><span class="hl-1">({ </span><span class="hl-0">video:</span><span class="hl-1"> </span><span class="hl-4">true</span><span class="hl-1"> });</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">source</span><span class="hl-1"> = </span><span class="hl-5">createMediaStreamSource</span><span class="hl-1">(</span><span class="hl-0">stream</span><span class="hl-1">, { </span><span class="hl-0">transform:</span><span class="hl-1"> </span><span class="hl-0">Transform2D</span><span class="hl-1">.</span><span class="hl-0">MirrorX</span><span class="hl-1">, </span><span class="hl-0">cameraType:</span><span class="hl-1"> </span><span class="hl-3">'user'</span><span class="hl-1"> });</span><br/><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">session</span><span class="hl-1">.</span><span class="hl-5">setSource</span><span class="hl-1">(</span><span class="hl-0">source</span><span class="hl-1">);</span>
|
|
73
73
|
</code><button>Copy</button></pre>
|
|
74
74
|
<p>In this example, we also mirror the source stream (which feels more natural in most cases), and we indicate this source comes from a front-facing camera. To read more about these options, see <a href="#customizing-camerakitsource">below</a>.</p>
|
|
75
75
|
<p>Camera Kit Web SDK has helper methods to create a <code>CameraKitSource</code> from:</p>
|
|
@@ -108,7 +108,7 @@
|
|
|
108
108
|
<pre><code class="language-ts"><span class="hl-0">session</span><span class="hl-1">.</span><span class="hl-0">events</span><span class="hl-1">.</span><span class="hl-5">addEventListener</span><span class="hl-1">(</span><span class="hl-3">'error'</span><span class="hl-1">, (</span><span class="hl-0">event</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-0">console</span><span class="hl-1">.</span><span class="hl-5">error</span><span class="hl-1">(</span><span class="hl-0">event</span><span class="hl-1">.</span><span class="hl-0">detail</span><span class="hl-1">.</span><span class="hl-0">error</span><span class="hl-1">);</span><br/><br/><span class="hl-1"> </span><span class="hl-2">if</span><span class="hl-1"> (</span><span class="hl-0">event</span><span class="hl-1">.</span><span class="hl-0">detail</span><span class="hl-1">.</span><span class="hl-0">error</span><span class="hl-1">.</span><span class="hl-0">name</span><span class="hl-1"> === </span><span class="hl-3">'LensExecutionError'</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-7">// The currently-applied Lens encountered a problem that is most likely unrecoverable and the Lens has been removed.</span><br/><span class="hl-1"> </span><span class="hl-7">// Your application may want to prevent this Lens from being applied again.</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">});</span>
|
|
109
109
|
</code><button>Copy</button></pre>
|
|
110
110
|
<a id="md:putting-it-all-together" class="tsd-anchor"></a><h2><a href="#md:putting-it-all-together">Putting it all together</a></h2><p>Using the examples above, here's a complete example of the minimal Camera Kit Web SDK integration:</p>
|
|
111
|
-
<pre><code class="language-ts"><span class="hl-2">import</span><span class="hl-1"> { </span><span class="hl-0">boostrapCameraKit</span><span class="hl-1">, </span><span class="hl-0">createMediaStreamSource</span><span class="hl-1"> } </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">"@snap/camera-kit"</span><span class="hl-1">;</span><br/><br/><span class="hl-1">(</span><span class="hl-4">async</span><span class="hl-1"> </span><span class="hl-4">function</span><span class="hl-1"> </span><span class="hl-5">main</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">apiToken</span><span class="hl-1"> = </span><span class="hl-3">"Your API Token value copied from the SnapKit developer portal"</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">cameraKit</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-5">bootstrapCameraKit</span><span class="hl-1">({ </span><span class="hl-0">apiToken</span><span class="hl-1"> });</span><br/><br/><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">canvas</span><span class="hl-1"> = </span><span class="hl-0">document</span><span class="hl-1">.</span><span class="hl-5">getElementById</span><span class="hl-1">(</span><span class="hl-3">"my-canvas"</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">session</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">cameraKit</span><span class="hl-1">.</span><span class="hl-5">createSession</span><span class="hl-1">({ </span><span class="hl-0">liveRenderTarget:</span><span class="hl-1"> </span><span class="hl-0">canvas</span><span class="hl-1"> });</span><br/><span class="hl-1"> </span><span class="hl-0">session</span><span class="hl-1">.</span><span class="hl-0">events</span><span class="hl-1">.</span><span class="hl-5">addEventListener</span><span class="hl-1">(</span><span class="hl-3">'error'</span><span class="hl-1">, (</span><span class="hl-0">event</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">event</span><span class="hl-1">.</span><span class="hl-0">detail</span><span class="hl-1">.</span><span class="hl-0">error</span><span class="hl-1">.</span><span class="hl-0">name</span><span class="hl-1"> === </span><span class="hl-3">'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">'The current Lens encountered an error and was removed.'</span><span class="hl-1">, </span><span class="hl-0">event</span><span class="hl-1">.</span><span class="hl-0">detail</span><span class="hl-1">.</span><span class="hl-0">error</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> });</span><br/><br/><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">stream</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">navigator</span><span class="hl-1">.</span><span class="hl-0">mediaDevices</span><span class="hl-1">.</span><span class="hl-5">getUserMedia</span><span class="hl-1">({ </span><span class="hl-0">video:</span><span class="hl-1"> </span><span class="hl-4">true</span><span class="hl-1"> });</span><br/><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">source</span><span class="hl-1"> = </span><span class="hl-5">createMediaStreamSource</span><span class="hl-1">(</span><span class="hl-0">stream</span><span class="hl-1">, { </span><span class="hl-0">transform:</span><span class="hl-1"> </span><span class="hl-0">Transform2D</span><span class="hl-1">.</span><span class="hl-0">MirrorX</span><span class="hl-1">, </span><span class="hl-0">cameraType:</span><span class="hl-1"> </span><span class="hl-3">'
|
|
111
|
+
<pre><code class="language-ts"><span class="hl-2">import</span><span class="hl-1"> { </span><span class="hl-0">boostrapCameraKit</span><span class="hl-1">, </span><span class="hl-0">createMediaStreamSource</span><span class="hl-1"> } </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">"@snap/camera-kit"</span><span class="hl-1">;</span><br/><br/><span class="hl-1">(</span><span class="hl-4">async</span><span class="hl-1"> </span><span class="hl-4">function</span><span class="hl-1"> </span><span class="hl-5">main</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">apiToken</span><span class="hl-1"> = </span><span class="hl-3">"Your API Token value copied from the SnapKit developer portal"</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">cameraKit</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-5">bootstrapCameraKit</span><span class="hl-1">({ </span><span class="hl-0">apiToken</span><span class="hl-1"> });</span><br/><br/><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">canvas</span><span class="hl-1"> = </span><span class="hl-0">document</span><span class="hl-1">.</span><span class="hl-5">getElementById</span><span class="hl-1">(</span><span class="hl-3">"my-canvas"</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">session</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">cameraKit</span><span class="hl-1">.</span><span class="hl-5">createSession</span><span class="hl-1">({ </span><span class="hl-0">liveRenderTarget:</span><span class="hl-1"> </span><span class="hl-0">canvas</span><span class="hl-1"> });</span><br/><span class="hl-1"> </span><span class="hl-0">session</span><span class="hl-1">.</span><span class="hl-0">events</span><span class="hl-1">.</span><span class="hl-5">addEventListener</span><span class="hl-1">(</span><span class="hl-3">'error'</span><span class="hl-1">, (</span><span class="hl-0">event</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">event</span><span class="hl-1">.</span><span class="hl-0">detail</span><span class="hl-1">.</span><span class="hl-0">error</span><span class="hl-1">.</span><span class="hl-0">name</span><span class="hl-1"> === </span><span class="hl-3">'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">'The current Lens encountered an error and was removed.'</span><span class="hl-1">, </span><span class="hl-0">event</span><span class="hl-1">.</span><span class="hl-0">detail</span><span class="hl-1">.</span><span class="hl-0">error</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> });</span><br/><br/><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">stream</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">navigator</span><span class="hl-1">.</span><span class="hl-0">mediaDevices</span><span class="hl-1">.</span><span class="hl-5">getUserMedia</span><span class="hl-1">({ </span><span class="hl-0">video:</span><span class="hl-1"> </span><span class="hl-4">true</span><span class="hl-1"> });</span><br/><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">source</span><span class="hl-1"> = </span><span class="hl-5">createMediaStreamSource</span><span class="hl-1">(</span><span class="hl-0">stream</span><span class="hl-1">, { </span><span class="hl-0">transform:</span><span class="hl-1"> </span><span class="hl-0">Transform2D</span><span class="hl-1">.</span><span class="hl-0">MirrorX</span><span class="hl-1">, </span><span class="hl-0">cameraType:</span><span class="hl-1"> </span><span class="hl-3">'user'</span><span class="hl-1"> });</span><br/><span class="hl-1"> </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">session</span><span class="hl-1">.</span><span class="hl-5">setSource</span><span class="hl-1">(</span><span class="hl-0">source</span><span class="hl-1">);</span><br/><br/><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">lens</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">cameraKit</span><span class="hl-1">.</span><span class="hl-0">lensRepository</span><span class="hl-1">.</span><span class="hl-5">loadLens</span><span class="hl-1">(</span><span class="hl-3">"<Lens ID>"</span><span class="hl-1">, </span><span class="hl-3">"<Lens Group ID>"</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">session</span><span class="hl-1">.</span><span class="hl-5">applyLens</span><span class="hl-1">(</span><span class="hl-0">lens</span><span class="hl-1">);</span><br/><br/><span class="hl-1"> </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">session</span><span class="hl-1">.</span><span class="hl-5">play</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-3">"Lens rendering has started!"</span><span class="hl-1">);</span><br/><span class="hl-1">})();</span><br/><br/><span class="hl-5">main</span><span class="hl-1">();</span>
|
|
112
112
|
</code><button>Copy</button></pre>
|
|
113
113
|
<a id="md:advanced-use-cases" class="tsd-anchor"></a><h2><a href="#md:advanced-use-cases">Advanced use cases</a></h2><a id="md:logging" class="tsd-anchor"></a><h3><a href="#md:logging">Logging</a></h3><p>By default, Camera Kit Web SDK does very minimal logging. Specifying <code>'console'</code> as logger will cause more log statements to be printed to the browser's console, which may be useful during development.</p>
|
|
114
114
|
<pre><code class="language-ts"><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">cameraKit</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-5">bootstrapCameraKit</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-0">apiToken:</span><span class="hl-1"> </span><span class="hl-3">'<apiToken>'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">logger:</span><span class="hl-1"> </span><span class="hl-3">'console'</span><span class="hl-1">,</span><br/><span class="hl-1">});</span>
|
|
@@ -129,7 +129,7 @@
|
|
|
129
129
|
<p>When calling <a href="https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia"><code>getUserMedia</code></a>, best performance can be achieved by requesting the resolution at which you want to render. This can be done using <a href="https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia#parameters">constraints</a>. Then you won't have to use <code>setRenderSize</code> at all.</p>
|
|
130
130
|
</blockquote>
|
|
131
131
|
<a id="md:camera-type" class="tsd-anchor"></a><h4><a href="#md:camera-type">Camera type</a></h4><p>When setting up a <code>CameraKitSource</code>, you can specify whether or not it is a front facing camera or a back facing camera. By default, the media source will be treated as a front facing camera. If it is a back facing camera be sure to specify it as such when you create your source; this ensures that Lenses created for back facing camera's (e.g. World AR) render properly.</p>
|
|
132
|
-
<pre><code class="language-ts"><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">stream</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">navigator</span><span class="hl-1">.</span><span class="hl-0">mediaDevices</span><span class="hl-1">.</span><span class="hl-5">getUserMedia</span><span class="hl-1">(</span><span class="hl-0">constraints</span><span class="hl-1">);</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">source</span><span class="hl-1"> = </span><span class="hl-5">createMediaStreamSource</span><span class="hl-1">(</span><span class="hl-0">stream</span><span class="hl-1">, { </span><span class="hl-0">cameraType:</span><span class="hl-1"> </span><span class="hl-3">'
|
|
132
|
+
<pre><code class="language-ts"><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">stream</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">navigator</span><span class="hl-1">.</span><span class="hl-0">mediaDevices</span><span class="hl-1">.</span><span class="hl-5">getUserMedia</span><span class="hl-1">(</span><span class="hl-0">constraints</span><span class="hl-1">);</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">source</span><span class="hl-1"> = </span><span class="hl-5">createMediaStreamSource</span><span class="hl-1">(</span><span class="hl-0">stream</span><span class="hl-1">, { </span><span class="hl-0">cameraType:</span><span class="hl-1"> </span><span class="hl-3">'environment'</span><span class="hl-1"> });</span><br/><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">session</span><span class="hl-1">.</span><span class="hl-5">setSource</span><span class="hl-1">(</span><span class="hl-0">source</span><span class="hl-1">);</span>
|
|
133
133
|
</code><button>Copy</button></pre>
|
|
134
134
|
<a id="md:fps-limit" class="tsd-anchor"></a><h4><a href="#md:fps-limit">FPS limit</a></h4><p>In some cases, it may be desirable to set a limit on the FPS at which Camera Kit renders. By default, Camera Kit will attempt to render frames at the same rate as the source media. But, for example, if your input media source has a very high framerate you may want to limit Camera Kit's rendering framerate to achieve better performance.</p>
|
|
135
135
|
<p>This can be done at the <code>CameraKitSession</code> level:</p>
|
|
@@ -150,6 +150,28 @@
|
|
|
150
150
|
<p>You may listen to these events like so:</p>
|
|
151
151
|
<pre><code class="language-ts"><span class="hl-0">cameraKit</span><span class="hl-1">.</span><span class="hl-0">metrics</span><span class="hl-1">.</span><span class="hl-5">addEventListener</span><span class="hl-1">(</span><span class="hl-3">'lensView'</span><span class="hl-1">, (</span><span class="hl-0">event</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-0">console</span><span class="hl-1">.</span><span class="hl-5">debug</span><span class="hl-1">(</span><span class="hl-0">event</span><span class="hl-1">.</span><span class="hl-0">detail</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
|
|
152
152
|
</code><button>Copy</button></pre>
|
|
153
|
+
<p><<<<<<< HEAD</p>
|
|
154
|
+
<a id="md:error-handling-1" class="tsd-anchor"></a><h3><a href="#md:error-handling-1">Error Handling</a></h3><p>Camera Kit Web SDK methods may throw errors, or return rejected Promises -- these are documented in the <a href="https://kit.snapchat.com/reference/CameraKit/web/0.11.0/index.html">API docs</a>. It is good practice to handle such cases, to provide a good experience to your users.</p>
|
|
155
|
+
<p>Errors may also occur during Lens rendering. For example, if the Lens that has been applied contains a bug -- Lenses have their own internal scripts, which can fail. A rendering error could also occur if a Lens depends on a feature that is not supported by Camera Kit Web SDK.</p>
|
|
156
|
+
<p>When a <code>LensExecutionError</code> such as these occurs, the Lens is <strong>automatically removed</strong> from the <code>CameraKitSession</code>. An error event is emitted so that your application can respond appropriately. You can listen to these error events like so:</p>
|
|
157
|
+
<pre><code class="language-ts"><span class="hl-0">session</span><span class="hl-1">.</span><span class="hl-0">events</span><span class="hl-1">.</span><span class="hl-5">addEventListener</span><span class="hl-1">(</span><span class="hl-3">'error'</span><span class="hl-1">, (</span><span class="hl-0">event</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-0">console</span><span class="hl-1">.</span><span class="hl-5">error</span><span class="hl-1">(</span><span class="hl-0">event</span><span class="hl-1">.</span><span class="hl-0">detail</span><span class="hl-1">.</span><span class="hl-0">error</span><span class="hl-1">);</span><br/><br/><span class="hl-1"> </span><span class="hl-2">if</span><span class="hl-1"> (</span><span class="hl-0">event</span><span class="hl-1">.</span><span class="hl-0">detail</span><span class="hl-1">.</span><span class="hl-0">error</span><span class="hl-1">.</span><span class="hl-0">name</span><span class="hl-1"> === </span><span class="hl-3">'LensExecutionError'</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-7">// The currently-applied Lens encountered a problem that is most likely unrecoverable and the Lens has been removed.</span><br/><span class="hl-1"> </span><span class="hl-7">// Your application may want to do something to prevent this Lens from being applied again.</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">});</span>
|
|
158
|
+
</code><button>Copy</button></pre>
|
|
159
|
+
<p>=======</p>
|
|
160
|
+
<blockquote>
|
|
161
|
+
<blockquote>
|
|
162
|
+
<blockquote>
|
|
163
|
+
<blockquote>
|
|
164
|
+
<blockquote>
|
|
165
|
+
<blockquote>
|
|
166
|
+
<blockquote>
|
|
167
|
+
<p>76e624ce ([CAMKIT-4384] README: error handling gets greater emphasis)</p>
|
|
168
|
+
</blockquote>
|
|
169
|
+
</blockquote>
|
|
170
|
+
</blockquote>
|
|
171
|
+
</blockquote>
|
|
172
|
+
</blockquote>
|
|
173
|
+
</blockquote>
|
|
174
|
+
</blockquote>
|
|
153
175
|
</div></div>
|
|
154
176
|
<div class="col-sidebar">
|
|
155
177
|
<div class="page-menu">
|
|
@@ -212,9 +234,10 @@
|
|
|
212
234
|
<li><a href="#md:camera-type"><span>Camera type</span></a></li>
|
|
213
235
|
<li><a href="#md:fps-limit"><span>FPS limit</span></a></li>
|
|
214
236
|
<li><a href="#md:2d-transforms"><span>2<wbr/>D transforms</span></a></li></ul></li>
|
|
215
|
-
<li><a href="#md:metrics-reporting"><span>Metrics reporting</span></a></li
|
|
237
|
+
<li><a href="#md:metrics-reporting"><span>Metrics reporting</span></a></li>
|
|
238
|
+
<li><a href="#md:error-handling-1"><span>Error <wbr/>Handling</span></a></li></ul></li></ul></li></ul></li></ul></div></details></div>
|
|
216
239
|
<div class="site-menu">
|
|
217
|
-
<nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>Camera<wbr/>Kit <wbr/>Web SDK -<wbr/> v0.
|
|
240
|
+
<nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>Camera<wbr/>Kit <wbr/>Web SDK -<wbr/> v0.13.0-<wbr/>alpha.1</span></a>
|
|
218
241
|
<ul class="tsd-small-nested-navigation">
|
|
219
242
|
<li><a href="classes/CameraKit.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>Camera<wbr/>Kit</span></a></li>
|
|
220
243
|
<li><a href="classes/TypedCustomEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Typed<wbr/>Custom<wbr/>Event</span></a></li>
|
|
@@ -230,7 +253,9 @@
|
|
|
230
253
|
<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>
|
|
231
254
|
<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>
|
|
232
255
|
<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>
|
|
233
|
-
<li><a href="interfaces/
|
|
256
|
+
<li><a href="interfaces/RemoteApiRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Remote<wbr/>Api<wbr/>Request</span></a></li>
|
|
257
|
+
<li><a href="interfaces/RemoteApiResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Remote<wbr/>Api<wbr/>Response</span></a></li>
|
|
258
|
+
<li><a href="interfaces/RemoteApiService.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Remote<wbr/>Api<wbr/>Service</span></a></li>
|
|
234
259
|
<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>
|
|
235
260
|
<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>
|
|
236
261
|
<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>
|
|
@@ -244,12 +269,15 @@
|
|
|
244
269
|
<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>
|
|
245
270
|
<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>
|
|
246
271
|
<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>
|
|
247
|
-
<li><a href="types/
|
|
272
|
+
<li><a href="types/RemoteApiStatus.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Remote<wbr/>Api<wbr/>Status</span></a></li>
|
|
273
|
+
<li><a href="types/RemoteApiRequestHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Remote<wbr/>Api<wbr/>Request<wbr/>Handler</span></a></li>
|
|
274
|
+
<li><a href="types/RemoteApiServices.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Remote<wbr/>Api<wbr/>Services</span></a></li>
|
|
248
275
|
<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>
|
|
249
276
|
<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>
|
|
250
277
|
<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>
|
|
251
278
|
<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>
|
|
252
|
-
<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>
|
|
279
|
+
<li><a href="types/CameraKitDeviceInfo.html" class="deprecated"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Camera<wbr/>Kit<wbr/>Device<wbr/>Info</span></a></li>
|
|
280
|
+
<li><a href="types/CameraKitDeviceOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Camera<wbr/>Kit<wbr/>Device<wbr/>Options</span></a></li>
|
|
253
281
|
<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>
|
|
254
282
|
<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>
|
|
255
283
|
<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>
|
|
@@ -279,7 +307,7 @@
|
|
|
279
307
|
<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>
|
|
280
308
|
<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>
|
|
281
309
|
<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>
|
|
282
|
-
<li><a href="functions/
|
|
310
|
+
<li><a href="functions/remoteApiServicesFactory.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>remote<wbr/>Api<wbr/>Services<wbr/>Factory</span></a></li>
|
|
283
311
|
<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>
|
|
284
312
|
<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>
|
|
285
313
|
<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>
|