@snap/camera-kit 1.0.1 → 1.2.0

package/docs/md/interfaces/CameraKitBootstrapConfiguration.md

@@ -1,36 +1,28 @@
-[CameraKit Web SDK - v1.0.1](../README.md) / [Exports](../modules.md) / CameraKitBootstrapConfiguration
+[**CameraKit Web SDK v1.2.0**](../README.md)
 
-# Interface: CameraKitBootstrapConfiguration
-
-Configuration which must be provided when calling [bootstrapCameraKit](../modules.md#bootstrapcamerakit). These values are used to create various
-CameraKit components.
+***
 
-## Table of contents
+[CameraKit Web SDK](../globals.md) / CameraKitBootstrapConfiguration
 
-### Properties
+# Interface: CameraKitBootstrapConfiguration
 
-- [apiToken](CameraKitBootstrapConfiguration.md#apitoken)
-- [logger](CameraKitBootstrapConfiguration.md#logger)
-- [logLevel](CameraKitBootstrapConfiguration.md#loglevel)
-- [lensPerformance](CameraKitBootstrapConfiguration.md#lensperformance)
-- [lensCoreOverrideUrls](CameraKitBootstrapConfiguration.md#lenscoreoverrideurls)
-- [wasmEndpointOverride](CameraKitBootstrapConfiguration.md#wasmendpointoverride)
-- [analyticsId](CameraKitBootstrapConfiguration.md#analyticsid)
+Configuration which must be provided when calling [bootstrapCameraKit](../functions/bootstrapCameraKit.md). These values are used to create various
+CameraKit components.
 
 ## Properties
 
 ### apiToken
 
-• **apiToken**: `string`
+> **apiToken**: `string`
 
 Long-lived token granting your application access to CameraKit APIs. This is found in the SnapKit Dev Portal,
 where it's called the API Token.
 
-___
+***
 
-### logger
+### logger?
 
-• `Optional` **logger**: ``"noop"`` \| ``"console"``
+> `optional` **logger**: `"noop"` \| `"console"`
 
 Determine where to print CameraKit log messages. By default no logs will be printed.
 
@@ -40,31 +32,31 @@ options:
  - `noop`: log messages are ignored.
  - `console`: log messages are printed to console.
 
-___
+***
 
-### logLevel
+### logLevel?
 
-• `Optional` **logLevel**: ``"error"`` \| ``"warn"`` \| ``"log"`` \| ``"info"`` \| ``"debug"``
+> `optional` **logLevel**: `"error"` \| `"warn"` \| `"log"` \| `"info"` \| `"debug"`
 
 Log only if a logged entry level is greater than or equal to this level. Here is the order of levels:
 error > warn > log = info > debug. Default value is "info".
 
-___
+***
 
-### lensPerformance
+### lensPerformance?
 
-• `Optional` **lensPerformance**: [`EstimatedLensPerformance`](EstimatedLensPerformance.md) \| `Promise`\<[`EstimatedLensPerformance`](EstimatedLensPerformance.md)\>
+> `optional` **lensPerformance**: [`EstimatedLensPerformance`](EstimatedLensPerformance.md) \| `Promise`\<[`EstimatedLensPerformance`](EstimatedLensPerformance.md)\>
 
 Some lenses may decide to modify their behavior based on the performance of the current environment. If you are
 using such lenses, providing an estimation of lens performance may lead to better user experience (especially on
 low-performance devices).
 
-Running the [estimateLensPerformance](../modules.md#estimatelensperformance) function will run benchmarks and estimate an appropriate lens
+Running the [estimateLensPerformance](../functions/estimateLensPerformance.md) function will run benchmarks and estimate an appropriate lens
 performance cluster (i.e. a performance rating) based on the current environment.
 
 Lower cluster = worse expected performance capability.
 
-**`Example`**
+#### Example
 
 ```ts
 import { bootstrapCameraKit, estimateLensPerformance } from '@snap/camera-kit`
@@ -75,11 +67,11 @@ const cameraKit = await bootstrapCameraKit({
 })
 ```
 
-___
+***
 
-### lensCoreOverrideUrls
+### lensCoreOverrideUrls?
 
-• `Optional` **lensCoreOverrideUrls**: `Object`
+> `optional` **lensCoreOverrideUrls**: `object`
 
 In recommended production deployments, the WebAssembly assets required by CameraKit will be downloaded from an
 optimized CDN. But sometimes (e.g. during development or within a CI pipeline), it may be necessary to download
@@ -88,30 +80,97 @@ these assets from somewhere else.
 This configuration option allows the application to specify URLs to be used for both the WebAssembly and JS glue
 file that are used to run and interact with CameraKit's rendering engine.
 
-#### Type declaration
+#### wasm
+
+> **wasm**: `string`
 
-| Name | Type |
-| :------ | :------ |
-| `wasm` | `string` |
-| `js` | `string` |
+#### js
 
-___
+> **js**: `string`
 
-### wasmEndpointOverride
+***
 
-• `Optional` **wasmEndpointOverride**: `string`
+### wasmEndpointOverride?
+
+> `optional` **wasmEndpointOverride**: `string`
 
 In recommended production deployments, the WebAssembly assets required by CameraKit will be downloaded from an
 optimized CDN. But sometimes during development or within a CI pipeline, it may be necessary to download these
 assets from somewhere else. With a provided `wasmEndpointOverride`, asset URLs will be automatically generated
 based on this root endpoint.
 
-___
+***
 
-### analyticsId
+### analyticsId?
 
-• `Optional` **analyticsId**: `string`
+> `optional` **analyticsId**: `string`
 
 Applications may optionally provide a unique identifier called analyticsId. This ID would enable Camera Kit to
 improve data reporting and accuracy and to better support potential needs related to an application's lens and
 user analytics.
+
+***
+
+### fonts?
+
+> `optional` **fonts**: [`Font`](Font.md)[]
+
+An array of fonts to be used by Camera Kit for text rendering.
+
+Lenses usually have their own font assets, but emojis are often not embedded.
+As a result, you may need to provide additional fonts (e.g., an emoji font) to ensure all glyphs render
+correctly.
+
+#### Example
+
+```ts
+fonts: [
+  {
+    name: 'EmojiFont',
+    data: emojiFontArrayBuffer, // Your emoji font data goes here
+  },
+]
+```
+
+***
+
+### lensHttpHandler?
+
+> `optional` **lensHttpHandler**: [`LensHttpHandler`](../type-aliases/LensHttpHandler.md)
+
+An optional custom HTTP handler for requests made by a Lens.
+
+This handler allows you to intercept and customize the behavior of HTTP requests,
+such as adding authentication headers, logging request details, or replacing the default
+HTTP library used by the Lens system.
+
+If not specified, the Lens system will use a default HTTP implementation.
+
+#### Example
+
+Here is an example of how to configure a custom `LensHttpHandler` to add an authentication token:
+
+```typescript
+const customLensHttpHandler: LensHttpHandler = async (url, init, lensRequest) => {
+  // Add an authentication token to the headers
+  const sessionToken = await getAuthToken();
+  const updatedInit = {
+    ...init,
+    headers: {
+      ...init.headers,
+      'Authorization': `Bearer ${sessionToken}`,
+    },
+  };
+
+  // Log the request details for debugging
+  console.log(`Requesting ${lensRequest.url} from lens: ${lensRequest.lens.name}`);
+
+  // Use fetch to perform the HTTP request
+  return fetch(url, updatedInit);
+};
+
+const cameraKit = bootstrapCameraKit({
+  apiToken,
+  lensHttpHandler: customLensHttpHandler,
+});
+```

package/docs/md/interfaces/CameraKitDeviceOptions.md

@@ -1,40 +1,34 @@
-[CameraKit Web SDK - v1.0.1](../README.md) / [Exports](../modules.md) / CameraKitDeviceOptions
+[**CameraKit Web SDK v1.2.0**](../README.md)
 
-# Interface: CameraKitDeviceOptions
-
-Device options.
-
-## Hierarchy
+***
 
-- **`CameraKitDeviceOptions`**
+[CameraKit Web SDK](../globals.md) / CameraKitDeviceOptions
 
-  ↳ [`MediaStreamSourceOptions`](MediaStreamSourceOptions.md)
-
-  ↳ [`VideoSourceOptions`](VideoSourceOptions.md)
+# Interface: CameraKitDeviceOptions
 
-## Table of contents
+Device options.
 
-### Properties
+## Extended by
 
-- [cameraType](CameraKitDeviceOptions.md#cameratype)
-- [fpsLimit](CameraKitDeviceOptions.md#fpslimit)
+- [`MediaStreamSourceOptions`](MediaStreamSourceOptions.md)
+- [`VideoSourceOptions`](VideoSourceOptions.md)
 
 ## Properties
 
 ### cameraType
 
-• **cameraType**: ``"user"`` \| ``"environment"``
+> **cameraType**: `"user"` \| `"environment"`
 
 Specifies the camera type for which certain features are enabled or disabled.
 For example, surface tracking features are only active when the camera is set to "environment" mode.
 The default value is "user", which accommodates the majority of Lenses.
 "user" refers to the front-facing camera, while "environment" refers to the rear-facing camera.
 
-___
+***
 
 ### fpsLimit
 
-• **fpsLimit**: `number`
+> **fpsLimit**: `number`
 
 Limits the frames per second (FPS) to optimize performance by reducing compute resources
 when high FPS is not critical. By default, no limit is set, allowing usage of the video's native FPS.

package/docs/md/interfaces/CameraKitSourceInfo.md

@@ -1,43 +1,37 @@
-[CameraKit Web SDK - v1.0.1](../README.md) / [Exports](../modules.md) / CameraKitSourceInfo
+[**CameraKit Web SDK v1.2.0**](../README.md)
 
-# Interface: CameraKitSourceInfo
-
-## Table of contents
+***
 
-### Properties
+[CameraKit Web SDK](../globals.md) / CameraKitSourceInfo
 
-- [media](CameraKitSourceInfo.md#media)
-- [useManualFrameProcessing](CameraKitSourceInfo.md#usemanualframeprocessing)
-- [replayTrackingData](CameraKitSourceInfo.md#replaytrackingdata)
+# Interface: CameraKitSourceInfo
 
 ## Properties
 
-### media
+### media?
 
-• `Optional` **media**: `HTMLImageElement` \| `HTMLCanvasElement` \| `HTMLVideoElement` \| `MediaStream`
+> `optional` **media**: `HTMLImageElement` \| `HTMLCanvasElement` \| `HTMLVideoElement` \| `MediaStream`
 
 HTML element or MediaStream as an input source.
 If useManualFrameProcessing is true, then this parameter is optional.
 
-___
+***
 
-### useManualFrameProcessing
+### useManualFrameProcessing?
 
-• `Optional` **useManualFrameProcessing**: `boolean`
+> `optional` **useManualFrameProcessing**: `boolean`
 
 Whether to provide frames manually.
 
-___
+***
 
-### replayTrackingData
+### replayTrackingData?
 
-• `Optional` **replayTrackingData**: `Object`
+> `optional` **replayTrackingData**: `object`
 
 If specified, the passed-in tracking data buffer will be used as tracking data for the current
 media element instead of live tracking data.
 
-#### Type declaration
+#### buffer
 
-| Name | Type |
-| :------ | :------ |
-| `buffer` | `ArrayBuffer` \| `Uint8Array` |
+> **buffer**: `ArrayBuffer` \| `Uint8Array`

package/docs/md/interfaces/CameraKitSourceSubscriber.md

@@ -1,55 +1,50 @@
-[CameraKit Web SDK - v1.0.1](../README.md) / [Exports](../modules.md) / CameraKitSourceSubscriber
+[**CameraKit Web SDK v1.2.0**](../README.md)
+
+***
+
+[CameraKit Web SDK](../globals.md) / CameraKitSourceSubscriber
 
 # Interface: CameraKitSourceSubscriber
 
 When creating a [CameraKitSource](../classes/CameraKitSource.md), passing a CameraKitSourceSubscriber allows logic to implemented which will
 run whenever that source is attached/detached from a CameraKitSession.
 
-## Table of contents
+## Properties
 
-### Properties
+### onAttach()?
 
-- [onAttach](CameraKitSourceSubscriber.md#onattach)
-- [onDetach](CameraKitSourceSubscriber.md#ondetach)
+> `readonly` `optional` **onAttach**: (`source`, `lensCore`, `reportError`) => `void` \| `Promise`\<`void`\>
 
-## Properties
+#### Parameters
 
-### onAttach
+##### source
 
-• `Optional` `Readonly` **onAttach**: (`source`: [`CameraKitSource`](../classes/CameraKitSource.md), `lensCore`: `LensCore`, `reportError`: (`error`: `Error`) => `void`) => `void` \| `Promise`\<`void`\>
+[`CameraKitSource`](../classes/CameraKitSource.md)
 
-#### Type declaration
+##### lensCore
 
-▸ (`source`, `lensCore`, `reportError`): `void` \| `Promise`\<`void`\>
+`LensCore`
 
-##### Parameters
+##### reportError
 
-| Name | Type |
-| :------ | :------ |
-| `source` | [`CameraKitSource`](../classes/CameraKitSource.md) |
-| `lensCore` | `LensCore` |
-| `reportError` | (`error`: `Error`) => `void` |
+(`error`) => `void`
 
-##### Returns
+#### Returns
 
 `void` \| `Promise`\<`void`\>
 
-___
-
-### onDetach
+***
 
-• `Optional` `Readonly` **onDetach**: (`reportError`: (`error`: `Error`) => `void`) => `void` \| `Promise`\<`void`\>
+### onDetach()?
 
-#### Type declaration
+> `readonly` `optional` **onDetach**: (`reportError`) => `void` \| `Promise`\<`void`\>
 
-▸ (`reportError`): `void` \| `Promise`\<`void`\>
+#### Parameters
 
-##### Parameters
+##### reportError
 
-| Name | Type |
-| :------ | :------ |
-| `reportError` | (`error`: `Error`) => `void` |
+(`error`) => `void`
 
-##### Returns
+#### Returns
 
 `void` \| `Promise`\<`void`\>

package/docs/md/interfaces/ComputedFrameMetrics.md

@@ -1,43 +1,37 @@
-[CameraKit Web SDK - v1.0.1](../README.md) / [Exports](../modules.md) / ComputedFrameMetrics
+[**CameraKit Web SDK v1.2.0**](../README.md)
 
-# Interface: ComputedFrameMetrics
-
-## Table of contents
+***
 
-### Properties
+[CameraKit Web SDK](../globals.md) / ComputedFrameMetrics
 
-- [avgFps](ComputedFrameMetrics.md#avgfps)
-- [lensFrameProcessingTimeMsAvg](ComputedFrameMetrics.md#lensframeprocessingtimemsavg)
-- [lensFrameProcessingTimeMsStd](ComputedFrameMetrics.md#lensframeprocessingtimemsstd)
-- [lensFrameProcessingTimeMsMedian](ComputedFrameMetrics.md#lensframeprocessingtimemsmedian)
-- [lensFrameProcessingN](ComputedFrameMetrics.md#lensframeprocessingn)
+# Interface: ComputedFrameMetrics
 
 ## Properties
 
 ### avgFps
 
-• **avgFps**: `number`
+> **avgFps**: `number`
 
-___
+***
 
 ### lensFrameProcessingTimeMsAvg
 
-• **lensFrameProcessingTimeMsAvg**: `number`
+> **lensFrameProcessingTimeMsAvg**: `number`
 
-___
+***
 
 ### lensFrameProcessingTimeMsStd
 
-• **lensFrameProcessingTimeMsStd**: `number`
+> **lensFrameProcessingTimeMsStd**: `number`
 
-___
+***
 
 ### lensFrameProcessingTimeMsMedian
 
-• **lensFrameProcessingTimeMsMedian**: `number`
+> **lensFrameProcessingTimeMsMedian**: `number`
 
-___
+***
 
 ### lensFrameProcessingN
 
-• **lensFrameProcessingN**: `number`
+> **lensFrameProcessingN**: `number`

package/docs/md/interfaces/CreateSessionOptions.md

@@ -1,31 +1,28 @@
-[CameraKit Web SDK - v1.0.1](../README.md) / [Exports](../modules.md) / CreateSessionOptions
+[**CameraKit Web SDK v1.2.0**](../README.md)
 
-# Interface: CreateSessionOptions
-
-Options available when creating a [CameraKitSession](../classes/CameraKitSession.md).
+***
 
-## Table of contents
+[CameraKit Web SDK](../globals.md) / CreateSessionOptions
 
-### Properties
+# Interface: CreateSessionOptions
 
-- [liveRenderTarget](CreateSessionOptions.md#liverendertarget)
-- [renderWhileTabHidden](CreateSessionOptions.md#renderwhiletabhidden)
+Options available when creating a [CameraKitSession](../classes/CameraKitSession.md).
 
 ## Properties
 
-### liveRenderTarget
+### liveRenderTarget?
 
-• `Optional` **liveRenderTarget**: `HTMLCanvasElement`
+> `optional` **liveRenderTarget**: `HTMLCanvasElement`
 
 Optionally provide an existing canvas element, on which the Live RenderTarget will be rendered.
 
 If this is not provided, CameraKit will create a new canvas element which can be added to the DOM.
 
-___
+***
 
-### renderWhileTabHidden
+### renderWhileTabHidden?
 
-• `Optional` **renderWhileTabHidden**: `boolean`
+> `optional` **renderWhileTabHidden**: `boolean`
 
 Browsers optimize tabs when they are hidden - for example, by pausing the execution of requestAnimationFrame
 callbacks.

package/docs/md/interfaces/EstimatedLensPerformance.md

@@ -1,4 +1,8 @@
-[CameraKit Web SDK - v1.0.1](../README.md) / [Exports](../modules.md) / EstimatedLensPerformance
+[**CameraKit Web SDK v1.2.0**](../README.md)
+
+***
+
+[CameraKit Web SDK](../globals.md) / EstimatedLensPerformance
 
 # Interface: EstimatedLensPerformance
 
@@ -11,28 +15,20 @@ performing cluster and 1 the lowest.
 
 All the raw benchmark results used to estimate the performance cluster are also included for reporting purposes.
 
-## Table of contents
-
-### Properties
-
-- [cluster](EstimatedLensPerformance.md#cluster)
-- [benchmarks](EstimatedLensPerformance.md#benchmarks)
-- [webglRendererInfo](EstimatedLensPerformance.md#webglrendererinfo)
-
 ## Properties
 
 ### cluster
 
-• **cluster**: [`LensPerformanceCluster`](../modules.md#lensperformancecluster)
+> **cluster**: [`LensPerformanceCluster`](../type-aliases/LensPerformanceCluster.md)
 
-___
+***
 
 ### benchmarks
 
-• **benchmarks**: `BenchmarkResult`[]
+> **benchmarks**: `BenchmarkResult`[]
 
-___
+***
 
 ### webglRendererInfo
 
-• **webglRendererInfo**: `string`
+> **webglRendererInfo**: `string`

package/docs/md/interfaces/Font.md

@@ -0,0 +1,25 @@
+[**CameraKit Web SDK v1.2.0**](../README.md)
+
+***
+
+[CameraKit Web SDK](../globals.md) / Font
+
+# Interface: Font
+
+Represents a font to be used by Camera Kit for text rendering.
+
+## Properties
+
+### name
+
+> **name**: `string`
+
+A unique name for the font.
+
+***
+
+### data
+
+> **data**: `ArrayBuffer`
+
+A buffer containing the font data (e.g., the contents of a `.ttf` file).

package/docs/md/interfaces/FriendUserInfo.md

@@ -1,29 +1,25 @@
-[CameraKit Web SDK - v1.0.1](../README.md) / [Exports](../modules.md) / FriendUserInfo
+[**CameraKit Web SDK v1.2.0**](../README.md)
 
-# Interface: FriendUserInfo
-
-## Table of contents
+***
 
-### Properties
+[CameraKit Web SDK](../globals.md) / FriendUserInfo
 
-- [friendshipStart](FriendUserInfo.md#friendshipstart)
-- [lastInteraction](FriendUserInfo.md#lastinteraction)
-- [streak](FriendUserInfo.md#streak)
+# Interface: FriendUserInfo
 
 ## Properties
 
-### friendshipStart
+### friendshipStart?
 
-• `Optional` **friendshipStart**: `Date`
+> `optional` **friendshipStart**: `Date`
 
-___
+***
 
-### lastInteraction
+### lastInteraction?
 
-• `Optional` **lastInteraction**: `Date`
+> `optional` **lastInteraction**: `Date`
 
-___
+***
 
-### streak
+### streak?
 
-• `Optional` **streak**: `number`
+> `optional` **streak**: `number`

package/docs/md/interfaces/FunctionSourceOptions.md

@@ -1,20 +1,18 @@
-[CameraKit Web SDK - v1.0.1](../README.md) / [Exports](../modules.md) / FunctionSourceOptions
+[**CameraKit Web SDK v1.2.0**](../README.md)
 
-# Interface: FunctionSourceOptions
-
-Function source options.
+***
 
-## Table of contents
+[CameraKit Web SDK](../globals.md) / FunctionSourceOptions
 
-### Properties
+# Interface: FunctionSourceOptions
 
-- [cameraType](FunctionSourceOptions.md#cameratype)
+Function source options.
 
 ## Properties
 
 ### cameraType
 
-• **cameraType**: ``"user"`` \| ``"environment"``
+> **cameraType**: `"user"` \| `"environment"`
 
 Specifies the camera type for which certain features are enabled or disabled.
 For example, surface tracking features are only active when the camera is set to "environment" mode.