@snap/camera-kit 1.0.1 → 1.1.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.
Files changed (264) hide show
  1. package/README.md +1 -1
  2. package/dist/CameraKit.d.ts +4 -0
  3. package/dist/CameraKit.d.ts.map +1 -1
  4. package/dist/CameraKit.js +8 -2
  5. package/dist/CameraKit.js.map +1 -1
  6. package/dist/RootServices.d.ts +4 -2
  7. package/dist/RootServices.d.ts.map +1 -1
  8. package/dist/RootServices.js.map +1 -1
  9. package/dist/bootstrapCameraKit.d.ts.map +1 -1
  10. package/dist/bootstrapCameraKit.js +4 -2
  11. package/dist/bootstrapCameraKit.js.map +1 -1
  12. package/dist/clients/remoteApiSpecsClient.d.ts +10 -0
  13. package/dist/clients/remoteApiSpecsClient.d.ts.map +1 -0
  14. package/dist/clients/remoteApiSpecsClient.js +6 -0
  15. package/dist/clients/remoteApiSpecsClient.js.map +1 -0
  16. package/dist/common/typeguards.d.ts +3 -0
  17. package/dist/common/typeguards.d.ts.map +1 -1
  18. package/dist/common/typeguards.js +12 -0
  19. package/dist/common/typeguards.js.map +1 -1
  20. package/dist/configuration.d.ts +115 -0
  21. package/dist/configuration.d.ts.map +1 -1
  22. package/dist/configuration.js +1 -0
  23. package/dist/configuration.js.map +1 -1
  24. package/dist/environment.js +1 -1
  25. package/dist/environment.js.map +1 -1
  26. package/dist/index.d.ts +3 -3
  27. package/dist/index.d.ts.map +1 -1
  28. package/dist/index.js +3 -3
  29. package/dist/index.js.map +1 -1
  30. package/dist/lensCoreWasmVersions.js +3 -3
  31. package/dist/lensCoreWasmVersions.js.map +1 -1
  32. package/dist/session/LensKeyboard.d.ts +1 -1
  33. package/dist/session/LensKeyboard.d.ts.map +1 -1
  34. package/dist/session/LensKeyboard.js.map +1 -1
  35. package/dist/uri-handlers/UriHandlers.d.ts.map +1 -0
  36. package/dist/uri-handlers/UriHandlers.js.map +1 -0
  37. package/dist/uri-handlers/internal-handlers/httpUriHandler.d.ts +35 -0
  38. package/dist/uri-handlers/internal-handlers/httpUriHandler.d.ts.map +1 -0
  39. package/dist/uri-handlers/internal-handlers/httpUriHandler.js +144 -0
  40. package/dist/uri-handlers/internal-handlers/httpUriHandler.js.map +1 -0
  41. package/dist/uri-handlers/internal-handlers/httpValidators.d.ts +9 -0
  42. package/dist/uri-handlers/internal-handlers/httpValidators.d.ts.map +1 -0
  43. package/dist/uri-handlers/internal-handlers/httpValidators.js +115 -0
  44. package/dist/uri-handlers/internal-handlers/httpValidators.js.map +1 -0
  45. package/dist/{extensions/RemoteApiServices.d.ts → uri-handlers/internal-handlers/remoteApiUriHandler.d.ts} +8 -8
  46. package/dist/uri-handlers/internal-handlers/remoteApiUriHandler.d.ts.map +1 -0
  47. package/dist/uri-handlers/internal-handlers/remoteApiUriHandler.js +121 -0
  48. package/dist/uri-handlers/internal-handlers/remoteApiUriHandler.js.map +1 -0
  49. package/dist/{extensions → uri-handlers}/uriHandlersRegister.d.ts +6 -4
  50. package/dist/uri-handlers/uriHandlersRegister.d.ts.map +1 -0
  51. package/dist/{extensions → uri-handlers}/uriHandlersRegister.js +13 -3
  52. package/dist/uri-handlers/uriHandlersRegister.js.map +1 -0
  53. package/dist/uri-handlers/uriRequestProcessor.d.ts +37 -0
  54. package/dist/uri-handlers/uriRequestProcessor.d.ts.map +1 -0
  55. package/dist/uri-handlers/uriRequestProcessor.js +69 -0
  56. package/dist/uri-handlers/uriRequestProcessor.js.map +1 -0
  57. package/docs/html/assets/hierarchy.js +1 -0
  58. package/docs/html/assets/highlight.css +9 -2
  59. package/docs/html/assets/icons.js +18 -0
  60. package/docs/html/assets/icons.svg +1 -0
  61. package/docs/html/assets/main.js +5 -4
  62. package/docs/html/assets/navigation.js +1 -1
  63. package/docs/html/assets/search.js +1 -1
  64. package/docs/html/assets/style.css +1422 -1226
  65. package/docs/html/classes/CameraKit.html +18 -16
  66. package/docs/html/classes/CameraKitSession.html +76 -51
  67. package/docs/html/classes/CameraKitSource.html +18 -18
  68. package/docs/html/classes/LensPerformanceMeasurement.html +11 -11
  69. package/docs/html/classes/LensPerformanceMetrics.html +8 -7
  70. package/docs/html/classes/LensRepository.html +25 -23
  71. package/docs/html/classes/Transform2D.html +9 -9
  72. package/docs/html/classes/TypedCustomEvent.html +5 -4
  73. package/docs/html/classes/TypedEventTarget.html +6 -6
  74. package/docs/html/enums/Lens_CameraFacing.html +5 -5
  75. package/docs/html/functions/bootstrapCameraKit.html +11 -10
  76. package/docs/html/functions/createExtension.html +7 -6
  77. package/docs/html/functions/createImageSource.html +5 -5
  78. package/docs/html/functions/createMediaStreamSource.html +5 -5
  79. package/docs/html/functions/createVideoSource.html +5 -5
  80. package/docs/html/functions/estimateLensPerformance.html +2 -2
  81. package/docs/html/functions/filePickerFactory.html +2 -2
  82. package/docs/html/functions/lensSourcesFactory.html +5 -4
  83. package/docs/html/functions/remoteApiServicesFactory.html +1 -1
  84. package/docs/html/hierarchy.html +1 -1
  85. package/docs/html/index.html +111 -88
  86. package/docs/html/interfaces/BitmojiUserInfo.html +3 -3
  87. package/docs/html/interfaces/CameraKitBootstrapConfiguration.html +40 -21
  88. package/docs/html/interfaces/CameraKitDeviceOptions.html +7 -7
  89. package/docs/html/interfaces/CameraKitSourceInfo.html +7 -7
  90. package/docs/html/interfaces/CameraKitSourceSubscriber.html +4 -4
  91. package/docs/html/interfaces/ComputedFrameMetrics.html +6 -6
  92. package/docs/html/interfaces/CreateSessionOptions.html +7 -7
  93. package/docs/html/interfaces/EstimatedLensPerformance.html +5 -5
  94. package/docs/html/interfaces/Font.html +6 -0
  95. package/docs/html/interfaces/FriendUserInfo.html +4 -4
  96. package/docs/html/interfaces/FunctionSourceOptions.html +4 -4
  97. package/docs/html/interfaces/Lens.html +21 -21
  98. package/docs/html/interfaces/LensCreator.html +3 -3
  99. package/docs/html/interfaces/LensHttpRequest.html +16 -0
  100. package/docs/html/interfaces/LensLaunchData.html +6 -6
  101. package/docs/html/interfaces/LensSource.html +5 -5
  102. package/docs/html/interfaces/LensUserData.html +10 -10
  103. package/docs/html/interfaces/LoadAssetRequest.html +10 -10
  104. package/docs/html/interfaces/MediaStreamSourceOptions.html +11 -11
  105. package/docs/html/interfaces/Preview.html +4 -4
  106. package/docs/html/interfaces/RemoteApiRequest.html +10 -10
  107. package/docs/html/interfaces/RemoteApiResponse.html +8 -8
  108. package/docs/html/interfaces/RemoteApiService.html +9 -9
  109. package/docs/html/interfaces/Snapcode.html +6 -6
  110. package/docs/html/interfaces/UriCancelRequest.html +3 -3
  111. package/docs/html/interfaces/UriRequest.html +7 -7
  112. package/docs/html/interfaces/UriResponse.html +6 -6
  113. package/docs/html/interfaces/VideoSourceOptions.html +9 -9
  114. package/docs/html/modules.html +1 -99
  115. package/docs/html/types/ArgumentValidationError.html +2 -2
  116. package/docs/html/types/AssetLoader.html +4 -4
  117. package/docs/html/types/AssetResponse.html +1 -1
  118. package/docs/html/types/AssetTiming.html +2 -2
  119. package/docs/html/types/BenchmarkError.html +1 -1
  120. package/docs/html/types/BootstrapError.html +2 -2
  121. package/docs/html/types/CacheKeyNotFoundError.html +1 -1
  122. package/docs/html/types/CameraKitSessionEventListener.html +2 -2
  123. package/docs/html/types/CameraKitSessionEvents.html +4 -3
  124. package/docs/html/types/CameraKitSourceError.html +1 -1
  125. package/docs/html/types/ConfigurationError.html +2 -2
  126. package/docs/html/types/FetchHandler.html +1 -1
  127. package/docs/html/types/FilePicker.html +5 -5
  128. package/docs/html/types/FilePickerOptions.html +2 -2
  129. package/docs/html/types/FilePickerResult.html +2 -2
  130. package/docs/html/types/Keyboard.html +9 -16
  131. package/docs/html/types/KeyboardEvents.html +2 -2
  132. package/docs/html/types/LegalError.html +1 -1
  133. package/docs/html/types/LensAbortError.html +6 -5
  134. package/docs/html/types/LensAssetError.html +2 -2
  135. package/docs/html/types/LensContentValidationError.html +1 -1
  136. package/docs/html/types/LensError.html +1 -1
  137. package/docs/html/types/LensExecutionError.html +6 -5
  138. package/docs/html/types/LensHttpHandler.html +9 -0
  139. package/docs/html/types/LensImagePickerError.html +2 -2
  140. package/docs/html/types/LensLaunchParams.html +2 -2
  141. package/docs/html/types/LensMetricsEvents.html +2 -2
  142. package/docs/html/types/LensPerformanceCluster.html +1 -1
  143. package/docs/html/types/LensView.html +3 -3
  144. package/docs/html/types/LensWait.html +2 -2
  145. package/docs/html/types/Matrix.html +2 -2
  146. package/docs/html/types/PersistentStoreError.html +2 -2
  147. package/docs/html/types/PlatformNotSupportedError.html +3 -3
  148. package/docs/html/types/PublicContainer.html +2 -2
  149. package/docs/html/types/PublicServices.html +2 -2
  150. package/docs/html/types/RemoteApiCancelRequestHandler.html +2 -2
  151. package/docs/html/types/RemoteApiRequestHandler.html +2 -2
  152. package/docs/html/types/RemoteApiServices.html +1 -1
  153. package/docs/html/types/RemoteApiStatus.html +2 -2
  154. package/docs/html/types/RenderTarget.html +3 -3
  155. package/docs/html/types/Uri.html +1 -1
  156. package/docs/html/types/WebGLError.html +1 -1
  157. package/docs/html/types/Zodiac.html +1 -1
  158. package/docs/html/variables/extensionRequestContext.html +2 -2
  159. package/docs/md/README.md +5 -3
  160. package/docs/md/classes/CameraKit.md +26 -37
  161. package/docs/md/classes/CameraKitSession.md +146 -107
  162. package/docs/md/classes/CameraKitSource.md +46 -37
  163. package/docs/md/classes/LensPerformanceMeasurement.md +18 -26
  164. package/docs/md/classes/LensPerformanceMetrics.md +8 -10
  165. package/docs/md/classes/LensRepository.md +66 -45
  166. package/docs/md/classes/Transform2D.md +19 -26
  167. package/docs/md/classes/TypedCustomEvent.md +24 -32
  168. package/docs/md/classes/TypedEventTarget.md +43 -54
  169. package/docs/md/enumerations/Lens_CameraFacing.md +31 -0
  170. package/docs/md/functions/bootstrapCameraKit.md +66 -0
  171. package/docs/md/functions/createExtension.md +50 -0
  172. package/docs/md/functions/createImageSource.md +30 -0
  173. package/docs/md/functions/createMediaStreamSource.md +30 -0
  174. package/docs/md/functions/createVideoSource.md +31 -0
  175. package/docs/md/functions/estimateLensPerformance.md +18 -0
  176. package/docs/md/functions/filePickerFactory.md +22 -0
  177. package/docs/md/functions/lensSourcesFactory.md +37 -0
  178. package/docs/md/functions/remoteApiServicesFactory.md +19 -0
  179. package/docs/md/globals.md +121 -0
  180. package/docs/md/interfaces/BitmojiUserInfo.md +9 -12
  181. package/docs/md/interfaces/CameraKitBootstrapConfiguration.md +99 -40
  182. package/docs/md/interfaces/CameraKitDeviceOptions.md +11 -17
  183. package/docs/md/interfaces/CameraKitSourceInfo.md +14 -20
  184. package/docs/md/interfaces/CameraKitSourceSubscriber.md +23 -28
  185. package/docs/md/interfaces/ComputedFrameMetrics.md +13 -19
  186. package/docs/md/interfaces/CreateSessionOptions.md +10 -13
  187. package/docs/md/interfaces/EstimatedLensPerformance.md +10 -14
  188. package/docs/md/interfaces/Font.md +25 -0
  189. package/docs/md/interfaces/FriendUserInfo.md +12 -16
  190. package/docs/md/interfaces/FunctionSourceOptions.md +6 -8
  191. package/docs/md/interfaces/Lens.md +26 -37
  192. package/docs/md/interfaces/LensCreator.md +6 -8
  193. package/docs/md/interfaces/LensHttpRequest.md +60 -0
  194. package/docs/md/interfaces/LensLaunchData.md +13 -17
  195. package/docs/md/interfaces/LensSource.md +26 -27
  196. package/docs/md/interfaces/LensUserData.md +30 -40
  197. package/docs/md/interfaces/LoadAssetRequest.md +13 -18
  198. package/docs/md/interfaces/MediaStreamSourceOptions.md +15 -22
  199. package/docs/md/interfaces/Preview.md +6 -8
  200. package/docs/md/interfaces/RemoteApiRequest.md +12 -17
  201. package/docs/md/interfaces/RemoteApiResponse.md +10 -14
  202. package/docs/md/interfaces/RemoteApiService.md +20 -19
  203. package/docs/md/interfaces/Snapcode.md +8 -11
  204. package/docs/md/interfaces/UriCancelRequest.md +7 -10
  205. package/docs/md/interfaces/UriRequest.md +15 -22
  206. package/docs/md/interfaces/UriResponse.md +14 -20
  207. package/docs/md/interfaces/VideoSourceOptions.md +13 -19
  208. package/docs/md/type-aliases/ArgumentValidationError.md +11 -0
  209. package/docs/md/type-aliases/AssetLoader.md +26 -0
  210. package/docs/md/type-aliases/AssetResponse.md +9 -0
  211. package/docs/md/type-aliases/AssetTiming.md +18 -0
  212. package/docs/md/type-aliases/BenchmarkError.md +9 -0
  213. package/docs/md/type-aliases/BootstrapError.md +12 -0
  214. package/docs/md/type-aliases/CacheKeyNotFoundError.md +9 -0
  215. package/docs/md/type-aliases/CameraKitSessionEventListener.md +11 -0
  216. package/docs/md/type-aliases/CameraKitSessionEvents.md +17 -0
  217. package/docs/md/type-aliases/CameraKitSourceError.md +9 -0
  218. package/docs/md/type-aliases/ConfigurationError.md +11 -0
  219. package/docs/md/type-aliases/FetchHandler.md +27 -0
  220. package/docs/md/type-aliases/FilePicker.md +32 -0
  221. package/docs/md/type-aliases/FilePickerOptions.md +11 -0
  222. package/docs/md/type-aliases/FilePickerResult.md +11 -0
  223. package/docs/md/type-aliases/Keyboard.md +114 -0
  224. package/docs/md/type-aliases/KeyboardEvents.md +11 -0
  225. package/docs/md/type-aliases/LegalError.md +9 -0
  226. package/docs/md/type-aliases/LensAbortError.md +22 -0
  227. package/docs/md/type-aliases/LensAssetError.md +11 -0
  228. package/docs/md/type-aliases/LensContentValidationError.md +9 -0
  229. package/docs/md/type-aliases/LensError.md +9 -0
  230. package/docs/md/type-aliases/LensExecutionError.md +23 -0
  231. package/docs/md/type-aliases/LensHttpHandler.md +41 -0
  232. package/docs/md/type-aliases/LensImagePickerError.md +12 -0
  233. package/docs/md/type-aliases/LensLaunchParams.md +11 -0
  234. package/docs/md/type-aliases/LensMetricsEvents.md +13 -0
  235. package/docs/md/type-aliases/LensPerformanceCluster.md +9 -0
  236. package/docs/md/type-aliases/LensView.md +21 -0
  237. package/docs/md/type-aliases/LensWait.md +13 -0
  238. package/docs/md/type-aliases/Matrix.md +12 -0
  239. package/docs/md/type-aliases/PersistentStoreError.md +11 -0
  240. package/docs/md/type-aliases/PlatformNotSupportedError.md +13 -0
  241. package/docs/md/type-aliases/PublicContainer.md +12 -0
  242. package/docs/md/type-aliases/PublicServices.md +11 -0
  243. package/docs/md/type-aliases/RemoteApiCancelRequestHandler.md +15 -0
  244. package/docs/md/type-aliases/RemoteApiRequestHandler.md +24 -0
  245. package/docs/md/type-aliases/RemoteApiServices.md +9 -0
  246. package/docs/md/type-aliases/RemoteApiStatus.md +11 -0
  247. package/docs/md/type-aliases/RenderTarget.md +14 -0
  248. package/docs/md/type-aliases/Uri.md +9 -0
  249. package/docs/md/type-aliases/WebGLError.md +9 -0
  250. package/docs/md/type-aliases/Zodiac.md +9 -0
  251. package/docs/md/variables/extensionRequestContext.md +11 -0
  252. package/package.json +5 -5
  253. package/dist/extensions/RemoteApiServices.d.ts.map +0 -1
  254. package/dist/extensions/RemoteApiServices.js +0 -159
  255. package/dist/extensions/RemoteApiServices.js.map +0 -1
  256. package/dist/extensions/UriHandlers.d.ts.map +0 -1
  257. package/dist/extensions/UriHandlers.js.map +0 -1
  258. package/dist/extensions/uriHandlersRegister.d.ts.map +0 -1
  259. package/dist/extensions/uriHandlersRegister.js.map +0 -1
  260. package/docs/md/.nojekyll +0 -1
  261. package/docs/md/enums/Lens_CameraFacing.md +0 -36
  262. package/docs/md/modules.md +0 -904
  263. /package/dist/{extensions → uri-handlers}/UriHandlers.d.ts +0 -0
  264. /package/dist/{extensions → uri-handlers}/UriHandlers.js +0 -0
