@snap/camera-kit 0.15.1 → 0.16.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (412) hide show
  1. package/README.md +3 -3
  2. package/docs/html/assets/main.js +4 -3
  3. package/docs/html/assets/navigation.js +1 -0
  4. package/docs/html/assets/search.js +1 -1
  5. package/docs/html/assets/style.css +72 -25
  6. package/docs/html/classes/CameraKit.html +11 -196
  7. package/docs/html/classes/CameraKitSession.html +43 -366
  8. package/docs/html/classes/CameraKitSource.html +14 -223
  9. package/docs/html/classes/LensPerformanceMeasurement.html +9 -184
  10. package/docs/html/classes/LensPerformanceMetrics.html +7 -148
  11. package/docs/html/classes/LensRepository.html +17 -234
  12. package/docs/html/classes/Transform2D.html +7 -176
  13. package/docs/html/classes/TypedCustomEvent.html +4 -178
  14. package/docs/html/classes/TypedEventTarget.html +4 -209
  15. package/docs/html/enums/Lens_CameraFacing.html +5 -0
  16. package/docs/html/enums/UserData_Zodiac.html +15 -0
  17. package/docs/html/functions/ConcatInjectable.html +10 -193
  18. package/docs/html/functions/Injectable.html +9 -192
  19. package/docs/html/functions/bootstrapCameraKit.html +6 -147
  20. package/docs/html/functions/createExtension.html +6 -123
  21. package/docs/html/functions/createImageSource.html +4 -130
  22. package/docs/html/functions/createMediaStreamSource.html +4 -130
  23. package/docs/html/functions/createVideoSource.html +4 -130
  24. package/docs/html/functions/estimateLensPerformance.html +3 -120
  25. package/docs/html/functions/lensSourcesFactory.html +6 -127
  26. package/docs/html/functions/remoteApiServicesFactory.html +3 -121
  27. package/docs/html/hierarchy.html +1 -0
  28. package/docs/html/index.html +8 -165
  29. package/docs/html/interfaces/CameraKitBootstrapConfiguration.html +11 -192
  30. package/docs/html/interfaces/CameraKitDeviceOptions.html +11 -0
  31. package/docs/html/interfaces/CameraKitSourceInfo.html +9 -0
  32. package/docs/html/interfaces/CameraKitSourceSubscriber.html +3 -194
  33. package/docs/html/interfaces/ComputedFrameMetrics.html +2 -150
  34. package/docs/html/interfaces/CreateSessionOptions.html +5 -148
  35. package/docs/html/interfaces/EstimatedLensPerformance.html +3 -146
  36. package/docs/html/interfaces/FunctionSourceOptions.html +7 -0
  37. package/docs/html/interfaces/Lens.html +12 -205
  38. package/docs/html/interfaces/LensCreator.html +3 -0
  39. package/docs/html/interfaces/LensLaunchData.html +3 -179
  40. package/docs/html/interfaces/LensSource.html +3 -172
  41. package/docs/html/interfaces/LoadAssetRequest.html +13 -0
  42. package/docs/html/interfaces/MediaStreamSourceOptions.html +16 -138
  43. package/docs/html/interfaces/Preview.html +4 -141
  44. package/docs/html/interfaces/RemoteApiRequest.html +7 -162
  45. package/docs/html/interfaces/RemoteApiResponse.html +6 -155
  46. package/docs/html/interfaces/RemoteApiService.html +9 -171
  47. package/docs/html/interfaces/Snapcode.html +5 -148
  48. package/docs/html/interfaces/UriCancelRequest.html +2 -138
  49. package/docs/html/interfaces/UriRequest.html +2 -154
  50. package/docs/html/interfaces/UriResponse.html +2 -150
  51. package/docs/html/interfaces/VideoSourceOptions.html +15 -134
  52. package/docs/html/modules.html +57 -175
  53. package/docs/html/types/AssetLoader.html +5 -132
  54. package/docs/html/types/AssetResponse.html +1 -0
  55. package/docs/html/types/AssetTiming.html +2 -115
  56. package/docs/html/types/BenchmarkError.html +1 -112
  57. package/docs/html/types/BootstrapError.html +2 -115
  58. package/docs/html/types/CacheKeyNotFoundError.html +1 -112
  59. package/docs/html/types/CameraKitSessionEventListener.html +2 -115
  60. package/docs/html/types/CameraKitSessionEvents.html +2 -122
  61. package/docs/html/types/CameraKitSourceError.html +1 -112
  62. package/docs/html/types/ConfigurationError.html +2 -115
  63. package/docs/html/types/FetchHandler.html +1 -0
  64. package/docs/html/types/Keyboard.html +14 -194
  65. package/docs/html/types/KeyboardEvents.html +2 -124
  66. package/docs/html/types/LegalError.html +1 -112
  67. package/docs/html/types/LensAbortError.html +2 -115
  68. package/docs/html/types/LensAssetError.html +2 -115
  69. package/docs/html/types/LensContentValidationError.html +1 -112
  70. package/docs/html/types/LensError.html +1 -112
  71. package/docs/html/types/LensExecutionError.html +2 -115
  72. package/docs/html/types/LensImagePickerError.html +2 -115
  73. package/docs/html/types/LensLaunchParams.html +2 -0
  74. package/docs/html/types/LensMetricsEvents.html +2 -115
  75. package/docs/html/types/LensPerformanceCluster.html +1 -113
  76. package/docs/html/types/LensView.html +2 -115
  77. package/docs/html/types/LensWait.html +2 -115
  78. package/docs/html/types/Matrix.html +3 -0
  79. package/docs/html/types/PersistentStoreError.html +2 -115
  80. package/docs/html/types/PlatformNotSupportedError.html +2 -115
  81. package/docs/html/types/PublicContainer.html +2 -115
  82. package/docs/html/types/PublicServices.html +2 -0
  83. package/docs/html/types/RemoteApiCancelRequestHandler.html +2 -0
  84. package/docs/html/types/RemoteApiRequestHandler.html +2 -139
  85. package/docs/html/types/RemoteApiServices.html +1 -112
  86. package/docs/html/types/RemoteApiStatus.html +2 -115
  87. package/docs/html/types/RenderTarget.html +2 -115
  88. package/docs/html/types/Uri.html +1 -112
  89. package/docs/html/types/WebGLError.html +1 -112
  90. package/docs/html/variables/extensionRequestContext.html +2 -115
  91. package/docs/md/README.md +3 -3
  92. package/docs/md/classes/CameraKit.md +15 -15
  93. package/docs/md/classes/CameraKitSession.md +38 -38
  94. package/docs/md/classes/CameraKitSource.md +22 -30
  95. package/docs/md/classes/LensPerformanceMeasurement.md +10 -6
  96. package/docs/md/classes/LensPerformanceMetrics.md +2 -2
  97. package/docs/md/classes/LensRepository.md +18 -18
  98. package/docs/md/classes/Transform2D.md +7 -3
  99. package/docs/md/classes/TypedCustomEvent.md +10 -6
  100. package/docs/md/classes/TypedEventTarget.md +12 -8
  101. package/docs/md/enums/Lens_CameraFacing.md +36 -0
  102. package/docs/md/enums/UserData_Zodiac.md +106 -0
  103. package/docs/md/interfaces/CameraKitBootstrapConfiguration.md +2 -2
  104. package/docs/md/interfaces/CameraKitDeviceOptions.md +41 -0
  105. package/docs/md/interfaces/CameraKitSourceInfo.md +43 -0
  106. package/docs/md/interfaces/CameraKitSourceSubscriber.md +7 -7
  107. package/docs/md/interfaces/ComputedFrameMetrics.md +1 -1
  108. package/docs/md/interfaces/CreateSessionOptions.md +1 -1
  109. package/docs/md/interfaces/EstimatedLensPerformance.md +1 -1
  110. package/docs/md/interfaces/FunctionSourceOptions.md +22 -0
  111. package/docs/md/interfaces/Lens.md +4 -4
  112. package/docs/md/interfaces/LensCreator.md +17 -0
  113. package/docs/md/interfaces/LensLaunchData.md +6 -6
  114. package/docs/md/interfaces/LensSource.md +5 -5
  115. package/docs/md/interfaces/LoadAssetRequest.md +49 -0
  116. package/docs/md/interfaces/MediaStreamSourceOptions.md +46 -1
  117. package/docs/md/interfaces/Preview.md +1 -1
  118. package/docs/md/interfaces/RemoteApiRequest.md +2 -2
  119. package/docs/md/interfaces/RemoteApiResponse.md +2 -2
  120. package/docs/md/interfaces/RemoteApiService.md +1 -1
  121. package/docs/md/interfaces/Snapcode.md +1 -1
  122. package/docs/md/interfaces/UriCancelRequest.md +2 -2
  123. package/docs/md/interfaces/UriRequest.md +3 -3
  124. package/docs/md/interfaces/UriResponse.md +2 -2
  125. package/docs/md/interfaces/VideoSourceOptions.md +44 -1
  126. package/docs/md/modules.md +183 -201
  127. package/lib/CameraKit.d.ts +108 -108
  128. package/lib/CameraKit.js +1 -1
  129. package/lib/CameraKit.js.map +1 -1
  130. package/lib/bootstrapCameraKit.d.ts +4 -4
  131. package/lib/bootstrapCameraKit.js +18 -19
  132. package/lib/bootstrapCameraKit.js.map +1 -1
  133. package/lib/clients/createTsProtoClient.d.ts +5 -12
  134. package/lib/clients/createTsProtoClient.js +1 -2
  135. package/lib/clients/createTsProtoClient.js.map +1 -1
  136. package/lib/clients/grpcHandler.d.ts +7 -4
  137. package/lib/clients/grpcHandler.js +8 -5
  138. package/lib/clients/grpcHandler.js.map +1 -1
  139. package/lib/clients/lensesClient.d.ts +3 -3
  140. package/lib/clients/lensesClient.js +2 -2
  141. package/lib/clients/lensesClient.js.map +1 -1
  142. package/lib/clients/metricsClient.d.ts +26 -0
  143. package/lib/clients/metricsClient.js +120 -0
  144. package/lib/clients/metricsClient.js.map +1 -0
  145. package/lib/configuration.js +1 -1
  146. package/lib/configuration.js.map +1 -1
  147. package/lib/dependency-injection/Container.d.ts +1 -1
  148. package/lib/dependency-injection/Container.js +1 -1
  149. package/lib/dependency-injection/Container.js.map +1 -1
  150. package/lib/dependency-injection/Injectable.d.ts +6 -6
  151. package/lib/dependency-injection/Injectable.js.map +1 -1
  152. package/lib/dependency-injection/RootServices.d.ts +7 -8
  153. package/lib/dependency-injection/RootServices.js.map +1 -1
  154. package/lib/environment.d.ts +4 -0
  155. package/lib/environment.js +2 -0
  156. package/lib/environment.js.map +1 -0
  157. package/lib/extensions/RemoteApiServices.d.ts +2 -2
  158. package/lib/extensions/RemoteApiServices.js +11 -6
  159. package/lib/extensions/RemoteApiServices.js.map +1 -1
  160. package/lib/extensions/uriHandlersRegister.d.ts +4 -4
  161. package/lib/extensions/uriHandlersRegister.js +6 -6
  162. package/lib/extensions/uriHandlersRegister.js.map +1 -1
  163. package/lib/generated-proto/blizzard/cameraKitEvents.d.ts +4330 -678
  164. package/lib/generated-proto/blizzard/cameraKitEvents.js +515 -72
  165. package/lib/generated-proto/blizzard/cameraKitEvents.js.map +1 -1
  166. package/lib/generated-proto/pb_schema/camera_kit/v3/business_events.d.ts +3 -11
  167. package/lib/generated-proto/pb_schema/camera_kit/v3/business_events.js +6 -156
  168. package/lib/generated-proto/pb_schema/camera_kit/v3/business_events.js.map +1 -1
  169. package/lib/generated-proto/pb_schema/camera_kit/v3/export.d.ts +19 -19
  170. package/lib/generated-proto/pb_schema/camera_kit/v3/export.js +13 -27
  171. package/lib/generated-proto/pb_schema/camera_kit/v3/export.js.map +1 -1
  172. package/lib/generated-proto/pb_schema/camera_kit/v3/legal_prompt.d.ts +0 -6
  173. package/lib/generated-proto/pb_schema/camera_kit/v3/legal_prompt.js +2 -83
  174. package/lib/generated-proto/pb_schema/camera_kit/v3/legal_prompt.js.map +1 -1
  175. package/lib/generated-proto/pb_schema/camera_kit/v3/lens.d.ts +0 -22
  176. package/lib/generated-proto/pb_schema/camera_kit/v3/lens.js +0 -263
  177. package/lib/generated-proto/pb_schema/camera_kit/v3/lens.js.map +1 -1
  178. package/lib/generated-proto/pb_schema/camera_kit/v3/operational_metrics.d.ts +30 -34
  179. package/lib/generated-proto/pb_schema/camera_kit/v3/operational_metrics.js +7 -73
  180. package/lib/generated-proto/pb_schema/camera_kit/v3/operational_metrics.js.map +1 -1
  181. package/lib/generated-proto/pb_schema/camera_kit/v3/ranking.d.ts +0 -6
  182. package/lib/generated-proto/pb_schema/camera_kit/v3/ranking.js +0 -110
  183. package/lib/generated-proto/pb_schema/camera_kit/v3/ranking.js.map +1 -1
  184. package/lib/generated-proto/pb_schema/camera_kit/v3/service.d.ts +48 -114
  185. package/lib/generated-proto/pb_schema/camera_kit/v3/service.js +0 -225
  186. package/lib/generated-proto/pb_schema/camera_kit/v3/service.js.map +1 -1
  187. package/lib/generated-proto/pb_schema/cdp/cof/benchmark.d.ts +6 -6
  188. package/lib/generated-proto/pb_schema/cdp/cof/benchmark.js +5 -19
  189. package/lib/generated-proto/pb_schema/cdp/cof/benchmark.js.map +1 -1
  190. package/lib/generated-proto/pb_schema/cdp/cof/circumstance_service.d.ts +1422 -1422
  191. package/lib/generated-proto/pb_schema/cdp/cof/config_request.d.ts +12 -12
  192. package/lib/generated-proto/pb_schema/cdp/cof/config_request.js +10 -24
  193. package/lib/generated-proto/pb_schema/cdp/cof/config_request.js.map +1 -1
  194. package/lib/generated-proto/pb_schema/cdp/cof/config_response.d.ts +207 -207
  195. package/lib/generated-proto/pb_schema/cdp/cof/config_result.d.ts +530 -530
  196. package/lib/generated-proto/pb_schema/cdp/cof/config_result.js +10 -24
  197. package/lib/generated-proto/pb_schema/cdp/cof/config_result.js.map +1 -1
  198. package/lib/generated-proto/pb_schema/common/value.d.ts +6 -6
  199. package/lib/generated-proto/pb_schema/common/value.js +4 -18
  200. package/lib/generated-proto/pb_schema/common/value.js.map +1 -1
  201. package/lib/generated-proto/pb_schema/google/api/http.d.ts +0 -6
  202. package/lib/generated-proto/pb_schema/google/api/http.js +0 -77
  203. package/lib/generated-proto/pb_schema/google/api/http.js.map +1 -1
  204. package/lib/generated-proto/pb_schema/google/protobuf/any.d.ts +0 -2
  205. package/lib/generated-proto/pb_schema/google/protobuf/any.js +0 -44
  206. package/lib/generated-proto/pb_schema/google/protobuf/any.js.map +1 -1
  207. package/lib/generated-proto/pb_schema/google/protobuf/descriptor.d.ts +4830 -4896
  208. package/lib/generated-proto/pb_schema/google/protobuf/descriptor.js +10 -997
  209. package/lib/generated-proto/pb_schema/google/protobuf/descriptor.js.map +1 -1
  210. package/lib/generated-proto/pb_schema/google/protobuf/timestamp.d.ts +3 -5
  211. package/lib/generated-proto/pb_schema/google/protobuf/timestamp.js +6 -35
  212. package/lib/generated-proto/pb_schema/google/protobuf/timestamp.js.map +1 -1
  213. package/lib/generated-proto/pb_schema/google/protobuf/wrappers.d.ts +6 -6
  214. package/lib/generated-proto/pb_schema/google/protobuf/wrappers.js +10 -24
  215. package/lib/generated-proto/pb_schema/google/protobuf/wrappers.js.map +1 -1
  216. package/lib/generated-proto/pb_schema/lenses/launchdata.d.ts +9 -9
  217. package/lib/generated-proto/pb_schema/lenses/remote_api/remote_api_service.d.ts +11 -11
  218. package/lib/generated-proto/pb_schema/lenses/remote_api/remote_api_service.js +6 -20
  219. package/lib/generated-proto/pb_schema/lenses/remote_api/remote_api_service.js.map +1 -1
  220. package/lib/generated-proto/pb_schema/lenses/snappable.d.ts +42 -42
  221. package/lib/generated-proto/pb_schema/lenses/snappable.js +14 -28
  222. package/lib/generated-proto/pb_schema/lenses/snappable.js.map +1 -1
  223. package/lib/generated-proto/pb_schema/lenses/user_data.d.ts +8 -8
  224. package/lib/generated-proto/pb_schema/lenses/user_data.js +8 -22
  225. package/lib/generated-proto/pb_schema/lenses/user_data.js.map +1 -1
  226. package/lib/handlers/defaultFetchHandler.d.ts +1 -1
  227. package/lib/handlers/defaultFetchHandler.js.map +1 -1
  228. package/lib/handlers/requestStateEmittingHandler.d.ts +5 -6
  229. package/lib/handlers/requestStateEmittingHandler.js +6 -8
  230. package/lib/handlers/requestStateEmittingHandler.js.map +1 -1
  231. package/lib/handlers/responseCachingHandler.d.ts +9 -10
  232. package/lib/handlers/responseCachingHandler.js +9 -3
  233. package/lib/handlers/responseCachingHandler.js.map +1 -1
  234. package/lib/handlers/utils.d.ts +12 -0
  235. package/lib/handlers/utils.js +19 -0
  236. package/lib/handlers/utils.js.map +1 -0
  237. package/lib/index.d.ts +21 -15
  238. package/lib/index.js +17 -12
  239. package/lib/index.js.map +1 -1
  240. package/lib/lens/Lens.d.ts +12 -2
  241. package/lib/lens/Lens.js +5 -0
  242. package/lib/lens/Lens.js.map +1 -1
  243. package/lib/lens/LensLaunchData.d.ts +6 -3
  244. package/lib/lens/LensLaunchData.js +2 -0
  245. package/lib/lens/LensLaunchData.js.map +1 -1
  246. package/lib/lens/LensPersistenceStore.d.ts +1 -1
  247. package/lib/lens/LensPersistenceStore.js +1 -1
  248. package/lib/lens/LensPersistenceStore.js.map +1 -1
  249. package/lib/lens/LensRepository.d.ts +5 -1
  250. package/lib/lens/LensRepository.js +9 -5
  251. package/lib/lens/LensRepository.js.map +1 -1
  252. package/lib/lens/LensSource.d.ts +2 -2
  253. package/lib/lens/LensSource.js +2 -2
  254. package/lib/lens/LensSource.js.map +1 -1
  255. package/lib/lens/assets/LensAssetRepository.d.ts +35 -4
  256. package/lib/lens/assets/LensAssetRepository.js +9 -9
  257. package/lib/lens/assets/LensAssetRepository.js.map +1 -1
  258. package/lib/lens/assets/LensAssetsProvider.d.ts +1 -1
  259. package/lib/lens/assets/LensAssetsProvider.js +9 -4
  260. package/lib/lens/assets/LensAssetsProvider.js.map +1 -1
  261. package/lib/lens/assets/deviceDependentAssetLoader.js +3 -2
  262. package/lib/lens/assets/deviceDependentAssetLoader.js.map +1 -1
  263. package/lib/lens/assets/remoteMediaAssetLoaderFactory.js +4 -3
  264. package/lib/lens/assets/remoteMediaAssetLoaderFactory.js.map +1 -1
  265. package/lib/lens/assets/staticAssetLoader.js +5 -4
  266. package/lib/lens/assets/staticAssetLoader.js.map +1 -1
  267. package/lib/lens/cameraKitLensSource.js.map +1 -1
  268. package/lib/lens-client-interface/imagePicker.d.ts +2 -1
  269. package/lib/lens-client-interface/imagePicker.js.map +1 -1
  270. package/lib/lens-client-interface/lensClientInterface.d.ts +1 -1
  271. package/lib/lens-client-interface/lensClientInterface.js +1 -1
  272. package/lib/lens-client-interface/lensClientInterface.js.map +1 -1
  273. package/lib/lens-core-module/lensCore.d.ts +2 -1
  274. package/lib/lens-core-module/lensCore.js.map +1 -1
  275. package/lib/lens-core-module/loader/bootstrapURLs.d.ts +12 -0
  276. package/lib/lens-core-module/loader/bootstrapURLs.js +48 -0
  277. package/lib/lens-core-module/loader/bootstrapURLs.js.map +1 -0
  278. package/lib/lens-core-module/loader/lensCoreFactory.d.ts +0 -12
  279. package/lib/lens-core-module/loader/lensCoreFactory.js +4 -49
  280. package/lib/lens-core-module/loader/lensCoreFactory.js.map +1 -1
  281. package/lib/lensCoreWasmVersions.d.ts +6 -0
  282. package/lib/lensCoreWasmVersions.js +6 -0
  283. package/lib/lensCoreWasmVersions.js.map +1 -0
  284. package/lib/media-sources/CameraKitSource.d.ts +39 -17
  285. package/lib/media-sources/CameraKitSource.js +8 -2
  286. package/lib/media-sources/CameraKitSource.js.map +1 -1
  287. package/lib/media-sources/FunctionSource.d.ts +15 -4
  288. package/lib/media-sources/FunctionSource.js +1 -2
  289. package/lib/media-sources/FunctionSource.js.map +1 -1
  290. package/lib/media-sources/ImageSource.d.ts +3 -5
  291. package/lib/media-sources/ImageSource.js +1 -3
  292. package/lib/media-sources/ImageSource.js.map +1 -1
  293. package/lib/media-sources/MediaStreamSource.d.ts +17 -33
  294. package/lib/media-sources/MediaStreamSource.js +6 -41
  295. package/lib/media-sources/MediaStreamSource.js.map +1 -1
  296. package/lib/media-sources/VideoSource.d.ts +14 -10
  297. package/lib/media-sources/VideoSource.js +5 -11
  298. package/lib/media-sources/VideoSource.js.map +1 -1
  299. package/lib/metrics/businessEventsReporter.d.ts +3 -4
  300. package/lib/metrics/businessEventsReporter.js +11 -55
  301. package/lib/metrics/businessEventsReporter.js.map +1 -1
  302. package/lib/metrics/operational/Count.d.ts +2 -0
  303. package/lib/metrics/operational/Count.js +6 -1
  304. package/lib/metrics/operational/Count.js.map +1 -1
  305. package/lib/metrics/operational/Histogram.d.ts +1 -1
  306. package/lib/metrics/operational/Histogram.js +7 -3
  307. package/lib/metrics/operational/Histogram.js.map +1 -1
  308. package/lib/metrics/operational/Metric.js +2 -0
  309. package/lib/metrics/operational/Metric.js.map +1 -1
  310. package/lib/metrics/operational/Timer.d.ts +9 -6
  311. package/lib/metrics/operational/Timer.js +12 -26
  312. package/lib/metrics/operational/Timer.js.map +1 -1
  313. package/lib/metrics/reporters/reportBenchmarks.d.ts +3 -3
  314. package/lib/metrics/reporters/reportBenchmarks.js +6 -5
  315. package/lib/metrics/reporters/reportBenchmarks.js.map +1 -1
  316. package/lib/metrics/reporters/reportGlobalException.d.ts +4 -4
  317. package/lib/metrics/reporters/reportGlobalException.js +13 -11
  318. package/lib/metrics/reporters/reportGlobalException.js.map +1 -1
  319. package/lib/metrics/reporters/reportHttpMetrics.d.ts +3 -3
  320. package/lib/metrics/reporters/reportHttpMetrics.js +19 -16
  321. package/lib/metrics/reporters/reportHttpMetrics.js.map +1 -1
  322. package/lib/metrics/reporters/reportLegalState.d.ts +3 -3
  323. package/lib/metrics/reporters/reportLegalState.js +7 -9
  324. package/lib/metrics/reporters/reportLegalState.js.map +1 -1
  325. package/lib/metrics/reporters/reportLensAndAssetDownload.d.ts +3 -3
  326. package/lib/metrics/reporters/reportLensAndAssetDownload.js +12 -12
  327. package/lib/metrics/reporters/reportLensAndAssetDownload.js.map +1 -1
  328. package/lib/metrics/reporters/reportLensView.d.ts +3 -3
  329. package/lib/metrics/reporters/reportLensView.js +6 -6
  330. package/lib/metrics/reporters/reportLensView.js.map +1 -1
  331. package/lib/metrics/reporters/reportLensWait.d.ts +2 -3
  332. package/lib/metrics/reporters/reportLensWait.js +1 -3
  333. package/lib/metrics/reporters/reportLensWait.js.map +1 -1
  334. package/lib/metrics/reporters/reportPlatformCapabilities.d.ts +3 -3
  335. package/lib/metrics/reporters/reportPlatformCapabilities.js +6 -5
  336. package/lib/metrics/reporters/reportPlatformCapabilities.js.map +1 -1
  337. package/lib/metrics/reporters/reportUserSession.js +3 -3
  338. package/lib/metrics/reporters/reportUserSession.js.map +1 -1
  339. package/lib/metrics/reporters/reporters.d.ts +2 -2
  340. package/lib/namedErrors.d.ts +1 -1
  341. package/lib/namedErrors.js +1 -1
  342. package/lib/namedErrors.js.map +1 -1
  343. package/lib/observable-operators/unsubscribed.d.ts +1 -1
  344. package/lib/observable-operators/unsubscribed.js +1 -1
  345. package/lib/observable-operators/unsubscribed.js.map +1 -1
  346. package/lib/platform/platformCapabilities.d.ts +1 -1
  347. package/lib/platform/platformCapabilities.js +9 -3
  348. package/lib/platform/platformCapabilities.js.map +1 -1
  349. package/lib/platform/platformInfo.d.ts +1 -0
  350. package/lib/platform/platformInfo.js +3 -3
  351. package/lib/platform/platformInfo.js.map +1 -1
  352. package/lib/remote-configuration/cofHandler.d.ts +3 -3
  353. package/lib/remote-configuration/cofHandler.js +6 -4
  354. package/lib/remote-configuration/cofHandler.js.map +1 -1
  355. package/lib/remote-configuration/preloadConfiguration.d.ts +1 -1
  356. package/lib/remote-configuration/preloadConfiguration.js +1 -1
  357. package/lib/remote-configuration/preloadConfiguration.js.map +1 -1
  358. package/lib/remote-configuration/remoteConfiguration.d.ts +7 -6
  359. package/lib/remote-configuration/remoteConfiguration.js +18 -15
  360. package/lib/remote-configuration/remoteConfiguration.js.map +1 -1
  361. package/lib/session/CameraKitSession.d.ts +8 -8
  362. package/lib/session/CameraKitSession.js +11 -9
  363. package/lib/session/CameraKitSession.js.map +1 -1
  364. package/lib/session/LensKeyboard.d.ts +2 -3
  365. package/lib/session/LensKeyboard.js.map +1 -1
  366. package/lib/session/LensPerformanceMeasurement.d.ts +1 -1
  367. package/lib/session/LensPerformanceMeasurement.js +3 -3
  368. package/lib/session/LensPerformanceMeasurement.js.map +1 -1
  369. package/lib/session/LensPerformanceMetrics.d.ts +1 -1
  370. package/lib/session/LensPerformanceMetrics.js.map +1 -1
  371. package/lib/session/lensState.d.ts +4 -4
  372. package/lib/session/lensState.js +10 -10
  373. package/lib/session/lensState.js.map +1 -1
  374. package/lib/transforms/Transform2D.d.ts +8 -3
  375. package/lib/transforms/Transform2D.js +1 -1
  376. package/lib/transforms/Transform2D.js.map +1 -1
  377. package/lib/utils.d.ts +3 -0
  378. package/lib/utils.js +4 -0
  379. package/lib/utils.js.map +1 -0
  380. package/package.json +27 -6
  381. package/docs/html/functions/createUserMediaSource.html +0 -138
  382. package/docs/html/functions/getRequiredBootstrapURLs.html +0 -130
  383. package/docs/html/types/CameraKitDeviceInfo.html +0 -125
  384. package/docs/html/types/CameraKitDeviceOptions.html +0 -120
  385. package/docs/html/types/CameraKitSourceInfo.html +0 -112
  386. package/docs/html/types/CameraKitSourceOptions.html +0 -118
  387. package/lib/common/index.d.ts +0 -2
  388. package/lib/common/index.js +0 -3
  389. package/lib/common/index.js.map +0 -1
  390. package/lib/environment.json +0 -1
  391. package/lib/handlers/index.d.ts +0 -2
  392. package/lib/handlers/index.js +0 -3
  393. package/lib/handlers/index.js.map +0 -1
  394. package/lib/lens-core-module/index.d.ts +0 -3
  395. package/lib/lens-core-module/index.js +0 -4
  396. package/lib/lens-core-module/index.js.map +0 -1
  397. package/lib/lens-core-module/loader/index.d.ts +0 -1
  398. package/lib/lens-core-module/loader/index.js +0 -2
  399. package/lib/lens-core-module/loader/index.js.map +0 -1
  400. package/lib/lensCoreWasmVersions.json +0 -5
  401. package/lib/metrics/metricsHandler.d.ts +0 -10
  402. package/lib/metrics/metricsHandler.js +0 -13
  403. package/lib/metrics/metricsHandler.js.map +0 -1
  404. package/lib/metrics/operational/operationalMetricsReporter.d.ts +0 -64
  405. package/lib/metrics/operational/operationalMetricsReporter.js +0 -144
  406. package/lib/metrics/operational/operationalMetricsReporter.js.map +0 -1
  407. package/lib/session/index.d.ts +0 -1
  408. package/lib/session/index.js +0 -2
  409. package/lib/session/index.js.map +0 -1
  410. package/lib/transforms/index.d.ts +0 -1
  411. package/lib/transforms/index.js +0 -2
  412. package/lib/transforms/index.js.map +0 -1
