@snap/camera-kit 0.14.0 → 0.15.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/LICENSE.md +5921 -1485
- package/README.md +1 -1
- package/docs/html/assets/search.js +1 -1
- package/docs/html/classes/CameraKit.html +7 -7
- package/docs/html/classes/CameraKitSession.html +17 -25
- package/docs/html/classes/CameraKitSource.html +15 -10
- package/docs/html/classes/LensPerformanceMeasurement.html +7 -7
- package/docs/html/classes/LensPerformanceMetrics.html +7 -7
- package/docs/html/classes/LensRepository.html +7 -7
- package/docs/html/classes/Transform2D.html +7 -7
- package/docs/html/classes/TypedCustomEvent.html +7 -7
- package/docs/html/classes/TypedEventTarget.html +7 -7
- package/docs/html/functions/ConcatInjectable.html +202 -0
- package/docs/html/functions/Injectable.html +15 -16
- package/docs/html/functions/bootstrapCameraKit.html +7 -7
- package/docs/html/functions/createExtension.html +7 -7
- package/docs/html/functions/createImageSource.html +7 -7
- package/docs/html/functions/createMediaStreamSource.html +7 -7
- package/docs/html/functions/createUserMediaSource.html +7 -7
- package/docs/html/functions/createVideoSource.html +7 -7
- package/docs/html/functions/estimateLensPerformance.html +7 -7
- package/docs/html/functions/getRequiredBootstrapURLs.html +7 -7
- package/docs/html/functions/lensSourcesFactory.html +17 -9
- package/docs/html/functions/remoteApiServicesFactory.html +7 -7
- package/docs/html/index.html +9 -9
- package/docs/html/interfaces/CameraKitBootstrapConfiguration.html +7 -7
- package/docs/html/interfaces/CameraKitSourceSubscriber.html +7 -7
- package/docs/html/interfaces/ComputedFrameMetrics.html +7 -7
- package/docs/html/interfaces/CreateSessionOptions.html +7 -7
- package/docs/html/interfaces/EstimatedLensPerformance.html +7 -7
- package/docs/html/interfaces/Lens.html +7 -7
- package/docs/html/interfaces/LensLaunchData.html +183 -0
- package/docs/html/interfaces/LensSource.html +28 -46
- package/docs/html/interfaces/MediaStreamSourceOptions.html +7 -7
- package/docs/html/interfaces/Preview.html +7 -7
- package/docs/html/interfaces/RemoteApiRequest.html +7 -7
- package/docs/html/interfaces/RemoteApiResponse.html +7 -7
- package/docs/html/interfaces/RemoteApiService.html +7 -7
- package/docs/html/interfaces/Snapcode.html +7 -7
- package/docs/html/interfaces/UriCancelRequest.html +7 -7
- package/docs/html/interfaces/UriRequest.html +7 -7
- package/docs/html/interfaces/UriResponse.html +7 -7
- package/docs/html/interfaces/VideoSourceOptions.html +7 -7
- package/docs/html/modules.html +12 -12
- package/docs/html/types/AssetLoader.html +7 -7
- package/docs/html/types/AssetTiming.html +7 -7
- package/docs/html/types/BenchmarkError.html +7 -7
- package/docs/html/types/BootstrapError.html +7 -7
- package/docs/html/types/CacheKeyNotFoundError.html +7 -7
- package/docs/html/types/CameraKitDeviceInfo.html +7 -7
- package/docs/html/types/CameraKitDeviceOptions.html +7 -7
- package/docs/html/types/CameraKitSessionEventListener.html +7 -7
- package/docs/html/types/CameraKitSessionEvents.html +7 -7
- package/docs/html/types/CameraKitSourceError.html +7 -7
- package/docs/html/types/CameraKitSourceInfo.html +7 -7
- package/docs/html/types/CameraKitSourceOptions.html +7 -7
- package/docs/html/types/ConfigurationError.html +7 -7
- package/docs/html/types/Keyboard.html +7 -7
- package/docs/html/types/KeyboardEvents.html +7 -7
- package/docs/html/types/LegalError.html +7 -7
- package/docs/html/types/LensAbortError.html +7 -7
- package/docs/html/types/LensAssetError.html +7 -7
- package/docs/html/types/LensContentValidationError.html +7 -7
- package/docs/html/types/LensError.html +7 -7
- package/docs/html/types/LensExecutionError.html +7 -7
- package/docs/html/types/LensImagePickerError.html +7 -7
- package/docs/html/types/LensMetricsEvents.html +7 -7
- package/docs/html/types/LensPerformanceCluster.html +7 -7
- package/docs/html/types/LensView.html +7 -7
- package/docs/html/types/LensWait.html +7 -7
- package/docs/html/types/PersistentStoreError.html +7 -7
- package/docs/html/types/PlatformNotSupportedError.html +7 -7
- package/docs/html/types/PublicContainer.html +7 -7
- package/docs/html/types/RemoteApiRequestHandler.html +7 -7
- package/docs/html/types/RemoteApiServices.html +7 -7
- package/docs/html/types/RemoteApiStatus.html +7 -7
- package/docs/html/types/RenderTarget.html +7 -7
- package/docs/html/types/Uri.html +7 -7
- package/docs/html/types/WebGLError.html +7 -7
- package/docs/html/variables/extensionRequestContext.html +7 -7
- package/docs/md/README.md +1 -1
- package/docs/md/classes/CameraKit.md +1 -1
- package/docs/md/classes/CameraKitSession.md +11 -22
- package/docs/md/classes/CameraKitSource.md +11 -5
- 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/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/LensLaunchData.md +53 -0
- package/docs/md/interfaces/LensSource.md +23 -25
- package/docs/md/interfaces/MediaStreamSourceOptions.md +1 -1
- package/docs/md/interfaces/Preview.md +1 -1
- package/docs/md/interfaces/RemoteApiRequest.md +1 -1
- package/docs/md/interfaces/RemoteApiResponse.md +1 -1
- package/docs/md/interfaces/RemoteApiService.md +1 -1
- package/docs/md/interfaces/Snapcode.md +1 -1
- package/docs/md/interfaces/UriCancelRequest.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 +125 -28
- package/lib/CameraKit.d.ts +14 -6
- package/lib/__tests__/data.d.ts +2 -2
- package/lib/__tests__/data.js +2 -2
- package/lib/__tests__/data.js.map +1 -1
- package/lib/bootstrapCameraKit.js +12 -3
- package/lib/bootstrapCameraKit.js.map +1 -1
- package/lib/clients/createTsProtoClient.d.ts +47 -0
- package/lib/clients/createTsProtoClient.js +53 -0
- package/lib/clients/createTsProtoClient.js.map +1 -0
- package/lib/clients/grpcHandler.d.ts +23 -0
- package/lib/clients/grpcHandler.js +87 -0
- package/lib/clients/grpcHandler.js.map +1 -0
- package/lib/clients/lensesClient.d.ts +9 -0
- package/lib/clients/lensesClient.js +6 -0
- package/lib/clients/lensesClient.js.map +1 -0
- package/lib/common/entries.d.ts +1 -0
- package/lib/common/entries.js +2 -0
- package/lib/common/entries.js.map +1 -1
- package/lib/common/result.d.ts +36 -0
- package/lib/common/result.js +40 -0
- package/lib/common/result.js.map +1 -0
- package/lib/common/unionBy.d.ts +28 -0
- package/lib/common/unionBy.js +46 -0
- package/lib/common/unionBy.js.map +1 -0
- package/lib/configuration.js +14 -1
- package/lib/configuration.js.map +1 -1
- package/lib/dependency-injection/Injectable.d.ts +67 -11
- package/lib/dependency-injection/Injectable.js +21 -2
- package/lib/dependency-injection/Injectable.js.map +1 -1
- package/lib/dependency-injection/RootServices.d.ts +5 -1
- package/lib/dependency-injection/RootServices.js.map +1 -1
- package/lib/environment.json +1 -1
- package/lib/extensions/RemoteApiServices.d.ts +1 -1
- package/lib/extensions/RemoteApiServices.js +7 -7
- package/lib/extensions/RemoteApiServices.js.map +1 -1
- package/lib/extensions/uriHandlersRegister.d.ts +6 -6
- package/lib/extensions/uriHandlersRegister.js +1 -1
- package/lib/extensions/uriHandlersRegister.js.map +1 -1
- package/lib/generated-proto/blizzard/cameraKitEvents.js.map +1 -1
- package/lib/generated-proto/pb_schema/camera_kit/v3/business_events.d.ts +15 -17
- package/lib/generated-proto/pb_schema/camera_kit/v3/business_events.js +62 -69
- package/lib/generated-proto/pb_schema/camera_kit/v3/business_events.js.map +1 -1
- package/lib/generated-proto/pb_schema/camera_kit/v3/export.d.ts +6 -0
- package/lib/generated-proto/pb_schema/camera_kit/v3/export.js +68 -0
- package/lib/generated-proto/pb_schema/camera_kit/v3/export.js.map +1 -1
- package/lib/generated-proto/pb_schema/camera_kit/v3/legal_prompt.d.ts +5 -6
- package/lib/generated-proto/pb_schema/camera_kit/v3/legal_prompt.js +11 -25
- package/lib/generated-proto/pb_schema/camera_kit/v3/legal_prompt.js.map +1 -1
- package/lib/generated-proto/pb_schema/camera_kit/v3/lens.d.ts +19 -14
- package/lib/generated-proto/pb_schema/camera_kit/v3/lens.js +145 -64
- package/lib/generated-proto/pb_schema/camera_kit/v3/lens.js.map +1 -1
- package/lib/generated-proto/pb_schema/camera_kit/v3/operational_metrics.d.ts +2 -0
- package/lib/generated-proto/pb_schema/camera_kit/v3/operational_metrics.js +30 -0
- package/lib/generated-proto/pb_schema/camera_kit/v3/operational_metrics.js.map +1 -1
- package/lib/generated-proto/pb_schema/camera_kit/v3/ranking.d.ts +15 -16
- package/lib/generated-proto/pb_schema/camera_kit/v3/ranking.js +36 -62
- package/lib/generated-proto/pb_schema/camera_kit/v3/ranking.js.map +1 -1
- package/lib/generated-proto/pb_schema/camera_kit/v3/service.d.ts +1294 -12
- package/lib/generated-proto/pb_schema/camera_kit/v3/service.js +200 -0
- package/lib/generated-proto/pb_schema/camera_kit/v3/service.js.map +1 -1
- package/lib/generated-proto/pb_schema/cdp/cof/config_result.d.ts +4 -0
- package/lib/generated-proto/pb_schema/cdp/cof/config_result.js +4 -0
- package/lib/generated-proto/pb_schema/cdp/cof/config_result.js.map +1 -1
- package/lib/generated-proto/pb_schema/google/protobuf/descriptor.d.ts +39 -45
- package/lib/generated-proto/pb_schema/google/protobuf/descriptor.js +74 -192
- package/lib/generated-proto/pb_schema/google/protobuf/descriptor.js.map +1 -1
- package/lib/handlers/defaultFetchHandler.js +1 -5
- package/lib/handlers/defaultFetchHandler.js.map +1 -1
- package/lib/index.d.ts +3 -3
- package/lib/index.js +2 -6
- package/lib/index.js.map +1 -1
- package/lib/lens/Lens.d.ts +2 -12
- package/lib/lens/Lens.js +2 -2
- package/lib/lens/Lens.js.map +1 -1
- package/lib/lens/LensLaunchData.d.ts +37 -0
- package/lib/lens/LensLaunchData.js +35 -0
- package/lib/lens/LensLaunchData.js.map +1 -0
- package/lib/lens/LensRepository.d.ts +4 -7
- package/lib/lens/LensRepository.js +24 -35
- package/lib/lens/LensRepository.js.map +1 -1
- package/lib/lens/LensSource.d.ts +43 -0
- package/lib/lens/LensSource.js +42 -0
- package/lib/lens/LensSource.js.map +1 -0
- package/lib/lens/assets/LensAssetRepository.js +2 -4
- package/lib/lens/assets/LensAssetRepository.js.map +1 -1
- package/lib/lens/assets/LensAssetsProvider.d.ts +1 -1
- package/lib/lens/cameraKitLensSource.d.ts +16 -0
- package/lib/lens/cameraKitLensSource.js +59 -0
- package/lib/lens/cameraKitLensSource.js.map +1 -0
- package/lib/lens-core-module/lensCore.d.ts +2 -1
- package/lib/lens-core-module/lensCore.js +6 -1
- package/lib/lens-core-module/lensCore.js.map +1 -1
- package/lib/lens-core-module/lensCoreError.js +1 -1
- package/lib/lens-core-module/lensCoreError.js.map +1 -1
- package/lib/lensCoreWasmVersions.json +3 -3
- package/lib/media-sources/CameraKitSource.d.ts +10 -4
- package/lib/media-sources/CameraKitSource.js +11 -4
- package/lib/media-sources/CameraKitSource.js.map +1 -1
- package/lib/media-sources/ImageSource.js +1 -11
- package/lib/media-sources/ImageSource.js.map +1 -1
- package/lib/media-sources/MediaStreamSource.js +1 -5
- package/lib/media-sources/MediaStreamSource.js.map +1 -1
- package/lib/media-sources/VideoSource.js +1 -11
- package/lib/media-sources/VideoSource.js.map +1 -1
- package/lib/metrics/businessEventsReporter.js +1 -1
- package/lib/metrics/businessEventsReporter.js.map +1 -1
- package/lib/metrics/reporters/reportGlobalException.d.ts +7 -0
- package/lib/metrics/reporters/reportGlobalException.js +22 -4
- package/lib/metrics/reporters/reportGlobalException.js.map +1 -1
- package/lib/metrics/reporters/reportHttpMetrics.js +14 -0
- package/lib/metrics/reporters/reportHttpMetrics.js.map +1 -1
- package/lib/metrics/reporters/reportLensValidationFailed.d.ts +1 -1
- package/lib/metrics/reporters/reportLensView.d.ts +1 -1
- package/lib/metrics/reporters/reportLensWait.d.ts +1 -1
- package/lib/metrics/reporters/reportSessionException.d.ts +1 -1
- package/lib/metrics/reporters/reporters.d.ts +1 -1
- package/lib/persistence/ExpiringPersistence.js +3 -4
- package/lib/persistence/ExpiringPersistence.js.map +1 -1
- package/lib/platform/platformCapabilities.js +2 -1
- package/lib/platform/platformCapabilities.js.map +1 -1
- package/lib/platform/platformInfo.js +1 -1
- package/lib/platform/platformInfo.js.map +1 -1
- package/lib/remote-configuration/cofHandler.d.ts +1 -0
- package/lib/remote-configuration/cofHandler.js +61 -50
- package/lib/remote-configuration/cofHandler.js.map +1 -1
- package/lib/session/CameraKitSession.d.ts +9 -11
- package/lib/session/CameraKitSession.js +22 -18
- package/lib/session/CameraKitSession.js.map +1 -1
- package/lib/session/CameraKitSessionEvents.d.ts +1 -1
- package/lib/session/CameraKitSessionEvents.js.map +1 -1
- package/lib/session/LensKeyboard.d.ts +7 -1
- package/lib/session/lensState.d.ts +3 -3
- package/lib/session/lensState.js +40 -15
- package/lib/session/lensState.js.map +1 -1
- package/package.json +1 -1
- package/docs/html/classes/LensSources.html +0 -160
- package/docs/html/types/LensLaunchParams.html +0 -115
- package/docs/md/classes/LensSources.md +0 -29
- package/lib/common/any.d.ts +0 -19
- package/lib/common/any.js +0 -53
- package/lib/common/any.js.map +0 -1
- package/lib/extensions/LensSources.d.ts +0 -58
- package/lib/extensions/LensSources.js +0 -54
- package/lib/extensions/LensSources.js.map +0 -1
- package/lib/lens/LensLaunchParams.d.ts +0 -19
- package/lib/lens/LensLaunchParams.js +0 -40
- package/lib/lens/LensLaunchParams.js.map +0 -1
- package/lib/lens/index.d.ts +0 -7
- package/lib/lens/index.js +0 -7
- package/lib/lens/index.js.map +0 -1
- package/lib/lens/lensEnvelopeUtil.d.ts +0 -5
- package/lib/lens/lensEnvelopeUtil.js +0 -19
- package/lib/lens/lensEnvelopeUtil.js.map +0 -1
- package/lib/lens/lensHttpUtil.d.ts +0 -5
- package/lib/lens/lensHttpUtil.js +0 -52
- package/lib/lens/lensHttpUtil.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>estimateLensPerformance | 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>estimateLensPerformance | CameraKit Web SDK - v0.15.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.15.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,12 +39,11 @@ which the CameraKit SDK can use to optimize certain lenses.</p>
|
|
|
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.15.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>
|
|
46
46
|
<li><a href="../classes/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>
|
|
47
|
-
<li><a href="../classes/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>
|
|
48
47
|
<li><a href="../classes/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>
|
|
49
48
|
<li><a href="../classes/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>
|
|
50
49
|
<li><a href="../classes/CameraKitSession.html"><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>
|
|
@@ -54,7 +53,6 @@ which the CameraKit SDK can use to optimize certain lenses.</p>
|
|
|
54
53
|
<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>
|
|
55
54
|
<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
55
|
<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
|
-
<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
56
|
<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
57
|
<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
58
|
<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>
|
|
@@ -64,6 +62,8 @@ which the CameraKit SDK can use to optimize certain lenses.</p>
|
|
|
64
62
|
<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>
|
|
65
63
|
<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>
|
|
66
64
|
<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>
|
|
65
|
+
<li><a href="../interfaces/LensLaunchData.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Lens<wbr/>Launch<wbr/>Data</span></a></li>
|
|
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
67
|
<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>
|
|
68
68
|
<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>
|
|
69
69
|
<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>
|
|
@@ -75,7 +75,6 @@ which the CameraKit SDK can use to optimize certain lenses.</p>
|
|
|
75
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
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>
|
|
77
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>
|
|
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>
|
|
79
78
|
<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>
|
|
80
79
|
<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>
|
|
81
80
|
<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>
|
|
@@ -109,9 +108,10 @@ which the CameraKit SDK can use to optimize certain lenses.</p>
|
|
|
109
108
|
<li><a href="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>
|
|
110
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>
|
|
111
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>
|
|
112
|
-
<li><a href="
|
|
111
|
+
<li><a href="ConcatInjectable.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>Concat<wbr/>Injectable</span></a></li>
|
|
113
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>
|
|
114
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>
|
|
114
|
+
<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>
|
|
115
115
|
<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>
|
|
116
116
|
<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>
|
|
117
117
|
<li><a href="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>
|
|
@@ -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.15.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.15.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,12 +48,11 @@ 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.15.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>
|
|
55
55
|
<li><a href="../classes/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>
|
|
56
|
-
<li><a href="../classes/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>
|
|
57
56
|
<li><a href="../classes/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>
|
|
58
57
|
<li><a href="../classes/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>
|
|
59
58
|
<li><a href="../classes/CameraKitSession.html"><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>
|
|
@@ -63,7 +62,6 @@ bootstrapped.</p>
|
|
|
63
62
|
<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>
|
|
64
63
|
<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
64
|
<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
|
-
<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
65
|
<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
66
|
<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
67
|
<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>
|
|
@@ -73,6 +71,8 @@ bootstrapped.</p>
|
|
|
73
71
|
<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>
|
|
74
72
|
<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>
|
|
75
73
|
<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>
|
|
74
|
+
<li><a href="../interfaces/LensLaunchData.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Lens<wbr/>Launch<wbr/>Data</span></a></li>
|
|
75
|
+
<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>
|
|
76
76
|
<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>
|
|
77
77
|
<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>
|
|
78
78
|
<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>
|
|
@@ -84,7 +84,6 @@ bootstrapped.</p>
|
|
|
84
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
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>
|
|
86
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>
|
|
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>
|
|
88
87
|
<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>
|
|
89
88
|
<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>
|
|
90
89
|
<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>
|
|
@@ -118,9 +117,10 @@ bootstrapped.</p>
|
|
|
118
117
|
<li><a href="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>
|
|
119
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>
|
|
120
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>
|
|
121
|
-
<li><a href="
|
|
120
|
+
<li><a href="ConcatInjectable.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>Concat<wbr/>Injectable</span></a></li>
|
|
122
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>
|
|
123
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>
|
|
123
|
+
<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>
|
|
124
124
|
<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>
|
|
125
125
|
<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>
|
|
126
126
|
<li><a href="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>
|
|
@@ -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.15.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.15.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">
|
|
@@ -17,14 +17,22 @@
|
|
|
17
17
|
<h1>Function lensSourcesFactory</h1></div>
|
|
18
18
|
<section class="tsd-panel">
|
|
19
19
|
<ul class="tsd-signatures">
|
|
20
|
-
<li class="tsd-signature tsd-anchor-link" id="lensSourcesFactory"><span class="tsd-kind-call-signature">lens<wbr/>Sources<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="../
|
|
20
|
+
<li class="tsd-signature tsd-anchor-link" id="lensSourcesFactory"><span class="tsd-kind-call-signature">lens<wbr/>Sources<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="../interfaces/LensSource.html" class="tsd-signature-type tsd-kind-interface">LensSource</a><span class="tsd-signature-symbol">[]</span><a href="#lensSourcesFactory" 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>By default, no custom LensSources are provided to CameraKit. But to enable certain advanced use-cases,
|
|
23
|
+
applications may provide their own LensSources.</p>
|
|
24
|
+
<p>Perhaps the most convenient way to do this is with <a href="ConcatInjectable.html" class="tsd-kind-function">ConcatInjectable</a>, as shown here:</p>
|
|
25
|
+
</div>
|
|
22
26
|
<div class="tsd-parameters">
|
|
23
27
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
24
28
|
<ul class="tsd-parameter-list">
|
|
25
29
|
<li>
|
|
26
30
|
<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>
|
|
27
|
-
<h4 class="tsd-returns-title">Returns <a href="../
|
|
31
|
+
<h4 class="tsd-returns-title">Returns <a href="../interfaces/LensSource.html" class="tsd-signature-type tsd-kind-interface">LensSource</a><span class="tsd-signature-symbol">[]</span></h4>
|
|
32
|
+
<div class="tsd-comment tsd-typography">
|
|
33
|
+
<h4>Example</h4><pre><code class="language-ts"><span class="hl-2">import</span><span class="hl-1"> { </span><span class="hl-0">bootstrapCameraKit</span><span class="hl-1">, </span><span class="hl-0">lensSourcesFactory</span><span class="hl-1">, </span><span class="hl-0">LensSource</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">cameraKit</span><span class="hl-1"> = </span><span class="hl-5">bootstrapCameraKit</span><span class="hl-1">(</span><span class="hl-0">config</span><span class="hl-1">, (</span><span class="hl-0">container</span><span class="hl-1">) </span><span class="hl-4">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">return</span><span class="hl-1"> </span><span class="hl-0">container</span><span class="hl-1">.</span><span class="hl-5">provides</span><span class="hl-1">(</span><span class="hl-5">ConcatInjectable</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-0">lensSourcesFactory</span><span class="hl-1">.</span><span class="hl-0">token</span><span class="hl-1">,</span><br/><span class="hl-1"> (): </span><span class="hl-11">LensSource</span><span class="hl-1"> </span><span class="hl-4">=></span><span class="hl-1"> { </span><span class="hl-2">return</span><span class="hl-1"> ... }</span><br/><span class="hl-1"> ))</span><br/><span class="hl-1">})</span>
|
|
34
|
+
</code><button>Copy</button></pre>
|
|
35
|
+
</div></li></ul></section></div>
|
|
28
36
|
<div class="col-sidebar">
|
|
29
37
|
<div class="page-menu">
|
|
30
38
|
<div class="tsd-navigation settings">
|
|
@@ -39,12 +47,11 @@
|
|
|
39
47
|
<div class="tsd-theme-toggle">
|
|
40
48
|
<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
49
|
<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.
|
|
50
|
+
<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.15.0-<wbr/>alpha.1</span></a>
|
|
43
51
|
<ul class="tsd-small-nested-navigation">
|
|
44
52
|
<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
53
|
<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>
|
|
46
54
|
<li><a href="../classes/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>
|
|
47
|
-
<li><a href="../classes/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>
|
|
48
55
|
<li><a href="../classes/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>
|
|
49
56
|
<li><a href="../classes/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>
|
|
50
57
|
<li><a href="../classes/CameraKitSession.html"><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>
|
|
@@ -54,7 +61,6 @@
|
|
|
54
61
|
<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>
|
|
55
62
|
<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
63
|
<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
|
-
<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
64
|
<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
65
|
<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
66
|
<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>
|
|
@@ -64,6 +70,8 @@
|
|
|
64
70
|
<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>
|
|
65
71
|
<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>
|
|
66
72
|
<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>
|
|
73
|
+
<li><a href="../interfaces/LensLaunchData.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Lens<wbr/>Launch<wbr/>Data</span></a></li>
|
|
74
|
+
<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
75
|
<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>
|
|
68
76
|
<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>
|
|
69
77
|
<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>
|
|
@@ -75,7 +83,6 @@
|
|
|
75
83
|
<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
84
|
<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>
|
|
77
85
|
<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>
|
|
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>
|
|
79
86
|
<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>
|
|
80
87
|
<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>
|
|
81
88
|
<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>
|
|
@@ -109,9 +116,10 @@
|
|
|
109
116
|
<li><a href="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>
|
|
110
117
|
<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>
|
|
111
118
|
<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>
|
|
112
|
-
<li><a href="
|
|
119
|
+
<li><a href="ConcatInjectable.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>Concat<wbr/>Injectable</span></a></li>
|
|
113
120
|
<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>
|
|
114
121
|
<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>
|
|
122
|
+
<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>
|
|
115
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>
|
|
116
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>
|
|
117
125
|
<li><a href="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>
|
|
@@ -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>remoteApiServicesFactory | 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>remoteApiServicesFactory | CameraKit Web SDK - v0.15.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.15.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,12 +39,11 @@
|
|
|
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.15.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>
|
|
46
46
|
<li><a href="../classes/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>
|
|
47
|
-
<li><a href="../classes/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>
|
|
48
47
|
<li><a href="../classes/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>
|
|
49
48
|
<li><a href="../classes/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>
|
|
50
49
|
<li><a href="../classes/CameraKitSession.html"><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>
|
|
@@ -54,7 +53,6 @@
|
|
|
54
53
|
<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>
|
|
55
54
|
<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
55
|
<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
|
-
<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
56
|
<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
57
|
<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
58
|
<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>
|
|
@@ -64,6 +62,8 @@
|
|
|
64
62
|
<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>
|
|
65
63
|
<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>
|
|
66
64
|
<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>
|
|
65
|
+
<li><a href="../interfaces/LensLaunchData.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Lens<wbr/>Launch<wbr/>Data</span></a></li>
|
|
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
67
|
<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>
|
|
68
68
|
<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>
|
|
69
69
|
<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>
|
|
@@ -75,7 +75,6 @@
|
|
|
75
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
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>
|
|
77
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>
|
|
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>
|
|
79
78
|
<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>
|
|
80
79
|
<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>
|
|
81
80
|
<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>
|
|
@@ -109,9 +108,10 @@
|
|
|
109
108
|
<li><a href="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>
|
|
110
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>
|
|
111
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>
|
|
112
|
-
<li><a href="
|
|
111
|
+
<li><a href="ConcatInjectable.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>Concat<wbr/>Injectable</span></a></li>
|
|
113
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>
|
|
114
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>
|
|
114
|
+
<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>
|
|
115
115
|
<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>
|
|
116
116
|
<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>
|
|
117
117
|
<li><a href="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>
|
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.15.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.15.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.15.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>
|
|
@@ -102,7 +102,7 @@
|
|
|
102
102
|
<li><em><code>capture</code>: This canvas renders content intended for presenting to other users.</em></li>
|
|
103
103
|
</ul>
|
|
104
104
|
</blockquote>
|
|
105
|
-
<a id="md:error-handling" class="tsd-anchor"></a><h2><a href="#md:error-handling">Error Handling</a></h2><p>Camera Kit Web SDK methods may throw errors, or return rejected Promises -- these are documented in the <a href="https://kit.snapchat.com/reference/CameraKit/web/0.
|
|
105
|
+
<a id="md:error-handling" class="tsd-anchor"></a><h2><a href="#md:error-handling">Error Handling</a></h2><p>Camera Kit Web SDK methods may throw errors, or return rejected Promises -- these are documented in the <a href="https://kit.snapchat.com/reference/CameraKit/web/0.15.0/index.html">API docs</a>. It is good practice to handle such cases, to provide a good experience to your users.</p>
|
|
106
106
|
<p>Errors may also occur during Lens rendering. For example, Lenses contain their own scripting, which could throw an error. A rendering error could also occur if a Lens attempts to use a feature that is not supported by Camera Kit Web SDK.</p>
|
|
107
107
|
<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>
|
|
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>
|
|
@@ -214,12 +214,11 @@
|
|
|
214
214
|
<li><a href="#md:2d-transforms"><span>2<wbr/>D transforms</span></a></li></ul></li>
|
|
215
215
|
<li><a href="#md:metrics-reporting"><span>Metrics reporting</span></a></li></ul></li></ul></li></ul></li></ul></div></details></div>
|
|
216
216
|
<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.
|
|
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.15.0-<wbr/>alpha.1</span></a>
|
|
218
218
|
<ul class="tsd-small-nested-navigation">
|
|
219
219
|
<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
220
|
<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>
|
|
221
221
|
<li><a href="classes/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>
|
|
222
|
-
<li><a href="classes/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>
|
|
223
222
|
<li><a href="classes/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>
|
|
224
223
|
<li><a href="classes/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>
|
|
225
224
|
<li><a href="classes/CameraKitSession.html"><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>
|
|
@@ -229,7 +228,6 @@
|
|
|
229
228
|
<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>
|
|
230
229
|
<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
230
|
<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
|
-
<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
231
|
<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>
|
|
234
232
|
<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>
|
|
235
233
|
<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>
|
|
@@ -239,6 +237,8 @@
|
|
|
239
237
|
<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>
|
|
240
238
|
<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>
|
|
241
239
|
<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>
|
|
240
|
+
<li><a href="interfaces/LensLaunchData.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Lens<wbr/>Launch<wbr/>Data</span></a></li>
|
|
241
|
+
<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>
|
|
242
242
|
<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>
|
|
243
243
|
<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>
|
|
244
244
|
<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>
|
|
@@ -250,7 +250,6 @@
|
|
|
250
250
|
<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>
|
|
251
251
|
<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>
|
|
252
252
|
<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>
|
|
253
|
-
<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>
|
|
254
253
|
<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>
|
|
255
254
|
<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>
|
|
256
255
|
<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>
|
|
@@ -284,9 +283,10 @@
|
|
|
284
283
|
<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>
|
|
285
284
|
<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>
|
|
286
285
|
<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>
|
|
287
|
-
<li><a href="functions/
|
|
286
|
+
<li><a href="functions/ConcatInjectable.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>Concat<wbr/>Injectable</span></a></li>
|
|
288
287
|
<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>
|
|
289
288
|
<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>
|
|
289
|
+
<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>
|
|
290
290
|
<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>
|
|
291
291
|
<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>
|
|
292
292
|
<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>
|