package/docs/html/classes/CameraKitSession.html CHANGED
@@ -1,42 +1,44 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CameraKitSession | CameraKit Web SDK - v1.0.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><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">CameraKit Web SDK - v1.0.1</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">CameraKit Web SDK</a></li><li><a href="CameraKitSession.html">CameraKitSession</a></li></ul><h1>Class CameraKitSession</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A CameraKitSession represents a single rendering pipeline connecting an input media source to output <code>&lt;canvas&gt;</code>
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CameraKitSession | CameraKit Web SDK - v1.1.0</title><meta name="description" content="Documentation for CameraKit Web SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">CameraKit Web SDK - v1.1.0</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">CameraKit Web SDK</a></li><li><a href="CameraKitSession.html">CameraKitSession</a></li></ul><h1>Class CameraKitSession</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A CameraKitSession represents a single rendering pipeline connecting an input media source to output <code>&lt;canvas&gt;</code>
2
2
  elements. When a Lens is applied to the session, CameraKit uses the Lens to transform the input media into rendered
3
3
  output.</p>
4
4
  <p>CameraKitSession is the primary object that applications interact with when integrating the CameraKit SDK.</p>
5
- <p>A CameraKitSession instance is obtained by calling <a href="CameraKit.html#createSession" class="tsd-kind-method">CameraKit.createSession</a>.</p>
6
- </div><div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">cameraKit</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-5">bootstrapCameraKit</span><span class="hl-1">(</span><span class="hl-0">config</span><span class="hl-1">)</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">session</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">cameraKit</span><span class="hl-1">.</span><span class="hl-5">createSession</span><span class="hl-1">()</span>
7
- </code><button>Copy</button></pre>
8
- </div></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="CameraKitSession.html#output" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>output</span></a>
9
- <a href="CameraKitSession.html#playing" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>playing</span></a>
10
- <a href="CameraKitSession.html#events" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>events</span></a>
11
- <a href="CameraKitSession.html#metrics" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>metrics</span></a>
12
- <a href="CameraKitSession.html#keyboard" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>keyboard</span></a>
13
- </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="CameraKitSession.html#applyLens" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>apply<wbr/>Lens</span></a>
14
- <a href="CameraKitSession.html#removeLens" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>remove<wbr/>Lens</span></a>
15
- <a href="CameraKitSession.html#play" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>play</span></a>
16
- <a href="CameraKitSession.html#pause" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>pause</span></a>
17
- <a href="CameraKitSession.html#mute" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>mute</span></a>
18
- <a href="CameraKitSession.html#unmute" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>unmute</span></a>
19
- <a href="CameraKitSession.html#setSource" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Source</span></a>
20
- <a href="CameraKitSession.html#setFPSLimit" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>setFPSLimit</span></a>
21
- <a href="CameraKitSession.html#destroy" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>destroy</span></a>
22
- </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="output" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>output</span><a href="#output" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">output</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">live</span><span class="tsd-signature-symbol">: </span><a href="https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement" class="tsd-signature-type external" target="_blank">HTMLCanvasElement</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">capture</span><span class="tsd-signature-symbol">: </span><a href="https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement" class="tsd-signature-type external" target="_blank">HTMLCanvasElement</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>CameraKitSession renders video output to a <code>&lt;canvas&gt;</code> element. In fact, each session contains two canvas outputs
5
+ <p>A CameraKitSession instance is obtained by calling <a href="CameraKit.html#createsession" class="tsd-kind-method">CameraKit.createSession</a>.</p>
6
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example" class="tsd-anchor"></a>Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">cameraKit</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-5">bootstrapCameraKit</span><span class="hl-1">(</span><span class="hl-0">config</span><span class="hl-1">)</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">session</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">cameraKit</span><span class="hl-1">.</span><span class="hl-5">createSession</span><span class="hl-1">()</span>
7
+ </code><button type="button">Copy</button></pre>
8
+
9
+ </div></div></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="CameraKitSession.html#output" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>output</span></a>
10
+ <a href="CameraKitSession.html#playing" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>playing</span></a>
11
+ <a href="CameraKitSession.html#events" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>events</span></a>
12
+ <a href="CameraKitSession.html#metrics" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>metrics</span></a>
13
+ <a href="CameraKitSession.html#keyboard" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>keyboard</span></a>
14
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="CameraKitSession.html#applylens" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>apply<wbr/>Lens</span></a>
15
+ <a href="CameraKitSession.html#removelens" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Lens</span></a>
16
+ <a href="CameraKitSession.html#play" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>play</span></a>
17
+ <a href="CameraKitSession.html#pause" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pause</span></a>
18
+ <a href="CameraKitSession.html#mute" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>mute</span></a>
19
+ <a href="CameraKitSession.html#unmute" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>unmute</span></a>
20
+ <a href="CameraKitSession.html#setsource" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Source</span></a>
21
+ <a href="CameraKitSession.html#setfpslimit" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>setFPSLimit</span></a>
22
+ <a href="CameraKitSession.html#destroy" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>destroy</span></a>
23
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="output" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>output</span><a href="#output" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">output</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">live</span><span class="tsd-signature-symbol">:</span> <a href="https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement" class="tsd-signature-type external" target="_blank">HTMLCanvasElement</a><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">capture</span><span class="tsd-signature-symbol">:</span> <a href="https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement" class="tsd-signature-type external" target="_blank">HTMLCanvasElement</a> <span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>CameraKitSession renders video output to a <code>&lt;canvas&gt;</code> element. In fact, each session contains two canvas outputs
23
24
  corresponding to the RenderTargets used by Lens creators, when using LensStudio to create a Lens.</p>
