@snap/camera-kit 0.7.0

package/docs/md/classes/LensRepository.md

@@ -0,0 +1,145 @@
+[CameraKit Web SDK - v0.7.0-alpha.1](../README.md) / [Exports](../modules.md) / LensRepository
+
+# Class: LensRepository
+
+The LensRepository is used to query for lenses from specific lens groups, or for a lens with a specific ID.
+
+Lens groups are configured in the CameraKit Portal -- that's where you'll find lens group IDs and lens IDs.
+
+Lenses must be loaded by the LensRepository before they can be applied to a [CameraKitSession](CameraKitSession.md).
+
+**`Example`**
+
+```ts
+const cameraKit = await bootstrapCameraKit(options)
+const session = await cameraKit.createSession()
+const lens = await cameraKit.lensRepository.loadLens(lensId, groupId)
+session.applyLens(lens)
+```
+
+## Table of contents
+
+### Methods
+
+- [loadLens](LensRepository.md#loadlens)
+- [loadLensGroups](LensRepository.md#loadlensgroups)
+- [cacheLensContent](LensRepository.md#cachelenscontent)
+- [getLensMetadata](LensRepository.md#getlensmetadata)
+- [removeCachedLenses](LensRepository.md#removecachedlenses)
+
+## Methods
+
+### loadLens
+
+▸ **loadLens**(`lensId`, `groupId`): `Promise`<[`Lens`](../interfaces/Lens.md)\>
+
+Retrieve a single Lens.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `lensId` | `string` | Desired Lens's unique ID. Can be found in the CameraKit Portal. |
+| `groupId` | `string` | The ID of a group containing the desired Lens. Can be found in the CameraKit Portal. |
+
+#### Returns
+
+`Promise`<[`Lens`](../interfaces/Lens.md)\>
+
+Resolves with the desired Lens, or rejects if an error occurred (including a missing Lens).
+
+___
+
+### loadLensGroups
+
+▸ **loadLensGroups**(`groupIds`): `Promise`<`LensGroupsQueryResponse`\>
+
+Retrieve the Lenses contained in a list of Lens Groups.
+
+This may result in multiple requests to retrieve Lens data (e.g. one per desired group). If any constituent
+requests fail, those errors will be reported in the response – but the returned Promise will not be rejected. Any
+Lenses which could be successfully retrieved will be available in the response.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `groupIds` | `string`[] | A list of Lens Group IDs. Can be found in the CameraKit Portal. |
+
+#### Returns
+
+`Promise`<`LensGroupsQueryResponse`\>
+
+Resolves with a flattened list of all lenses in the desired groups. If any errors occurred during the
+query operation, these will be included in a separate list. If errors are present, the list of Lenses may not
+contain all the Lenses from the desired groups.
+
+___
+
+### cacheLensContent
+
+▸ **cacheLensContent**(`lenses`, `assetTimingsToCache?`): `Promise`<`void`\>
+
+Loads and caches lens content and dependencies to reduce latency when [applyLens](CameraKitSession.md#applylens) is later
+called to apply the lens. This is an in-memory cache, it will not be persisted across page loads.
+
+This may useful if the application A) knows which lenses will be applied and B) has some opportunity to call
+this method before a lens is applied. For example, if the user must perform some other actions before lenses
+become active, this might be a good opportunity to cache lenses to improve applyLens latency.
+
+**`Example`**
+
+```ts
+const lens = await cameraKit.lensRepository.loadLens(lensId, groupId)
+await cameraKit.lensRepository.cacheLensContent([lens])
+
+// sometime later -- this call will use the cached lens content, making lens application faster.
+await cameraKitSession.applyLens(lens)
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `lenses` | [`Lens`](../interfaces/Lens.md)[] | Array of lenses to cache in memory. |
+| `assetTimingsToCache` | (``"required"`` \| ``"onDemand"``)[] | Lenses specify certain required assets that are necessary for the lens to render, and other assets which may be needed by the lens. By default this method will cache all of those assets, but this behavior can be modified to only load the required assets, only the "onDemand" assets, or neither (by passing an empty array). |
+
+#### Returns
+
+`Promise`<`void`\>
+
+___
+
+### getLensMetadata
+
+▸ **getLensMetadata**(`lensId`): `undefined` \| `LensProto`
+
+Returns loaded Lens metadata if available.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `lensId` | `string` |
+
+#### Returns
+
+`undefined` \| `LensProto`
+
+___
+
+### removeCachedLenses
+
+▸ **removeCachedLenses**(`lenses`): `void`
+
+Removes Lens content from the in-memory cache.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `lenses` | [`Lens`](../interfaces/Lens.md)[] |
+
+#### Returns
+
+`void`

package/docs/md/classes/LensSources.md

@@ -0,0 +1,29 @@
+[CameraKit Web SDK - v0.7.0-alpha.1](../README.md) / [Exports](../modules.md) / LensSources
+
+# Class: LensSources
+
+A chain of [LensSource](../interfaces/LensSource.md) objects to be registered in Camera Kit on bootstrap. Camera Kit evaluates all
+registered [LensSource](../interfaces/LensSource.md) objects for a group ownership during Lens retrieval ([lenses](CameraKit.md#lenses)).
+And if a source claims the ownership, its [getLens](../interfaces/LensSource.md#getlens) or [getLensGroup](../interfaces/LensSource.md#getlensgroup)
+methods are called.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](LensSources.md#constructor)
+
+## Constructors
+
+### constructor
+
+• **new LensSources**(`fallbackSources`, `source`)
+
+Creates an instance of Lens sources.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `fallbackSources` | [`LensSources`](LensSources.md) | A fallback sources if given [LensSource](../interfaces/LensSource.md) doesn't claim a group ownership. |
+| `source` | [`LensSource`](../interfaces/LensSource.md) | Lens source. |

package/docs/md/classes/Transform2D.md

@@ -0,0 +1,55 @@
+[CameraKit Web SDK - v0.7.0-alpha.1](../README.md) / [Exports](../modules.md) / Transform2D
+
+# Class: Transform2D
+
+Use this class to supply the CameraKitSession::setSourceTransform with the proper data
+needed to apply transformations
+
+## Table of contents
+
+### Constructors
+
+- [constructor](Transform2D.md#constructor)
+
+### Properties
+
+- [MirrorX](Transform2D.md#mirrorx)
+- [MirrorY](Transform2D.md#mirrory)
+- [Identity](Transform2D.md#identity)
+- [matrix](Transform2D.md#matrix)
+
+## Constructors
+
+### constructor
+
+• **new Transform2D**(`matrix`)
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `matrix` | [`number`, `number`, `number`, `number`, `number`, `number`, `number`, `number`, `number`] | A 3x3 matrix in column-major order, representing a 2D transform to be applied to the source media |
+
+## Properties
+
+### MirrorX
+
+▪ `Static` `Readonly` **MirrorX**: [`Transform2D`](Transform2D.md)
+
+___
+
+### MirrorY
+
+▪ `Static` `Readonly` **MirrorY**: [`Transform2D`](Transform2D.md)
+
+___
+
+### Identity
+
+▪ `Static` `Readonly` **Identity**: [`Transform2D`](Transform2D.md)
+
+___
+
+### matrix
+
+• `Readonly` **matrix**: [`number`, `number`, `number`, `number`, `number`, `number`, `number`, `number`, `number`]

package/docs/md/classes/TypedCustomEvent.md

@@ -0,0 +1,65 @@
+[CameraKit Web SDK - v0.7.0-alpha.1](../README.md) / [Exports](../modules.md) / TypedCustomEvent
+
+# Class: TypedCustomEvent<N, T\>
+
+This wrapper around CustomEvent provides more descriptive type information. By using this class, the `type` property
+of the CustomEvent will be typed as a string literal – this allows [TypedEventTarget] to provide more useful type
+checking of events.
+
+## Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `N` | extends `string` = `string` |
+| `T` | `any` |
+
+## Hierarchy
+
+- `CustomEvent`<`T`\>
+
+  ↳ **`TypedCustomEvent`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](TypedCustomEvent.md#constructor)
+
+### Properties
+
+- [type](TypedCustomEvent.md#type)
+
+## Constructors
+
+### constructor
+
+• **new TypedCustomEvent**<`N`, `T`\>(`type`, `detail`, `eventInitDict?`)
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `N` | extends `string` = `string` |
+| `T` | `any` |
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `type` | `N` |
+| `detail` | `T` |
+| `eventInitDict` | `Omit`<`CustomEventInit`<`T`\>, ``"detail"``\> |
+
+#### Overrides
+
+CustomEvent&lt;T\&gt;.constructor
+
+## Properties
+
+### type
+
+• `Readonly` **type**: `N`
+
+#### Overrides
+
+CustomEvent.type

package/docs/md/classes/TypedEventTarget.md

@@ -0,0 +1,103 @@
+[CameraKit Web SDK - v0.7.0-alpha.1](../README.md) / [Exports](../modules.md) / TypedEventTarget
+
+# Class: TypedEventTarget<Events\>
+
+This wrapper around EventTarget provides more descriptive type information. By using this class, calls to EventTarget
+methods are correctly type checked to ensure only allowed event types are used, and that events and their type
+strings are correctly associated.
+
+For example, when calling TypedEventTarget::addEventListener, the event passed to the callback will have the correct
+type corresponding to the type of event for which the listener has been added.
+
+## Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `Events` | extends [`TypedCustomEvent`](TypedCustomEvent.md) = [`TypedCustomEvent`](TypedCustomEvent.md) |
+
+## Table of contents
+
+### Constructors
+
+- [constructor](TypedEventTarget.md#constructor)
+
+### Methods
+
+- [addEventListener](TypedEventTarget.md#addeventlistener)
+- [dispatchEvent](TypedEventTarget.md#dispatchevent)
+- [removeEventListener](TypedEventTarget.md#removeeventlistener)
+
+## Constructors
+
+### constructor
+
+• **new TypedEventTarget**<`Events`\>()
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `Events` | extends [`TypedCustomEvent`](TypedCustomEvent.md)<`string`, `any`, `Events`\> = [`TypedCustomEvent`](TypedCustomEvent.md)<`string`, `any`\> |
+
+## Methods
+
+### addEventListener
+
+▸ **addEventListener**<`K`\>(`type`, `callback`, `options?`): `void`
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `K` | extends `string` |
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `type` | `K` |
+| `callback` | `TypedEventListener`<`Extract`<`Events`, [`TypedCustomEvent`](TypedCustomEvent.md)<`K`, `any`\>\>\> |
+| `options?` | `TypedEventListenerOptions` |
+
+#### Returns
+
+`void`
+
+___
+
+### dispatchEvent
+
+▸ **dispatchEvent**(`event`): ``true``
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `event` | `Events` |
+
+#### Returns
+
+``true``
+
+___
+
+### removeEventListener
+
+▸ **removeEventListener**<`K`\>(`type`, `callback`): `void`
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `K` | extends `string` |
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `type` | `K` |
+| `callback` | `TypedEventListener`<`Extract`<`Events`, [`TypedCustomEvent`](TypedCustomEvent.md)<`K`, `any`\>\>\> |
+
+#### Returns
+
+`void`

package/docs/md/interfaces/CameraKitBootstrapConfiguration.md

@@ -0,0 +1,106 @@
+[CameraKit Web SDK - v0.7.0-alpha.1](../README.md) / [Exports](../modules.md) / CameraKitBootstrapConfiguration
+
+# 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
+
+### Properties
+
+- [apiToken](CameraKitBootstrapConfiguration.md#apitoken)
+- [logger](CameraKitBootstrapConfiguration.md#logger)
+- [logLevel](CameraKitBootstrapConfiguration.md#loglevel)
+- [lensPerformance](CameraKitBootstrapConfiguration.md#lensperformance)
+- [lensCoreOverrideUrls](CameraKitBootstrapConfiguration.md#lenscoreoverrideurls)
+- [wasmEndpointOverride](CameraKitBootstrapConfiguration.md#wasmendpointoverride)
+
+## Properties
+
+### apiToken
+
+• **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
+
+• `Optional` **logger**: ``"noop"`` \| ``"console"``
+
+Determine where to print CameraKit log messages. By default no logs will be printed.
+
+CameraKit emits log messages to help diagnose and root cause issues that may occur during the development of a
+host application. The printing of these can be controlled via the following
+options:
+ - `noop`: log messages are ignored.
+ - `console`: log messages are printed to console.
+
+___
+
+### logLevel
+
+• `Optional` **logLevel**: ``"debug"`` \| ``"error"`` \| ``"warn"`` \| ``"log"`` \| ``"info"``
+
+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
+
+• `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
+performance cluster (i.e. a performance rating) based on the current environment.
+
+Lower cluster = worse expected performance capability.
+
+**`Example`**
+
+```ts
+import { bootstrapCameraKit, estimateLensPerformance } from '@snap/camera-kit`
+
+const cameraKit = await bootstrapCameraKit({
+  apiToken: '...',
+  lensPerformance: estimateLensPerformance(),
+})
+```
+
+___
+
+### lensCoreOverrideUrls
+
+• `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
+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
+
+| Name | Type |
+| :------ | :------ |
+| `wasm` | `string` |
+| `js` | `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.

package/docs/md/interfaces/CameraKitSourceSubscriber.md

@@ -0,0 +1,55 @@
+[CameraKit Web SDK - v0.7.0-alpha.1](../README.md) / [Exports](../modules.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
+
+- [onAttach](CameraKitSourceSubscriber.md#onattach)
+- [onDetach](CameraKitSourceSubscriber.md#ondetach)
+
+## Properties
+
+### onAttach
+
+• `Optional` `Readonly` **onAttach**: (`source`: [`CameraKitSource`](../classes/CameraKitSource.md), `lensCore`: `LensCoreModule`, `reportError`: (`error`: `Error`) => `void`) => `void` \| `Promise`<`void`\>
+
+#### Type declaration
+
+▸ (`source`, `lensCore`, `reportError`): `void` \| `Promise`<`void`\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `source` | [`CameraKitSource`](../classes/CameraKitSource.md) |
+| `lensCore` | `LensCoreModule` |
+| `reportError` | (`error`: `Error`) => `void` |
+
+##### Returns
+
+`void` \| `Promise`<`void`\>
+
+___
+
+### onDetach
+
+• `Optional` `Readonly` **onDetach**: (`reportError`: (`error`: `Error`) => `void`) => `void` \| `Promise`<`void`\>
+
+#### Type declaration
+
+▸ (`reportError`): `void` \| `Promise`<`void`\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `reportError` | (`error`: `Error`) => `void` |
+
+##### Returns
+
+`void` \| `Promise`<`void`\>

package/docs/md/interfaces/ComputedFrameMetrics.md

@@ -0,0 +1,29 @@
+[CameraKit Web SDK - v0.7.0-alpha.1](../README.md) / [Exports](../modules.md) / ComputedFrameMetrics
+
+# Interface: ComputedFrameMetrics
+
+## Table of contents
+
+### Properties
+
+- [avgFps](ComputedFrameMetrics.md#avgfps)
+- [lensFrameProcessingTimeMsAvg](ComputedFrameMetrics.md#lensframeprocessingtimemsavg)
+- [lensFrameProcessingTimeMsStd](ComputedFrameMetrics.md#lensframeprocessingtimemsstd)
+
+## Properties
+
+### avgFps
+
+• **avgFps**: `number`
+
+___
+
+### lensFrameProcessingTimeMsAvg
+
+• **lensFrameProcessingTimeMsAvg**: `number`
+
+___
+
+### lensFrameProcessingTimeMsStd
+
+• **lensFrameProcessingTimeMsStd**: `number`

package/docs/md/interfaces/CreateSessionOptions.md

@@ -0,0 +1,35 @@
+[CameraKit Web SDK - v0.7.0-alpha.1](../README.md) / [Exports](../modules.md) / CreateSessionOptions
+
+# Interface: CreateSessionOptions
+
+Options available when creating a [CameraKitSession](../classes/CameraKitSession.md).
+
+## Table of contents
+
+### Properties
+
+- [liveRenderTarget](CreateSessionOptions.md#liverendertarget)
+- [renderWhileTabHidden](CreateSessionOptions.md#renderwhiletabhidden)
+
+## Properties
+
+### liveRenderTarget
+
+• `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
+
+• `Optional` **renderWhileTabHidden**: `boolean`
+
+Browsers optimize tabs when they are hidden - for example, by pausing the execution of requestAnimationFrame
+callbacks.
+
+If you need the CameraKitSession to continue rendering even when the tab is in the background, set this to true.
+There is a small performance penalty, and it's a good practice to only render in the background if absolutely
+necessary.

package/docs/md/interfaces/EstimatedLensPerformance.md

@@ -0,0 +1,38 @@
+[CameraKit Web SDK - v0.7.0-alpha.1](../README.md) / [Exports](../modules.md) / EstimatedLensPerformance
+
+# Interface: EstimatedLensPerformance
+
+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).
+
+The cluster value will be an integer from 1-6 which classifies expected lens performance, where 6 is the highest-
+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)
+
+___
+
+### benchmarks
+
+• **benchmarks**: `BenchmarkResult`[]
+
+___
+
+### webglRendererInfo
+
+• **webglRendererInfo**: `string`