@@ -1,4 +1,4 @@
1
- [CameraKit Web SDK - v0.15.1-alpha.1](../README.md) / [Exports](../modules.md) / CameraKitSource
1
+ [CameraKit Web SDK - v0.16.2](../README.md) / [Exports](../modules.md) / CameraKitSource
2
2
 
3
3
  # Class: CameraKitSource
4
4
 
@@ -26,15 +26,19 @@ that will occur when the source is attached and detached. This can be used to e.
26
26
 
27
27
  ### constructor
28
28
 
29
- • **new CameraKitSource**(`sourceInfo`, `subscriber?`, `deviceInfo?`)
29
+ • **new CameraKitSource**(`sourceInfo`, `subscriber?`, `deviceInfo?`): [`CameraKitSource`](CameraKitSource.md)
30
30
 
31
31
  #### Parameters
32
32
 
33
33
  | Name | Type |
34
34
  | :------ | :------ |
35
- | `sourceInfo` | [`CameraKitSourceInfo`](../modules.md#camerakitsourceinfo) |
35
+ | `sourceInfo` | [`CameraKitSourceInfo`](../interfaces/CameraKitSourceInfo.md) |
36
36
  | `subscriber` | [`CameraKitSourceSubscriber`](../interfaces/CameraKitSourceSubscriber.md) |
37
- | `deviceInfo` | `Partial`<[`CameraKitDeviceOptions`](../modules.md#camerakitdeviceoptions) \| [`CameraKitDeviceInfo`](../modules.md#camerakitdeviceinfo)\> |
37
+ | `deviceInfo` | `Partial`\<[`CameraKitDeviceOptions`](../interfaces/CameraKitDeviceOptions.md)\> |
38
+
39
+ #### Returns
40
+
41
+ [`CameraKitSource`](CameraKitSource.md)
38
42
 
39
43
  ## Methods
40
44
 
@@ -42,37 +46,25 @@ that will occur when the source is attached and detached. This can be used to e.
42
46
 
43
47
  ▸ **copy**(`deviceInfo?`): [`CameraKitSource`](CameraKitSource.md)
44
48
 
45
- **`Deprecated`**
46
-
47
- Use [CameraKitDeviceOptions](../modules.md#camerakitdeviceoptions) where cameraType is either "environment" or "user"
49
+ Make a copy of the source, sharing the same [CameraKitSourceSubscriber](../interfaces/CameraKitSourceSubscriber.md).
48
50
 
49
51
  #### Parameters
50
52
 
51
- | Name | Type |
52
- | :------ | :------ |
53
- | `deviceInfo?` | `Partial`<[`CameraKitDeviceInfo`](../modules.md#camerakitdeviceinfo)\> |
53
+ | Name | Type | Description |
54
+ | :------ | :------ | :------ |
55
+ | `deviceInfo` | `Partial`\<[`CameraKitDeviceOptions`](../interfaces/CameraKitDeviceOptions.md)\> | Optionally provide new device info for the copy (e.g. to change the camera type). |
54
56
 
55
57
  #### Returns
56
58
 
57
59
  [`CameraKitSource`](CameraKitSource.md)
58
60
 
59
- **copy**(`deviceInfo?`): [`CameraKitSource`](CameraKitSource.md)
60
-
61
- #### Parameters
62
-
63
- | Name | Type |
64
- | :------ | :------ |
65
- | `deviceInfo?` | `Partial`<[`CameraKitDeviceOptions`](../modules.md#camerakitdeviceoptions)\> |
66
-
67
- #### Returns
68
-
69
- [`CameraKitSource`](CameraKitSource.md)
61
+ The new [CameraKitSource](CameraKitSource.md)
70
62
 
71
63
  ___
72
64
 
73
65
  ### setRenderSize
74
66
 
75
- ▸ **setRenderSize**(`width`, `height`): `Promise`<`void`\>
67
+ ▸ **setRenderSize**(`width`, `height`): `Promise`\<`void`\>
76
68
 
77
69
  Set the resolution used to render this source.
78
70
 
@@ -91,11 +83,6 @@ of as free.
91
83
 
92
84
  The size of the Live and Capture [RenderTarget](../modules.md#rendertarget) is always the same.
93
85
 
94
- **`Todo`**
95
-
96
- Currently it's only valid to call `setRenderSize` after `CameraKitSession.play` has been called. This
97
- constraint should be removed, so callers don't have to understand the underlying LensCore state machine.
98
-
99
86
  #### Parameters
100
87
 
101
88
  | Name | Type | Description |
@@ -105,15 +92,20 @@ constraint should be removed, so callers don't have to understand the underlying
105
92
 
106
93
  #### Returns
107
94
 
108
- `Promise`<`void`\>
95
+ `Promise`\<`void`\>
109
96
 
110
97
  Promise resolves when the render size has been successfully updated.
111
98
 
99
+ **`Todo`**
100
+
101
+ Currently it's only valid to call `setRenderSize` after `CameraKitSession.play` has been called. This
102
+ constraint should be removed, so callers don't have to understand the underlying LensCore state machine.
103
+
112
104
  ___
113
105
 
114
106
  ### setTransform
115
107
 
116
- ▸ **setTransform**(`transform`): `Promise`<`void`\>
108
+ ▸ **setTransform**(`transform`): `Promise`\<`void`\>
117
109
 
118
110
  Apply a 2D transformation to the source (e.g. translation, rotation, scale).
119
111
 
@@ -125,4 +117,4 @@ Apply a 2D transformation to the source (e.g. translation, rotation, scale).
125
117
 
126
118
  #### Returns
127
119
 
128
- `Promise`<`void`\>
120
+ `Promise`\<`void`\>
@@ -1,10 +1,10 @@
1
- [CameraKit Web SDK - v0.15.1-alpha.1](../README.md) / [Exports](../modules.md) / LensPerformanceMeasurement
1
+ [CameraKit Web SDK - v0.16.2](../README.md) / [Exports](../modules.md) / LensPerformanceMeasurement
2
2
 
3
3
  # Class: LensPerformanceMeasurement
4
4
 
5
5
  Represents an ongoing measurement of rendering metrics.
6
6
 
7
- An instance of this class is obtained by calling [beginMeasurement](LensPerformanceMetrics.md#beginmeasurement). Then it may be
7
+ An instance of this class is obtained by calling [LensPerformanceMetrics.beginMeasurement](LensPerformanceMetrics.md#beginmeasurement). Then it may be
8
8
  used to record rendering performance metrics, reset measurement, or end the measurement.
9
9
 
10
10
  ## Table of contents
@@ -23,13 +23,17 @@ used to record rendering performance metrics, reset measurement, or end the meas
23
23
 
24
24
  ### constructor
25
25
 
26
- • **new LensPerformanceMeasurement**(`instances`)
26
+ • **new LensPerformanceMeasurement**(`instances`): [`LensPerformanceMeasurement`](LensPerformanceMeasurement.md)
27
27
 
28
28
  #### Parameters
29
29
 
30
30
  | Name | Type |
31
31
  | :------ | :------ |
32
- | `instances` | `Set`<[`LensPerformanceMeasurement`](LensPerformanceMeasurement.md)\> |
32
+ | `instances` | `Set`\<[`LensPerformanceMeasurement`](LensPerformanceMeasurement.md)\> |
33
+
34
+ #### Returns
35
+
36
+ [`LensPerformanceMeasurement`](LensPerformanceMeasurement.md)
33
37
 
34
38
  ## Methods
35
39
 
@@ -52,8 +56,8 @@ ___
52
56
 
53
57
  ▸ **reset**(): `void`
54
58
 
55
- Reset the measured perforamance statistics (averages, std deviations). This is equivalent to using
56
- [beginMeasurement](LensPerformanceMetrics.md#beginmeasurement) to create a new LensPerformanceMeasurement instance, but may be
59
+ Reset the measured performance statistics (averages, std deviations). This is equivalent to using
60
+ [LensPerformanceMetrics.beginMeasurement](LensPerformanceMetrics.md#beginmeasurement) to create a new LensPerformanceMeasurement instance, but may be
57
61
  more convenient.
58
62
 
59
63
  #### Returns
@@ -1,10 +1,10 @@
1
- [CameraKit Web SDK - v0.15.1-alpha.1](../README.md) / [Exports](../modules.md) / LensPerformanceMetrics
1
+ [CameraKit Web SDK - v0.16.2](../README.md) / [Exports](../modules.md) / LensPerformanceMetrics
2
2
 
3
3
  # Class: LensPerformanceMetrics
4
4
 
5
5
  Use to measure lens rendering performance.
6
6
 
7
- The [beginMeasurement](LensPerformanceMetrics.md#beginmeasurement) method is used to start measuring rendering performance. After
7
+ The [LensPerformanceMetrics.beginMeasurement](LensPerformanceMetrics.md#beginmeasurement) method is used to start measuring rendering performance. After
8
8
  a measurement has begun, performance metrics can be read using [LensPerformanceMeasurement](LensPerformanceMeasurement.md).
9
9
 
10
10
  **`Example`**
@@ -1,4 +1,4 @@
1
- [CameraKit Web SDK - v0.15.1-alpha.1](../README.md) / [Exports](../modules.md) / LensRepository
1
+ [CameraKit Web SDK - v0.16.2](../README.md) / [Exports](../modules.md) / LensRepository
2
2
 
3
3
  # Class: LensRepository
4
4
 
@@ -31,7 +31,7 @@ session.applyLens(lens)
31
31
 
32
32
  ### loadLens
33
33
 
34
- ▸ **loadLens**(`lensId`, `groupId`): `Promise`<[`Lens`](../interfaces/Lens.md)\>
34
+ ▸ **loadLens**(`lensId`, `groupId`): `Promise`\<[`Lens`](../interfaces/Lens.md)\>
35
35
 
36
36
  Retrieve a single Lens.
37
37
 
@@ -44,7 +44,7 @@ Retrieve a single Lens.
44
44
 
45
45
  #### Returns
46
46
 
47
- `Promise`<[`Lens`](../interfaces/Lens.md)\>
47
+ `Promise`\<[`Lens`](../interfaces/Lens.md)\>
48
48
 
49
49
  Resolves with the desired Lens, or rejects if an error occurred (including a missing Lens).
50
50
 
@@ -52,7 +52,7 @@ ___
52
52
 
53
53
  ### loadLensGroups
54
54
 
55
- ▸ **loadLensGroups**(`groupIds`): `Promise`<{ `errors`: `Error`[] ; `lenses`: [`Lens`](../interfaces/Lens.md)[] }\>
55
+ ▸ **loadLensGroups**(`groupIds`): `Promise`\<\{ `errors`: `Error`[] ; `lenses`: [`Lens`](../interfaces/Lens.md)[] }\>
56
56
 
57
57
  Retrieve the Lenses contained in a list of Lens Groups.
58
58
 
@@ -68,7 +68,7 @@ Lenses which could be successfully retrieved will be available in the response.
68
68
 
69
69
  #### Returns
70
70
 
71
- `Promise`<{ `errors`: `Error`[] ; `lenses`: [`Lens`](../interfaces/Lens.md)[] }\>
71
+ `Promise`\<\{ `errors`: `Error`[] ; `lenses`: [`Lens`](../interfaces/Lens.md)[] }\>
72
72
 
73
73
  Resolves with a flattened list of all lenses in the desired groups. If any errors occurred during the
74
74
  query operation, these will be included in a separate list. If errors are present, the list of Lenses may not
@@ -78,25 +78,15 @@ ___
78
78
 
79
79
  ### cacheLensContent
80
80
 
81
- ▸ **cacheLensContent**(`lenses`, `assetTimingsToCache?`): `Promise`<`void`\>
81
+ ▸ **cacheLensContent**(`lenses`, `assetTimingsToCache?`): `Promise`\<`void`\>
82
82
 
83
- Loads and caches lens content and dependencies to reduce latency when [applyLens](CameraKitSession.md#applylens) is later
83
+ Loads and caches lens content and dependencies to reduce latency when [CameraKitSession.applyLens](CameraKitSession.md#applylens) is later
84
84
  called to apply the lens. This is an in-memory cache, it will not be persisted across page loads.
85
85
 
86
86
  This may useful if the application A) knows which lenses will be applied and B) has some opportunity to call
87
87
  this method before a lens is applied. For example, if the user must perform some other actions before lenses
88
88
  become active, this might be a good opportunity to cache lenses to improve applyLens latency.
89
89
 
90
- **`Example`**
91
-
92
- ```ts
93
- const lens = await cameraKit.lensRepository.loadLens(lensId, groupId)
94
- await cameraKit.lensRepository.cacheLensContent([lens])
95
-
96
- // sometime later -- this call will use the cached lens content, making lens application faster.
97
- await cameraKitSession.applyLens(lens)
98
- ```
99
-
100
90
  #### Parameters
101
91
 
102
92
  | Name | Type | Description |
@@ -106,7 +96,17 @@ await cameraKitSession.applyLens(lens)
106
96
 
107
97
  #### Returns
108
98
 
109
- `Promise`<`void`\>
99
+ `Promise`\<`void`\>
100
+
101
+ **`Example`**
102
+
103
+ ```ts
104
+ const lens = await cameraKit.lensRepository.loadLens(lensId, groupId)
105
+ await cameraKit.lensRepository.cacheLensContent([lens])
106
+
107
+ // sometime later -- this call will use the cached lens content, making lens application faster.
108
+ await cameraKitSession.applyLens(lens)
109
+ ```
110
110
 
111
111
  ___
112
112
 
@@ -1,9 +1,9 @@
1
- [CameraKit Web SDK - v0.15.1-alpha.1](../README.md) / [Exports](../modules.md) / Transform2D
1
+ [CameraKit Web SDK - v0.16.2](../README.md) / [Exports](../modules.md) / Transform2D
2
2
 
3
3
  # Class: Transform2D
4
4
 
5
5
  Use this class to supply the CameraKitSession::setSourceTransform with the proper data
6
- needed to apply transformations
6
+ needed to apply transformations.
7
7
 
8
8
  ## Table of contents
9
9
 
@@ -22,7 +22,7 @@ needed to apply transformations
22
22
 
23
23
  ### constructor
24
24
 
25
- • **new Transform2D**(`matrix`)
25
+ • **new Transform2D**(`matrix`): [`Transform2D`](Transform2D.md)
26
26
 
27
27
  #### Parameters
28
28
 
@@ -30,6 +30,10 @@ needed to apply transformations
30
30
  | :------ | :------ | :------ |
31
31
  | `matrix` | [`number`, `number`, `number`, `number`, `number`, `number`, `number`, `number`, `number`] | A 3x3 matrix in column-major order, representing a 2D transform to be applied to the source media |
32
32
 
33
+ #### Returns
34
+
35
+ [`Transform2D`](Transform2D.md)
36
+
33
37
  ## Properties
34
38
 
35
39
  ### MirrorX
@@ -1,6 +1,6 @@
1
- [CameraKit Web SDK - v0.15.1-alpha.1](../README.md) / [Exports](../modules.md) / TypedCustomEvent
1
+ [CameraKit Web SDK - v0.16.2](../README.md) / [Exports](../modules.md) / TypedCustomEvent
2
2
 
3
- # Class: TypedCustomEvent<N, T\>
3
+ # Class: TypedCustomEvent\<N, T\>
4
4
 
5
5
  This wrapper around CustomEvent provides more descriptive type information. By using this class, the `type` property
6
6
  of the CustomEvent will be typed as a string literal – this allows [TypedEventTarget] to provide more useful type
@@ -15,7 +15,7 @@ checking of events.
15
15
 
16
16
  ## Hierarchy
17
17
 
18
- - `CustomEvent`<`T`\>
18
+ - `CustomEvent`\<`T`\>
19
19
 
20
20
  ↳ **`TypedCustomEvent`**
21
21
 
@@ -33,7 +33,7 @@ checking of events.
33
33
 
34
34
  ### constructor
35
35
 
36
- • **new TypedCustomEvent**<`N`, `T`\>(`type`, `detail`, `eventInitDict?`)
36
+ • **new TypedCustomEvent**\<`N`, `T`\>(`type`, `detail`, `eventInitDict?`): [`TypedCustomEvent`](TypedCustomEvent.md)\<`N`, `T`\>
37
37
 
38
38
  #### Type parameters
39
39
 
@@ -48,11 +48,15 @@ checking of events.
48
48
  | :------ | :------ |
49
49
  | `type` | `N` |
50
50
  | `detail` | `T` |
51
- | `eventInitDict` | `Omit`<`CustomEventInit`<`T`\>, ``"detail"``\> |
51
+ | `eventInitDict` | `Omit`\<`CustomEventInit`\<`T`\>, ``"detail"``\> |
52
+
53
+ #### Returns
54
+
55
+ [`TypedCustomEvent`](TypedCustomEvent.md)\<`N`, `T`\>
52
56
 
53
57
  #### Overrides
54
58
 
55
- CustomEvent&lt;T\&gt;.constructor
59
+ CustomEvent\&lt;T\&gt;.constructor
56
60
 
57
61
  ## Properties
58
62
 
@@ -1,6 +1,6 @@
1
- [CameraKit Web SDK - v0.15.1-alpha.1](../README.md) / [Exports](../modules.md) / TypedEventTarget
1
+ [CameraKit Web SDK - v0.16.2](../README.md) / [Exports](../modules.md) / TypedEventTarget
2
2
 
3
- # Class: TypedEventTarget<Events\>
3
+ # Class: TypedEventTarget\<Events\>
4
4
 
5
5
  This wrapper around EventTarget provides more descriptive type information. By using this class, calls to EventTarget
6
6
  methods are correctly type checked to ensure only allowed event types are used, and that events and their type
@@ -31,19 +31,23 @@ type corresponding to the type of event for which the listener has been added.
31
31
 
32
32
  ### constructor
33
33
 
34
- • **new TypedEventTarget**<`Events`\>()
34
+ • **new TypedEventTarget**\<`Events`\>(): [`TypedEventTarget`](TypedEventTarget.md)\<`Events`\>
35
35
 
36
36
  #### Type parameters
37
37
 
38
38
  | Name | Type |
39
39
  | :------ | :------ |
40
- | `Events` | extends [`TypedCustomEvent`](TypedCustomEvent.md)<`string`, `any`, `Events`\> = [`TypedCustomEvent`](TypedCustomEvent.md)<`string`, `any`\> |
40
+ | `Events` | extends [`TypedCustomEvent`](TypedCustomEvent.md)\<`string`, `any`, `Events`\> = [`TypedCustomEvent`](TypedCustomEvent.md)\<`string`, `any`\> |
41
+
42
+ #### Returns
43
+
44
+ [`TypedEventTarget`](TypedEventTarget.md)\<`Events`\>
41
45
 
42
46
  ## Methods
43
47
 
44
48
  ### addEventListener
45
49
 
46
- ▸ **addEventListener**<`K`\>(`type`, `callback`, `options?`): `void`
50
+ ▸ **addEventListener**\<`K`\>(`type`, `callback`, `options?`): `void`
47
51
 
48
52
  #### Type parameters
49
53
 
@@ -56,7 +60,7 @@ type corresponding to the type of event for which the listener has been added.
56
60
  | Name | Type |
57
61
  | :------ | :------ |
58
62
  | `type` | `K` |
59
- | `callback` | `TypedEventListener`<`EventOfType`<`K`, `Events`\>\> |
63
+ | `callback` | `TypedEventListener`\<`EventOfType`\<`K`, `Events`\>\> |
60
64
  | `options?` | `TypedEventListenerOptions` |
61
65
 
62
66
  #### Returns
@@ -83,7 +87,7 @@ ___
83
87
 
84
88
  ### removeEventListener
85
89
 
86
- ▸ **removeEventListener**<`K`\>(`type`, `callback`): `void`
90
+ ▸ **removeEventListener**\<`K`\>(`type`, `callback`): `void`
87
91
 
88
92
  #### Type parameters
89
93
 
@@ -96,7 +100,7 @@ ___
96
100
  | Name | Type |
97
101
  | :------ | :------ |
98
102
  | `type` | `K` |
99
- | `callback` | `TypedEventListener`<`EventOfType`<`K`, `Events`\>\> |
103
+ | `callback` | `TypedEventListener`\<`EventOfType`\<`K`, `Events`\>\> |
100
104
 
101
105
  #### Returns
102
106
 
@@ -0,0 +1,36 @@
1
+ [CameraKit Web SDK - v0.16.2](../README.md) / [Exports](../modules.md) / Lens\_CameraFacing
2
+
3
+ # Enumeration: Lens\_CameraFacing
4
+
5
+ ## Table of contents
6
+
7
+ ### Enumeration Members
8
+
9
+ - [CAMERA\_FACING\_UNSET](Lens_CameraFacing.md#camera_facing_unset)
10
+ - [CAMERA\_FACING\_FRONT](Lens_CameraFacing.md#camera_facing_front)
11
+ - [CAMERA\_FACING\_BACK](Lens_CameraFacing.md#camera_facing_back)
12
+ - [UNRECOGNIZED](Lens_CameraFacing.md#unrecognized)
13
+
14
+ ## Enumeration Members
15
+
16
+ ### CAMERA\_FACING\_UNSET
17
+
18
+ • **CAMERA\_FACING\_UNSET** = ``0``
19
+
20
+ ___
21
+
22
+ ### CAMERA\_FACING\_FRONT
23
+
24
+ • **CAMERA\_FACING\_FRONT** = ``1``
25
+
26
+ ___
27
+
28
+ ### CAMERA\_FACING\_BACK
29
+
30
+ • **CAMERA\_FACING\_BACK** = ``2``
31
+
32
+ ___
33
+
34
+ ### UNRECOGNIZED
35
+
36
+ • **UNRECOGNIZED** = ``-1``
@@ -0,0 +1,106 @@
1
+ [CameraKit Web SDK - v0.16.2](../README.md) / [Exports](../modules.md) / UserData\_Zodiac
2
+
3
+ # Enumeration: UserData\_Zodiac
4
+
5
+ ## Table of contents
6
+
7
+ ### Enumeration Members
8
+
9
+ - [Invalid](UserData_Zodiac.md#invalid)
10
+ - [Aquarius](UserData_Zodiac.md#aquarius)
11
+ - [Aries](UserData_Zodiac.md#aries)
12
+ - [Cancer](UserData_Zodiac.md#cancer)
13
+ - [Capricorn](UserData_Zodiac.md#capricorn)
14
+ - [Gemini](UserData_Zodiac.md#gemini)
15
+ - [Leo](UserData_Zodiac.md#leo)
16
+ - [Libra](UserData_Zodiac.md#libra)
17
+ - [Pisces](UserData_Zodiac.md#pisces)
18
+ - [Sagittarius](UserData_Zodiac.md#sagittarius)
19
+ - [Scorpio](UserData_Zodiac.md#scorpio)
20
+ - [Taurus](UserData_Zodiac.md#taurus)
21
+ - [Virgo](UserData_Zodiac.md#virgo)
22
+ - [UNRECOGNIZED](UserData_Zodiac.md#unrecognized)
23
+
24
+ ## Enumeration Members
25
+
26
+ ### Invalid
27
+
28
+ • **Invalid** = ``"Invalid"``
29
+
30
+ ___
31
+
32
+ ### Aquarius
33
+
34
+ • **Aquarius** = ``"Aquarius"``
35
+
36
+ ___
37
+
38
+ ### Aries
39
+
40
+ • **Aries** = ``"Aries"``
41
+
42
+ ___
43
+
44
+ ### Cancer
45
+
46
+ • **Cancer** = ``"Cancer"``
47
+
48
+ ___
49
+
50
+ ### Capricorn
51
+
52
+ • **Capricorn** = ``"Capricorn"``
53
+
54
+ ___
55
+
56
+ ### Gemini
57
+
58
+ • **Gemini** = ``"Gemini"``
59
+
60
+ ___
61
+
62
+ ### Leo
63
+
64
+ • **Leo** = ``"Leo"``
65
+
66
+ ___
67
+
68
+ ### Libra
69
+
70
+ • **Libra** = ``"Libra"``
71
+
72
+ ___
73
+
74
+ ### Pisces
75
+
76
+ • **Pisces** = ``"Pisces"``
77
+
78
+ ___
79
+
80
+ ### Sagittarius
81
+
82
+ • **Sagittarius** = ``"Sagittarius"``
83
+
84
+ ___
85
+
86
+ ### Scorpio
87
+
88
+ • **Scorpio** = ``"Scorpio"``
89
+
90
+ ___
91
+
92
+ ### Taurus
93
+
94
+ • **Taurus** = ``"Taurus"``
95
+
96
+ ___
97
+
98
+ ### Virgo
99
+
100
+ • **Virgo** = ``"Virgo"``
101
+
102
+ ___
103
+
104
+ ### UNRECOGNIZED
105
+
106
+ • **UNRECOGNIZED** = ``"UNRECOGNIZED"``
@@ -1,4 +1,4 @@
1
- [CameraKit Web SDK - v0.15.1-alpha.1](../README.md) / [Exports](../modules.md) / CameraKitBootstrapConfiguration
1
+ [CameraKit Web SDK - v0.16.2](../README.md) / [Exports](../modules.md) / CameraKitBootstrapConfiguration
2
2
 
3
3
  # Interface: CameraKitBootstrapConfiguration
4
4
 
@@ -53,7 +53,7 @@ ___
53
53
 
54
54
  ### lensPerformance
55
55
 
56
- • `Optional` **lensPerformance**: [`EstimatedLensPerformance`](EstimatedLensPerformance.md) \| `Promise`<[`EstimatedLensPerformance`](EstimatedLensPerformance.md)\>
56
+ • `Optional` **lensPerformance**: [`EstimatedLensPerformance`](EstimatedLensPerformance.md) \| `Promise`\<[`EstimatedLensPerformance`](EstimatedLensPerformance.md)\>
57
57
 
58
58
  Some lenses may decide to modify their behavior based on the performance of the current environment. If you are
59
59
  using such lenses, providing an estimation of lens performance may lead to better user experience (especially on
@@ -0,0 +1,41 @@
1
+ [CameraKit Web SDK - v0.16.2](../README.md) / [Exports](../modules.md) / CameraKitDeviceOptions
2
+
3
+ # Interface: CameraKitDeviceOptions
4
+
5
+ Device options.
6
+
7
+ ## Hierarchy
8
+
9
+ - **`CameraKitDeviceOptions`**
10
+
11
+ ↳ [`MediaStreamSourceOptions`](MediaStreamSourceOptions.md)
12
+
13
+ ↳ [`VideoSourceOptions`](VideoSourceOptions.md)
14
+
15
+ ## Table of contents
16
+
17
+ ### Properties
18
+
19
+ - [cameraType](CameraKitDeviceOptions.md#cameratype)
20
+ - [fpsLimit](CameraKitDeviceOptions.md#fpslimit)
21
+
22
+ ## Properties
23
+
24
+ ### cameraType
25
+
26
+ • **cameraType**: ``"user"`` \| ``"environment"``
27
+
28
+ Specifies the camera type for which certain features are enabled or disabled.
29
+ For example, surface tracking features are only active when the camera is set to "environment" mode.
30
+ The default value is "user", which accommodates the majority of Lenses.
31
+ "user" refers to the front-facing camera, while "environment" refers to the rear-facing camera.
32
+
33
+ ___
34
+
35
+ ### fpsLimit
36
+
37
+ • **fpsLimit**: `number`
38
+
39
+ Limits the frames per second (FPS) to optimize performance by reducing compute resources
40
+ when high FPS is not critical. By default, no limit is set, allowing usage of the video's native FPS.
41
+ Useful for controlling resource usage on varying device capabilities.
@@ -0,0 +1,43 @@
1
+ [CameraKit Web SDK - v0.16.2](../README.md) / [Exports](../modules.md) / CameraKitSourceInfo
2
+
3
+ # Interface: CameraKitSourceInfo
4
+
5
+ ## Table of contents
6
+
7
+ ### Properties
8
+
9
+ - [media](CameraKitSourceInfo.md#media)
10
+ - [useManualFrameProcessing](CameraKitSourceInfo.md#usemanualframeprocessing)
11
+ - [replayTrackingData](CameraKitSourceInfo.md#replaytrackingdata)
12
+
13
+ ## Properties
14
+
15
+ ### media
16
+
17
+ • `Optional` **media**: `HTMLImageElement` \| `HTMLCanvasElement` \| `HTMLVideoElement` \| `MediaStream`
18
+
19
+ HTML element or MediaStream as an input source.
20
+ If useManualFrameProcessing is true, then this parameter is optional.
21
+
22
+ ___
23
+
24
+ ### useManualFrameProcessing
25
+
26
+ • `Optional` **useManualFrameProcessing**: `boolean`
27
+
28
+ Whether to provide frames manually.
29
+
30
+ ___
31
+
32
+ ### replayTrackingData
33
+
34
+ • `Optional` **replayTrackingData**: `Object`
35
+
36
+ If specified, the passed-in tracking data buffer will be used as tracking data for the current
37
+ media element instead of live tracking data.
38
+
39
+ #### Type declaration
40
+
41
+ | Name | Type |
42
+ | :------ | :------ |
43
+ | `buffer` | `ArrayBuffer` \| `Uint8Array` |
@@ -1,4 +1,4 @@
1
- [CameraKit Web SDK - v0.15.1-alpha.1](../README.md) / [Exports](../modules.md) / CameraKitSourceSubscriber
1
+ [CameraKit Web SDK - v0.16.2](../README.md) / [Exports](../modules.md) / CameraKitSourceSubscriber
2
2
 
3
3
  # Interface: CameraKitSourceSubscriber
4
4
 
@@ -16,11 +16,11 @@ run whenever that source is attached/detached from a CameraKitSession.
16
16
 
17
17
  ### onAttach
18
18
 
19
- • `Optional` `Readonly` **onAttach**: (`source`: [`CameraKitSource`](../classes/CameraKitSource.md), `lensCore`: `LensCore`, `reportError`: (`error`: `Error`) => `void`) => `void` \| `Promise`<`void`\>
19
+ • `Optional` `Readonly` **onAttach**: (`source`: [`CameraKitSource`](../classes/CameraKitSource.md), `lensCore`: `LensCore`, `reportError`: (`error`: `Error`) => `void`) => `void` \| `Promise`\<`void`\>
20
20
 
21
21
  #### Type declaration
22
22
 
23
- ▸ (`source`, `lensCore`, `reportError`): `void` \| `Promise`<`void`\>
23
+ ▸ (`source`, `lensCore`, `reportError`): `void` \| `Promise`\<`void`\>
24
24
 
25
25
  ##### Parameters
26
26
 
@@ -32,17 +32,17 @@ run whenever that source is attached/detached from a CameraKitSession.
32
32
 
33
33
  ##### Returns
34
34
 
35
- `void` \| `Promise`<`void`\>
35
+ `void` \| `Promise`\<`void`\>
36
36
 
37
37
  ___
38
38
 
39
39
  ### onDetach
40
40
 
41
- • `Optional` `Readonly` **onDetach**: (`reportError`: (`error`: `Error`) => `void`) => `void` \| `Promise`<`void`\>
41
+ • `Optional` `Readonly` **onDetach**: (`reportError`: (`error`: `Error`) => `void`) => `void` \| `Promise`\<`void`\>
42
42
 
43
43
  #### Type declaration
44
44
 
45
- ▸ (`reportError`): `void` \| `Promise`<`void`\>
45
+ ▸ (`reportError`): `void` \| `Promise`\<`void`\>
46
46
 
47
47
  ##### Parameters
48
48
 
@@ -52,4 +52,4 @@ ___
52
52
 
53
53
  ##### Returns
54
54
 
55
- `void` \| `Promise`<`void`\>
55
+ `void` \| `Promise`\<`void`\>