24
25
  <p>The <code>live</code> output renders content suitable for the Lens user (e.g. it may contain additional UI elements
25
26
  applicable only to the person applying the lens). The <code>capture</code> output renders content suitable for sharing with
26
27
  other users (e.g. sent to the other members of a video call, or saved to disk for sharing later).</p>
27
28
  <p>For many lenses, these outputs are identical – but each lens is free to render differently, based on its own
28
29
  use-case.</p>
29
- </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">live</span><span class="tsd-signature-symbol">: </span><a href="https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement" class="tsd-signature-type external" target="_blank">HTMLCanvasElement</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">capture</span><span class="tsd-signature-symbol">: </span><a href="https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement" class="tsd-signature-type external" target="_blank">HTMLCanvasElement</a></h5></li></ul></div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="playing" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>playing</span><a href="#playing" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">playing</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">live</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">capture</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Indicates whether or not the session is currently rendering. If <code>false</code>, rendering is stopped. Otherwise the
30
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="playing" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>playing</span><a href="#playing" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">playing</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">live</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">capture</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Indicates whether or not the session is currently rendering. If <code>false</code>, rendering is stopped. Otherwise the
30
31
  value indicates which output is being rendered.</p>
31
- </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">live</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">capture</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li></ul></div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="events" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>events</span><a href="#events" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">events</span><span class="tsd-signature-symbol">:</span> <a href="TypedEventTarget.html" class="tsd-signature-type tsd-kind-class">TypedEventTarget</a><span class="tsd-signature-symbol">&lt;</span><a href="../types/CameraKitSessionEvents.html" class="tsd-signature-type tsd-kind-type-alias">CameraKitSessionEvents</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-comment tsd-typography"><p>Add event listeners here to handle events which occur during the CameraKitSession.</p>
32
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="events" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>events</span><a href="#events" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">events</span><span class="tsd-signature-symbol">:</span> <a href="TypedEventTarget.html" class="tsd-signature-type tsd-kind-class">TypedEventTarget</a><span class="tsd-signature-symbol">&lt;</span><a href="../types/CameraKitSessionEvents.html" class="tsd-signature-type tsd-kind-type-alias">CameraKitSessionEvents</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-comment tsd-typography"><p>Add event listeners here to handle events which occur during the CameraKitSession.</p>
32
33
  <p><strong>Note:</strong> Applications may want to handle the <code>error</code> event, and check the contained error type -- if the type
33
34
  is <a href="../types/LensExecutionError.html" class="tsd-kind-type-alias">LensExecutionError</a>, this means the current lens was unable to render and CameraKit will automatically
34
35
  remove the lens.</p>
35
- </div><div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-0">cameraKitSession</span><span class="hl-1">.</span><span class="hl-0">events</span><span class="hl-1">.</span><span class="hl-5">addEventListener</span><span class="hl-1">(</span><span class="hl-3">&#39;error&#39;</span><span class="hl-1">, ({ </span><span class="hl-0">detail</span><span class="hl-1"> }) </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">if</span><span class="hl-1"> (</span><span class="hl-0">detail</span><span class="hl-1">.</span><span class="hl-0">error</span><span class="hl-1">.</span><span class="hl-0">name</span><span class="hl-1"> === </span><span class="hl-3">&#39;LensExecutionError&#39;</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-3">`Lens </span><span class="hl-4">${</span><span class="hl-0">detail</span><span class="hl-9">.</span><span class="hl-0">lens</span><span class="hl-9">.</span><span class="hl-0">name</span><span class="hl-4">}</span><span class="hl-3"> encountered an error and was removed. Please pick a different lens.`</span><span class="hl-1">)</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">})</span>
36
- </code><button>Copy</button></pre>
37
- </div></section><section class="tsd-panel tsd-member"><a id="metrics" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>metrics</span><a href="#metrics" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">metrics</span><span class="tsd-signature-symbol">:</span> <a href="LensPerformanceMetrics.html" class="tsd-signature-type tsd-kind-class">LensPerformanceMetrics</a></div><div class="tsd-comment tsd-typography"><p>Use this to measure current lens performance.</p>
38
- </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="keyboard" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>keyboard</span><a href="#keyboard" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">keyboard</span><span class="tsd-signature-symbol">:</span> <a href="../types/Keyboard.html" class="tsd-signature-type tsd-kind-type-alias">Keyboard</a></div><div class="tsd-comment tsd-typography"><p>Use this to interact with lenses which require text input.</p>
39
- </div><div class="tsd-comment tsd-typography"></div></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="applyLens" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>apply<wbr/>Lens</span><a href="#applyLens" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="applyLens.applyLens-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">apply<wbr/>Lens</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">lens</span>, <span class="tsd-kind-parameter">launchData</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><a href="#applyLens.applyLens-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Apply a Lens to this session.</p>
36
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example-1" class="tsd-anchor"></a>Example<a href="#example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-0">cameraKitSession</span><span class="hl-1">.</span><span class="hl-0">events</span><span class="hl-1">.</span><span class="hl-5">addEventListener</span><span class="hl-1">(</span><span class="hl-3">&#39;error&#39;</span><span class="hl-1">, ({ </span><span class="hl-0">detail</span><span class="hl-1"> }) </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">if</span><span class="hl-1"> (</span><span class="hl-0">detail</span><span class="hl-1">.</span><span class="hl-0">error</span><span class="hl-1">.</span><span class="hl-0">name</span><span class="hl-1"> === </span><span class="hl-3">&#39;LensExecutionError&#39;</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-3">`Lens </span><span class="hl-4">${</span><span class="hl-0">detail</span><span class="hl-9">.</span><span class="hl-0">lens</span><span class="hl-9">.</span><span class="hl-0">name</span><span class="hl-4">}</span><span class="hl-3"> encountered an error and was removed. Please pick a different lens.`</span><span class="hl-1">)</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">})</span>
37
+ </code><button type="button">Copy</button></pre>
38
+
39
+ </div></div></section><section class="tsd-panel tsd-member"><a id="metrics" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>metrics</span><a href="#metrics" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">metrics</span><span class="tsd-signature-symbol">:</span> <a href="LensPerformanceMetrics.html" class="tsd-signature-type tsd-kind-class">LensPerformanceMetrics</a></div><div class="tsd-comment tsd-typography"><p>Use this to measure current lens performance.</p>
40
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="keyboard" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>keyboard</span><a href="#keyboard" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">keyboard</span><span class="tsd-signature-symbol">:</span> <a href="../types/Keyboard.html" class="tsd-signature-type tsd-kind-type-alias">Keyboard</a></div><div class="tsd-comment tsd-typography"><p>Use this to interact with lenses which require text input.</p>
41
+ </div><div class="tsd-comment tsd-typography"></div></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="applylens" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>apply<wbr/>Lens</span><a href="#applylens" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="applylens-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">applyLens</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">lens</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Lens.html" class="tsd-signature-type tsd-kind-interface">Lens</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">launchData</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/LensLaunchData.html" class="tsd-signature-type tsd-kind-interface">LensLaunchData</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><a href="#applylens-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Apply a Lens to this session.</p>
40
42
  <p>This method will download (and cache) the Lens executable, and then use that Lens for rendering. If the session
41
43
  is currently playing, this will immediately update the rendered output. Otherwise, the new Lens will be used
42
44
  when session playback in resumed.</p>
@@ -45,10 +47,11 @@ when session playback in resumed.</p>
45
47
  Camera Kit will automatically remove the Lens from the session and emit a <a href="../types/LensExecutionError.html" class="tsd-kind-type-alias">LensExecutionError</a> event.
46
48
  Applications may want to listen for this error and, for example,
47
49
  prevent the Lens from being selected again by the user.</p>
48
- <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">&quot;error&quot;</span><span class="hl-1">, ({ </span><span class="hl-0">detail</span><span class="hl-1"> }) </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">if</span><span class="hl-1"> (</span><span class="hl-0">detail</span><span class="hl-1">.</span><span class="hl-0">error</span><span class="hl-1">.</span><span class="hl-0">name</span><span class="hl-1"> === </span><span class="hl-3">&quot;LensExecutionError&quot;</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-5">preventFutureLensSelection</span><span class="hl-1">(</span><span class="hl-0">detail</span><span class="hl-1">.</span><span class="hl-0">lens</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-5">showMessage</span><span class="hl-1">(</span><span class="hl-3">&quot;We&#39;re sorry, but the Lens you selected encountered an error. Please choose a different Lens.&quot;</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">});</span>
49
- </code><button>Copy</button></pre>
50
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">lens</span>: <a href="../interfaces/Lens.html" class="tsd-signature-type tsd-kind-interface">Lens</a></h5><div class="tsd-comment tsd-typography"><p>The Lens to apply to this session.</p>
51
- </div><div class="tsd-comment tsd-typography"></div></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">launchData</span>: <a href="../interfaces/LensLaunchData.html" class="tsd-signature-type tsd-kind-interface">LensLaunchData</a></h5><div class="tsd-comment tsd-typography"><p>This can optionally be provided to pass some initial data to the Lens – only certain Lenses
50
+ <pre><code class="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">&quot;error&quot;</span><span class="hl-1">, ({ </span><span class="hl-0">detail</span><span class="hl-1"> }) </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">if</span><span class="hl-1"> (</span><span class="hl-0">detail</span><span class="hl-1">.</span><span class="hl-0">error</span><span class="hl-1">.</span><span class="hl-0">name</span><span class="hl-1"> === </span><span class="hl-3">&quot;LensExecutionError&quot;</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-5">preventFutureLensSelection</span><span class="hl-1">(</span><span class="hl-0">detail</span><span class="hl-1">.</span><span class="hl-0">lens</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-5">showMessage</span><span class="hl-1">(</span><span class="hl-3">&quot;We&#39;re sorry, but the Lens you selected encountered an error. Please choose a different Lens.&quot;</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">});</span>
51
+ </code><button type="button">Copy</button></pre>
52
+
53
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">lens</span>: <a href="../interfaces/Lens.html" class="tsd-signature-type tsd-kind-interface">Lens</a></span><div class="tsd-comment tsd-typography"><p>The Lens to apply to this session.</p>
54
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">launchData</span>: <a href="../interfaces/LensLaunchData.html" class="tsd-signature-type tsd-kind-interface">LensLaunchData</a></span><div class="tsd-comment tsd-typography"><p>This can optionally be provided to pass some initial data to the Lens – only certain Lenses
52
55
  expect launch data.</p>
53
56
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A promise which can have the following results:</p>
54
57
  <ol>
@@ -63,34 +66,35 @@ method)</li>
63
66
  <li>Lens content download fails, or the download of any required lens assets fails.</li>
64
67
  <li>An internal failure occurs in the Lens rendering engine when attempting to apply the Lens.</li>
65
68
  </ul>
66
- <div class="tsd-comment tsd-typography"></div></li></ul></section><section class="tsd-panel tsd-member"><a id="removeLens" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>remove<wbr/>Lens</span><a href="#removeLens" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="removeLens.removeLens-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">remove<wbr/>Lens</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><a href="#removeLens.removeLens-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Remove a Lens from this session.</p>
69
+ <div class="tsd-comment tsd-typography"></div></li></ul></section><section class="tsd-panel tsd-member"><a id="removelens" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>remove<wbr/>Lens</span><a href="#removelens" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="removelens-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">removeLens</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><a href="#removelens-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Remove a Lens from this session.</p>
67
70
  <p>When a Lens is removed, rendering continues if the session is playing. It will just render the session input
68
71
  directly to the outputs without any image processing.</p>
69
72
  </div><h4 class="tsd-returns-title">Returns <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A promise which can have the following results:</p>
70
73
  <ol>
71
- <li>Resolved with <code>true</code>: the session&#39;s rendered output has no lens applied.</li>
74
+ <li>Resolved with <code>true</code>: the session's rendered output has no lens applied.</li>
72
75
  <li>Resolved with <code>false</code>: the current lens has been removed, but a subsequent call to <code>applyLens</code> means that the
73
- session&#39;s rendered output will still have a (new) lens applied.</li>
76
+ session's rendered output will still have a (new) lens applied.</li>
74
77
  <li>Rejected: the lens has failed to be removed. This can happen if an internal failure occurs in the Lens
75
78
  rendering engine when attempting to remove the lens.</li>
76
79
  </ol>
77
- <div class="tsd-comment tsd-typography"></div></li></ul></section><section class="tsd-panel tsd-member"><a id="play" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>play</span><a href="#play" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="play.play-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">play</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#play.play-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Start/resume session playback – LensCore will begin rendering frames to the output.</p>
80
+ <div class="tsd-comment tsd-typography"></div></li></ul></section><section class="tsd-panel tsd-member"><a id="play" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>play</span><a href="#play" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="play-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">play</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">?:</span> <a href="../types/RenderTarget.html" class="tsd-signature-type tsd-kind-type-alias">RenderTarget</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#play-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Start/resume session playback – LensCore will begin rendering frames to the output.</p>
78
81
  <p>If no source has been set for the session, calling <code>play()</code> will update the playing state, but no actual image
79
82
  processing will occur until <code>setSource()</code> is called.</p>
80
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">target</span>: <a href="../types/RenderTarget.html" class="tsd-signature-type tsd-kind-type-alias">RenderTarget</a><span class="tsd-signature-symbol"> = &quot;live&quot;</span></h5><div class="tsd-comment tsd-typography"><p>Specify the <a href="../types/RenderTarget.html" class="tsd-kind-type-alias">RenderTarget</a> to render. Defaults to the <code>live</code> RenderTarget.</p>
83
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">target</span>: <a href="../types/RenderTarget.html" class="tsd-signature-type tsd-kind-type-alias">RenderTarget</a><span class="tsd-signature-symbol"> = &quot;live&quot;</span></span><div class="tsd-comment tsd-typography"><p>Specify the <a href="../types/RenderTarget.html" class="tsd-kind-type-alias">RenderTarget</a> to render. Defaults to the <code>live</code> RenderTarget.</p>
81
84
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>Promise resolves when playback state has been updated. If no source has been set, this means <code>play</code> will
82
85
  resolve before any frames are processed -- but once a source is set, frames will immediately begin processing.</p>
83
- <div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">cameraKitSession</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">cameraKit</span><span class="hl-1">.</span><span class="hl-5">createSession</span><span class="hl-1">()</span><br/><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">cameraKitSession</span><span class="hl-1">.</span><span class="hl-5">setSource</span><span class="hl-1">(</span><span class="hl-0">mySource</span><span class="hl-1">)</span><br/><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">cameraKitSession</span><span class="hl-1">.</span><span class="hl-5">play</span><span class="hl-1">()</span><br/><br/><span class="hl-7">// If you call `play` before `setSource`, the call to `play` will resolve but playback will only begin once a</span><br/><span class="hl-7">// media source has been set.</span>
84
- </code><button>Copy</button></pre>
85
- </div></li></ul></section><section class="tsd-panel tsd-member"><a id="pause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>pause</span><a href="#pause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="pause.pause-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">pause</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#pause.pause-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Pause session playback – LensCore will stop rendering frames to the output.</p>
86
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">target</span>: <a href="../types/RenderTarget.html" class="tsd-signature-type tsd-kind-type-alias">RenderTarget</a><span class="tsd-signature-symbol"> = &quot;live&quot;</span></h5><div class="tsd-comment tsd-typography"><p>Specify the RenderTarget to pause playback. May be either <code>&#39;live&#39;</code> or <code>&#39;capture&#39;</code>.
87
- Default is <code>&#39;live&#39;</code>.</p>
86
+ <div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example-2" class="tsd-anchor"></a>Example<a href="#example-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">cameraKitSession</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">cameraKit</span><span class="hl-1">.</span><span class="hl-5">createSession</span><span class="hl-1">()</span><br/><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">cameraKitSession</span><span class="hl-1">.</span><span class="hl-5">setSource</span><span class="hl-1">(</span><span class="hl-0">mySource</span><span class="hl-1">)</span><br/><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">cameraKitSession</span><span class="hl-1">.</span><span class="hl-5">play</span><span class="hl-1">()</span><br/><br/><span class="hl-7">// If you call `play` before `setSource`, the call to `play` will resolve but playback will only begin once a</span><br/><span class="hl-7">// media source has been set.</span>
87
+ </code><button type="button">Copy</button></pre>
88
+
89
+ </div></div></li></ul></section><section class="tsd-panel tsd-member"><a id="pause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>pause</span><a href="#pause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="pause-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">pause</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">?:</span> <a href="../types/RenderTarget.html" class="tsd-signature-type tsd-kind-type-alias">RenderTarget</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#pause-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Pause session playback – LensCore will stop rendering frames to the output.</p>
90
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">target</span>: <a href="../types/RenderTarget.html" class="tsd-signature-type tsd-kind-type-alias">RenderTarget</a><span class="tsd-signature-symbol"> = &quot;live&quot;</span></span><div class="tsd-comment tsd-typography"><p>Specify the RenderTarget to pause playback. May be either <code>'live'</code> or <code>'capture'</code>.
91
+ Default is <code>'live'</code>.</p>
88
92
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>Promise resolves when playback has stopped.</p>
89
- <div class="tsd-comment tsd-typography"></div></li></ul></section><section class="tsd-panel tsd-member"><a id="mute" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>mute</span><a href="#mute" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="mute.mute-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">mute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fade</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#mute.mute-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Mute all sounds (default SDK state is unmuted).</p>
90
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">fade</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5><div class="tsd-comment tsd-typography"><p>Do we want audio to fade out?</p>
91
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></section><section class="tsd-panel tsd-member"><a id="unmute" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>unmute</span><a href="#unmute" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="unmute.unmute-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">unmute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fade</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#unmute.unmute-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Unmute all sounds.</p>
92
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">fade</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5><div class="tsd-comment tsd-typography"><p>Do we want audio to fade in?</p>
93
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></section><section class="tsd-panel tsd-member"><a id="setSource" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Source</span><a href="#setSource" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setSource.setSource-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Source</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">source</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><a href="CameraKitSource.html" class="tsd-signature-type tsd-kind-class">CameraKitSource</a><span class="tsd-signature-symbol">&gt;</span><a href="#setSource.setSource-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Set the media source for this session.</p>
93
+ <div class="tsd-comment tsd-typography"></div></li></ul></section><section class="tsd-panel tsd-member"><a id="mute" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>mute</span><a href="#mute" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="mute-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">mute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fade</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#mute-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Mute all sounds (default SDK state is unmuted).</p>
94
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">fade</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>Do we want audio to fade out?</p>
95
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></section><section class="tsd-panel tsd-member"><a id="unmute" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>unmute</span><a href="#unmute" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="unmute-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">unmute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fade</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#unmute-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Unmute all sounds.</p>
96
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">fade</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>Do we want audio to fade in?</p>
97
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></section><section class="tsd-panel tsd-member"><a id="setsource" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Source</span><a href="#setsource" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setsource-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setSource</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">source</span><span class="tsd-signature-symbol">:</span> <a href="CameraKitSource.html" class="tsd-signature-type tsd-kind-class">CameraKitSource</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><a href="CameraKitSource.html" class="tsd-signature-type tsd-kind-class">CameraKitSource</a><span class="tsd-signature-symbol">&gt;</span><a href="#setsource-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Set the media source for this session.</p>
94
98
  <p>Sessions may only have one source at a time - if <code>setSource</code> is called multiple times, subsequent calls replace
95
99
  the prior source. Setting the source does not trigger rendering (that’s done by <code>session.play()</code>). If the session
96
100
  is already playing, setting the source will immediately begin rendering the new source.</p>
@@ -102,23 +106,44 @@ following functions:</p>
102
106
  <li><a href="../functions/createImageSource.html" class="tsd-kind-function">createImageSource</a></li>
103
107
  </ul>
104
108
  <p><strong>Important:</strong> Once a source has been set for a session, it cannot be set again, even if it has been replaced
105
- by another one. You must provide a new instance of <a href="CameraKitSource.html" class="tsd-kind-class">CameraKitSource</a> to <a href="CameraKitSession.html#setSource" class="tsd-kind-method">CameraKitSession.setSource</a>.
109
+ by another one. You must provide a new instance of <a href="CameraKitSource.html" class="tsd-kind-class">CameraKitSource</a> to <a href="CameraKitSession.html#setsource" class="tsd-kind-method">CameraKitSession.setSource</a>.
106
110
  If you want to reuse the existing source, you can use its <a href="CameraKitSource.html#copy" class="tsd-kind-method">CameraKitSource.copy</a> method to create a new
107
111
  instance.</p>
108
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">source</span>: <a href="CameraKitSource.html" class="tsd-signature-type tsd-kind-class">CameraKitSource</a></h5><div class="tsd-comment tsd-typography"><p>A CameraKitSource object representing input media (e.g. a webcam stream, video, or some other
112
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">source</span>: <a href="CameraKitSource.html" class="tsd-signature-type tsd-kind-class">CameraKitSource</a></span><div class="tsd-comment tsd-typography"><p>A CameraKitSource object representing input media (e.g. a webcam stream, video, or some other
109
113
  source of image data), which CameraKit will supply to Lenses in order for them to render effects on top of that
110
114
  source.</p>
111
115
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><a href="CameraKitSource.html" class="tsd-signature-type tsd-kind-class">CameraKitSource</a><span class="tsd-signature-symbol">&gt;</span></h4><p>Promise is resolved when the source has successfully been set. If the session was already in the playing
112
116
  state, the Promise resolves when the first frame from the new source has been rendered. The resolved value is
113
117
  the <a href="CameraKitSource.html" class="tsd-kind-class">CameraKitSource</a> object attached to the session.</p>
114
- <div class="tsd-comment tsd-typography"></div></li><li class="tsd-signature tsd-anchor-link"><a id="setSource.setSource-2" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Source</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">source</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><a href="CameraKitSource.html" class="tsd-signature-type tsd-kind-class">CameraKitSource</a><span class="tsd-signature-symbol">&gt;</span><a href="#setSource.setSource-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">source</span>: <a href="https://developer.mozilla.org/docs/Web/API/HTMLVideoElement" class="tsd-signature-type external" target="_blank">HTMLVideoElement</a><span class="tsd-signature-symbol"> | </span><a href="https://developer.mozilla.org/docs/Web/API/MediaStream" class="tsd-signature-type external" target="_blank">MediaStream</a></h5></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype" class="tsd-signature-type external" target="_blank">Partial</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/CameraKitDeviceOptions.html" class="tsd-signature-type tsd-kind-interface">CameraKitDeviceOptions</a><span class="tsd-signature-symbol">&gt;</span></h5></li></ul></div><h4 class="tsd-returns-title">Returns <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><a href="CameraKitSource.html" class="tsd-signature-type tsd-kind-class">CameraKitSource</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member"><a id="setFPSLimit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>setFPSLimit</span><a href="#setFPSLimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setFPSLimit.setFPSLimit-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setFPSLimit</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fpsLimit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#setFPSLimit.setFPSLimit-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Set an FPS limit.</p>
118
+ <div class="tsd-comment tsd-typography"></div></li><li class="tsd-signature tsd-anchor-link"><a id="setsource-2" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setSource</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">source</span><span class="tsd-signature-symbol">:</span> <a href="https://developer.mozilla.org/docs/Web/API/HTMLVideoElement" class="tsd-signature-type external" target="_blank">HTMLVideoElement</a> <span class="tsd-signature-symbol">|</span> <a href="https://developer.mozilla.org/docs/Web/API/MediaStream" class="tsd-signature-type external" target="_blank">MediaStream</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype" class="tsd-signature-type external" target="_blank">Partial</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/CameraKitDeviceOptions.html" class="tsd-signature-type tsd-kind-interface">CameraKitDeviceOptions</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><a href="CameraKitSource.html" class="tsd-signature-type tsd-kind-class">CameraKitSource</a><span class="tsd-signature-symbol">&gt;</span><a href="#setsource-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Set the media source for this session.</p>
119
+ <p>Sessions may only have one source at a time - if <code>setSource</code> is called multiple times, subsequent calls replace
120
+ the prior source. Setting the source does not trigger rendering (that’s done by <code>session.play()</code>). If the session
121
+ is already playing, setting the source will immediately begin rendering the new source.</p>
122
+ <p>The CameraKit SDK provides implementations for various common sources, which applications can create using the
123
+ following functions:</p>
124
+ <ul>
125
+ <li><a href="../functions/createMediaStreamSource.html" class="tsd-kind-function">createMediaStreamSource</a></li>
126
+ <li><a href="../functions/createVideoSource.html" class="tsd-kind-function">createVideoSource</a></li>
127
+ <li><a href="../functions/createImageSource.html" class="tsd-kind-function">createImageSource</a></li>
128
+ </ul>
129
+ <p><strong>Important:</strong> Once a source has been set for a session, it cannot be set again, even if it has been replaced
130
+ by another one. You must provide a new instance of <a href="CameraKitSource.html" class="tsd-kind-class">CameraKitSource</a> to <a href="CameraKitSession.html#setsource" class="tsd-kind-method">CameraKitSession.setSource</a>.
131
+ If you want to reuse the existing source, you can use its <a href="CameraKitSource.html#copy" class="tsd-kind-method">CameraKitSource.copy</a> method to create a new
132
+ instance.</p>
133
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">source</span>: <a href="https://developer.mozilla.org/docs/Web/API/HTMLVideoElement" class="tsd-signature-type external" target="_blank">HTMLVideoElement</a> <span class="tsd-signature-symbol">|</span> <a href="https://developer.mozilla.org/docs/Web/API/MediaStream" class="tsd-signature-type external" target="_blank">MediaStream</a></span><div class="tsd-comment tsd-typography"><p>A CameraKitSource object representing input media (e.g. a webcam stream, video, or some other
134
+ source of image data), which CameraKit will supply to Lenses in order for them to render effects on top of that
135
+ source.</p>
136
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype" class="tsd-signature-type external" target="_blank">Partial</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/CameraKitDeviceOptions.html" class="tsd-signature-type tsd-kind-interface">CameraKitDeviceOptions</a><span class="tsd-signature-symbol">&gt;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><a href="CameraKitSource.html" class="tsd-signature-type tsd-kind-class">CameraKitSource</a><span class="tsd-signature-symbol">&gt;</span></h4><p>Promise is resolved when the source has successfully been set. If the session was already in the playing
137
+ state, the Promise resolves when the first frame from the new source has been rendered. The resolved value is
138
+ the <a href="CameraKitSource.html" class="tsd-kind-class">CameraKitSource</a> object attached to the session.</p>
139
+ <div class="tsd-comment tsd-typography"></div></li></ul></section><section class="tsd-panel tsd-member"><a id="setfpslimit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>setFPSLimit</span><a href="#setfpslimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setfpslimit-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setFPSLimit</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fpsLimit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#setfpslimit-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Set an FPS limit.</p>
115
140
  <p>This may be useful to reduce CPU/GPU resource usage by CameraKit if, for example, the input
116
141
  media source has a low FPS – CameraKit would then not try to render more frequently than the source produces
117
142
  new frames.</p>
118
143
  <p>This may also be useful to gracefully degrade performance in situations where lowering FPS is preferable over
119
144
  alternatives.</p>
120
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">fpsLimit</span>: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>A maximum FPS, rendering will not exceed this limit</p>
145
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">fpsLimit</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>A maximum FPS, rendering will not exceed this limit</p>
121
146
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>Promise is resolved when the limit is successfully set.</p>
122
- <div class="tsd-comment tsd-typography"></div></li></ul></section><section class="tsd-panel tsd-member"><a id="destroy" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>destroy</span><a href="#destroy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="destroy.destroy-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">destroy</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#destroy.destroy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Destroy the session.</p>
147
+ <div class="tsd-comment tsd-typography"></div></li></ul></section><section class="tsd-panel tsd-member"><a id="destroy" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>destroy</span><a href="#destroy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="destroy-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">destroy</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#destroy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Destroy the session.</p>
123
148
  <p>The session will become inoperable. Frame processing stops, and any session-scoped graphical resources are freed.</p>
124
- </div><h4 class="tsd-returns-title">Returns <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></form></div><div class="tsd-theme-toggle"><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><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><ul><li><a href="#output" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>output</span></a></li><li><a href="#playing" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>playing</span></a></li><li><a href="#events" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>events</span></a></li><li><a href="#metrics" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>metrics</span></a></li><li><a href="#keyboard" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>keyboard</span></a></li><li><a href="#applyLens" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>apply<wbr/>Lens</span></a></li><li><a href="#removeLens" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>remove<wbr/>Lens</span></a></li><li><a href="#play" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>play</span></a></li><li><a href="#pause" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>pause</span></a></li><li><a href="#mute" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>mute</span></a></li><li><a href="#unmute" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>unmute</span></a></li><li><a href="#setSource" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Source</span></a></li><li><a href="#setFPSLimit" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>setFPSLimit</span></a></li><li><a href="#destroy" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>destroy</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>CameraKit Web SDK - v1.0.1</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li><a href="../enums/Lens_CameraFacing.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg>Lens_CameraFacing</a></li><li><a href="CameraKit.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>CameraKit</a></li><li><a href="TypedCustomEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>TypedCustomEvent</a></li><li><a href="TypedEventTarget.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>TypedEventTarget</a></li><li><a href="LensRepository.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>LensRepository</a></li><li><a href="CameraKitSource.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>CameraKitSource</a></li><li><a href="CameraKitSession.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>CameraKitSession</a></li><li><a href="LensPerformanceMeasurement.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>LensPerformanceMeasurement</a></li><li><a href="LensPerformanceMetrics.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>LensPerformanceMetrics</a></li><li><a href="Transform2D.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>Transform2D</a></li><li><a href="../interfaces/CreateSessionOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>CreateSessionOptions</a></li><li><a href="../interfaces/EstimatedLensPerformance.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>EstimatedLensPerformance</a></li><li><a href="../interfaces/CameraKitBootstrapConfiguration.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>CameraKitBootstrapConfiguration</a></li><li><a href="../interfaces/RemoteApiRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>RemoteApiRequest</a></li><li><a href="../interfaces/RemoteApiResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>RemoteApiResponse</a></li><li><a href="../interfaces/RemoteApiService.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>RemoteApiService</a></li><li><a href="../interfaces/UriRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>UriRequest</a></li><li><a href="../interfaces/UriResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>UriResponse</a></li><li><a href="../interfaces/UriCancelRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>UriCancelRequest</a></li><li><a href="../interfaces/LensCreator.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>LensCreator</a></li><li><a href="../interfaces/Lens.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>Lens</a></li><li>Loading...</li></ul></nav></div></div></div><div class="tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><svg style="display: none"><g id="icon-1"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-module)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)"></path></g><g id="icon-2"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-module)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)"></path></g><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><g id="icon-8"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-enum)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.45 16V7.24H14.49V8.224H10.518V10.936H14.07V11.908H10.518V15.016H14.49V16H9.45Z" fill="var(--color-text)"></path></g><g id="icon-16"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g><g id="icon-32"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)"></path></g><g id="icon-64"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g><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><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><g id="icon-512"><rect fill="var(--color-icon-background)" stroke="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></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><g id="icon-1024"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g><g id="icon-2048"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)"></path></g><g id="icon-4096"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g><g id="icon-8192"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g><g id="icon-16384"><rect fill="var(--color-icon-background)" stroke="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></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><g id="icon-32768"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g><g id="icon-65536"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g><g id="icon-131072"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g><g id="icon-262144"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)"></path></g><g id="icon-524288"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)"></path></g><g id="icon-1048576"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)"></path></g><g id="icon-2097152"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g><g id="icon-4194304"><rect fill="var(--color-icon-background)" stroke="#FF4D82" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M10.354 17V8.24H13.066C13.586 8.24 14.042 8.348 14.434 8.564C14.826 8.772 15.13 9.064 15.346 9.44C15.562 9.816 15.67 10.256 15.67 10.76C15.67 11.352 15.514 11.86 15.202 12.284C14.898 12.708 14.482 13 13.954 13.16L15.79 17H14.518L12.838 13.28H11.434V17H10.354ZM11.434 12.308H13.066C13.514 12.308 13.874 12.168 14.146 11.888C14.418 11.6 14.554 11.224 14.554 10.76C14.554 10.288 14.418 9.912 14.146 9.632C13.874 9.352 13.514 9.212 13.066 9.212H11.434V12.308Z" fill="var(--color-text)"></path></g><g id="icon-chevronDown"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></g><g id="icon-chevronSmall"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></g><g id="icon-menu"><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></g><g id="icon-search"><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></g><g id="icon-anchor"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><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></g></svg></body></html>
149
+ </div><h4 class="tsd-returns-title">Returns <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#output" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>output</span></a><a href="#playing" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>playing</span></a><a href="#events" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>events</span></a><a href="#metrics" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>metrics</span></a><a href="#keyboard" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>keyboard</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#applylens" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>apply<wbr/>Lens</span></a><a href="#removelens" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Lens</span></a><a href="#play" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>play</span></a><a href="#pause" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pause</span></a><a href="#mute" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>mute</span></a><a href="#unmute" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>unmute</span></a><a href="#setsource" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Source</span></a><a href="#setfpslimit" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>setFPSLimit</span></a><a href="#destroy" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>destroy</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">CameraKit Web SDK - v1.1.0</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>