@snap/camera-kit 1.0.1 → 1.2.0

package/docs/md/classes/LensPerformanceMeasurement.md

@@ -1,4 +1,8 @@
-[CameraKit Web SDK - v1.0.1](../README.md) / [Exports](../modules.md) / LensPerformanceMeasurement
+[**CameraKit Web SDK v1.2.0**](../README.md)
+
+***
+
+[CameraKit Web SDK](../globals.md) / LensPerformanceMeasurement
 
 # Class: LensPerformanceMeasurement
 
@@ -7,29 +11,17 @@ Represents an ongoing measurement of rendering metrics.
 An instance of this class is obtained by calling [LensPerformanceMetrics.beginMeasurement](LensPerformanceMetrics.md#beginmeasurement). Then it may be
 used to record rendering performance metrics, reset measurement, or end the measurement.
 
-## Table of contents
-
-### Constructors
-
-- [constructor](LensPerformanceMeasurement.md#constructor)
-
-### Methods
-
-- [measure](LensPerformanceMeasurement.md#measure)
-- [reset](LensPerformanceMeasurement.md#reset)
-- [end](LensPerformanceMeasurement.md#end)
-
 ## Constructors
 
-### constructor
+### new LensPerformanceMeasurement()
 
-• **new LensPerformanceMeasurement**(`instances`): [`LensPerformanceMeasurement`](LensPerformanceMeasurement.md)
+> **new LensPerformanceMeasurement**(`instances`): [`LensPerformanceMeasurement`](LensPerformanceMeasurement.md)
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `instances` | `Set`\<[`LensPerformanceMeasurement`](LensPerformanceMeasurement.md)\> |
+##### instances
+
+`Set`\<[`LensPerformanceMeasurement`](LensPerformanceMeasurement.md)\>
 
 #### Returns
 
@@ -37,9 +29,9 @@ used to record rendering performance metrics, reset measurement, or end the meas
 
 ## Methods
 
-### measure
+### measure()
 
-▸ **measure**(): [`ComputedFrameMetrics`](../interfaces/ComputedFrameMetrics.md)
+> **measure**(): [`ComputedFrameMetrics`](../interfaces/ComputedFrameMetrics.md)
 
 Return a [ComputedFrameMetrics](../interfaces/ComputedFrameMetrics.md) object, containing lens performance metrics.
 
@@ -50,11 +42,11 @@ was created.
 
 [`ComputedFrameMetrics`](../interfaces/ComputedFrameMetrics.md)
 
-___
+***
 
-### reset
+### reset()
 
-▸ **reset**(): `void`
+> **reset**(): `void`
 
 Reset the measured performance statistics (averages, std deviations). This is equivalent to using
 [LensPerformanceMetrics.beginMeasurement](LensPerformanceMetrics.md#beginmeasurement) to create a new LensPerformanceMeasurement instance, but may be
@@ -64,11 +56,11 @@ more convenient.
 
 `void`
 
-___
+***
 
-### end
+### end()
 
-▸ **end**(): `void`
+> **end**(): `void`
 
 Stop measuring performance statistics.
 

package/docs/md/classes/LensPerformanceMetrics.md

@@ -1,4 +1,8 @@
-[CameraKit Web SDK - v1.0.1](../README.md) / [Exports](../modules.md) / LensPerformanceMetrics
+[**CameraKit Web SDK v1.2.0**](../README.md)
+
+***
+
+[CameraKit Web SDK](../globals.md) / LensPerformanceMetrics
 
 # Class: LensPerformanceMetrics
 
@@ -7,7 +11,7 @@ Use to measure lens rendering performance.
 The [LensPerformanceMetrics.beginMeasurement](LensPerformanceMetrics.md#beginmeasurement) method is used to start measuring rendering performance. After
 a measurement has begun, performance metrics can be read using [LensPerformanceMeasurement](LensPerformanceMeasurement.md).
 
-**`Example`**
+## Example
 
 ```ts
 const measurement = cameraKitSession.metrics.beginMeasurement()
@@ -15,17 +19,11 @@ const measurement = cameraKitSession.metrics.beginMeasurement()
 console.log(measurement.measure())
 ```
 
-## Table of contents
-
-### Methods
-
-- [beginMeasurement](LensPerformanceMetrics.md#beginmeasurement)
-
 ## Methods
 
-### beginMeasurement
+### beginMeasurement()
 
-▸ **beginMeasurement**(): [`LensPerformanceMeasurement`](LensPerformanceMeasurement.md)
+> **beginMeasurement**(): [`LensPerformanceMeasurement`](LensPerformanceMeasurement.md)
 
 Begin a measurement window, during which time rendering metrics will be gathered.
 

package/docs/md/classes/LensRepository.md

@@ -1,4 +1,8 @@
-[CameraKit Web SDK - v1.0.1](../README.md) / [Exports](../modules.md) / LensRepository
+[**CameraKit Web SDK v1.2.0**](../README.md)
+
+***
+
+[CameraKit Web SDK](../globals.md) / LensRepository
 
 # Class: LensRepository
 
@@ -8,7 +12,7 @@ Lens groups are configured in the CameraKit Portal -- that's where you'll find l
 
 Lenses must be loaded by the LensRepository before they can be applied to a [CameraKitSession](CameraKitSession.md).
 
-**`Example`**
+## Example
 
 ```ts
 const cameraKit = await bootstrapCameraKit(options)
@@ -17,30 +21,27 @@ 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()
 
-▸ **loadLens**(`lensId`, `groupId`): `Promise`\<[`Lens`](../interfaces/Lens.md)\>
+> **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. |
+##### 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
 
@@ -48,11 +49,11 @@ Retrieve a single Lens.
 
 Resolves with the desired Lens, or rejects if an error occurred (including a missing Lens).
 
-___
+***
 
-### loadLensGroups
+### loadLensGroups()
 
-▸ **loadLensGroups**(`groupIds`): `Promise`\<\{ `errors`: `Error`[] ; `lenses`: [`Lens`](../interfaces/Lens.md)[]  }\>
+> **loadLensGroups**(`groupIds`): `Promise`\<`object`\>
 
 Retrieve the Lenses contained in a list of Lens Groups.
 
@@ -62,23 +63,33 @@ 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. |
+##### groupIds
+
+`string`[]
+
+A list of Lens Group IDs. Can be found in the CameraKit Portal.
 
 #### Returns
 
-`Promise`\<\{ `errors`: `Error`[] ; `lenses`: [`Lens`](../interfaces/Lens.md)[]  }\>
+`Promise`\<`object`\>
 
 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.
 
-___
+##### errors
 
-### cacheLensContent
+> **errors**: `Error`[]
 
-▸ **cacheLensContent**(`lenses`, `assetTimingsToCache?`): `Promise`\<`void`\>
+##### lenses
+
+> **lenses**: [`Lens`](../interfaces/Lens.md)[]
+
+***
+
+### cacheLensContent()
+
+> **cacheLensContent**(`lenses`, `assetTimingsToCache`): `Promise`\<`void`\>
 
 Loads and caches lens content and dependencies to reduce latency when [CameraKitSession.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.
@@ -89,16 +100,26 @@ become active, this might be a good opportunity to cache lenses to improve apply
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `lenses` | [`Lens`](../interfaces/Lens.md)[] | Array of lenses to cache in memory. |
-| `assetTimingsToCache` | [`AssetTiming`](../modules.md#assettiming)[] | 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). |
+##### lenses
+
+[`Lens`](../interfaces/Lens.md)[]
+
+Array of lenses to cache in memory.
+
+##### assetTimingsToCache
+
+[`AssetTiming`](../type-aliases/AssetTiming.md)[] = `...`
+
+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`\>
 
-**`Example`**
+#### Example
 
 ```ts
 const lens = await cameraKit.lensRepository.loadLens(lensId, groupId)
@@ -108,37 +129,37 @@ await cameraKit.lensRepository.cacheLensContent([lens])
 await cameraKitSession.applyLens(lens)
 ```
 
-___
+***
 
-### getLensMetadata
+### getLensMetadata()
 
-▸ **getLensMetadata**(`lensId`): `undefined` \| `LensProtoWithGroupId`
+> **getLensMetadata**(`lensId`): `undefined` \| `LensProtoWithGroupId`
 
 Returns loaded Lens metadata if available.
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `lensId` | `string` |
+##### lensId
+
+`string`
 
 #### Returns
 
 `undefined` \| `LensProtoWithGroupId`
 
-___
+***
 
-### removeCachedLenses
+### removeCachedLenses()
 
-▸ **removeCachedLenses**(`lenses`): `void`
+> **removeCachedLenses**(`lenses`): `void`
 
 Removes Lens content from the in-memory cache.
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `lenses` | [`Lens`](../interfaces/Lens.md)[] |
+##### lenses
+
+[`Lens`](../interfaces/Lens.md)[]
 
 #### Returns
 

package/docs/md/classes/Transform2D.md

@@ -1,34 +1,27 @@
-[CameraKit Web SDK - v1.0.1](../README.md) / [Exports](../modules.md) / Transform2D
+[**CameraKit Web SDK v1.2.0**](../README.md)
+
+***
+
+[CameraKit Web SDK](../globals.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()
 
-• **new Transform2D**(`matrix`): [`Transform2D`](Transform2D.md)
+> **new Transform2D**(`matrix`): [`Transform2D`](Transform2D.md)
 
 #### 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 |
+##### 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
 
 #### Returns
 
@@ -38,24 +31,24 @@ needed to apply transformations.
 
 ### MirrorX
 
-▪ `Static` `Readonly` **MirrorX**: [`Transform2D`](Transform2D.md)
+> `readonly` `static` **MirrorX**: [`Transform2D`](Transform2D.md)
 
-___
+***
 
 ### MirrorY
 
-▪ `Static` `Readonly` **MirrorY**: [`Transform2D`](Transform2D.md)
+> `readonly` `static` **MirrorY**: [`Transform2D`](Transform2D.md)
 
-___
+***
 
 ### Identity
 
-▪ `Static` `Readonly` **Identity**: [`Transform2D`](Transform2D.md)
+> `readonly` `static` **Identity**: [`Transform2D`](Transform2D.md)
 
-___
+***
 
 ### matrix
 
-• `Readonly` **matrix**: [`number`, `number`, `number`, `number`, `number`, `number`, `number`, `number`, `number`]
+> `readonly` **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

package/docs/md/classes/TypedCustomEvent.md

@@ -1,4 +1,8 @@
-[CameraKit Web SDK - v1.0.1](../README.md) / [Exports](../modules.md) / TypedCustomEvent
+[**CameraKit Web SDK v1.2.0**](../README.md)
+
+***
+
+[CameraKit Web SDK](../globals.md) / TypedCustomEvent
 
 # Class: TypedCustomEvent\<N, T\>
 
@@ -6,49 +10,35 @@ This wrapper around CustomEvent provides more descriptive type information. By u
 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
+## Extends
 
 - `CustomEvent`\<`T`\>
 
-  ↳ **`TypedCustomEvent`**
+## Type Parameters
 
-## Table of contents
+• **N** *extends* `string` = `string`
 
-### Constructors
+• **T** = `any`
 
-- [constructor](TypedCustomEvent.md#constructor)
+## Constructors
 
-### Properties
+### new TypedCustomEvent()
 
-- [type](TypedCustomEvent.md#type)
+> **new TypedCustomEvent**\<`N`, `T`\>(`type`, `detail`, `eventInitDict`): [`TypedCustomEvent`](TypedCustomEvent.md)\<`N`, `T`\>
 
-## Constructors
+#### Parameters
 
-### constructor
+##### type
 
-• **new TypedCustomEvent**\<`N`, `T`\>(`type`, `detail`, `eventInitDict?`): [`TypedCustomEvent`](TypedCustomEvent.md)\<`N`, `T`\>
+`N`
 
-#### Type parameters
+##### detail
 
-| Name | Type |
-| :------ | :------ |
-| `N` | extends `string` = `string` |
-| `T` | `any` |
+`T`
 
-#### Parameters
+##### eventInitDict
 
-| Name | Type |
-| :------ | :------ |
-| `type` | `N` |
-| `detail` | `T` |
-| `eventInitDict` | `Omit`\<`CustomEventInit`\<`T`\>, ``"detail"``\> |
+`Omit`\<`CustomEventInit`\<`T`\>, `"detail"`\> = `{}`
 
 #### Returns
 
@@ -56,14 +46,16 @@ checking of events.
 
 #### Overrides
 
-CustomEvent\&lt;T\&gt;.constructor
+`CustomEvent<T>.constructor`
 
 ## Properties
 
 ### type
 
-• `Readonly` **type**: `N`
+> `readonly` **type**: `N`
+
+Returns the type of event, e.g. "click", "hashchange", or "submit".
 
 #### Overrides
 
-CustomEvent.type
+`CustomEvent.type`

package/docs/md/classes/TypedEventTarget.md

@@ -1,4 +1,8 @@
-[CameraKit Web SDK - v1.0.1](../README.md) / [Exports](../modules.md) / TypedEventTarget
+[**CameraKit Web SDK v1.2.0**](../README.md)
+
+***
+
+[CameraKit Web SDK](../globals.md) / TypedEventTarget
 
 # Class: TypedEventTarget\<Events\>
 
@@ -9,35 +13,15 @@ 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
+## Type Parameters
 
-- [constructor](TypedEventTarget.md#constructor)
-
-### Methods
-
-- [addEventListener](TypedEventTarget.md#addeventlistener)
-- [dispatchEvent](TypedEventTarget.md#dispatchevent)
-- [removeEventListener](TypedEventTarget.md#removeeventlistener)
+• **Events** *extends* [`TypedCustomEvent`](TypedCustomEvent.md) = [`TypedCustomEvent`](TypedCustomEvent.md)
 
 ## Constructors
 
-### constructor
-
-• **new TypedEventTarget**\<`Events`\>(): [`TypedEventTarget`](TypedEventTarget.md)\<`Events`\>
-
-#### Type parameters
+### new TypedEventTarget()
 
-| Name | Type |
-| :------ | :------ |
-| `Events` | extends [`TypedCustomEvent`](TypedCustomEvent.md)\<`string`, `any`, `Events`\> = [`TypedCustomEvent`](TypedCustomEvent.md)\<`string`, `any`\> |
+> **new TypedEventTarget**\<`Events`\>(): [`TypedEventTarget`](TypedEventTarget.md)\<`Events`\>
 
 #### Returns
 
@@ -45,62 +29,67 @@ type corresponding to the type of event for which the listener has been added.
 
 ## Methods
 
-### addEventListener
+### addEventListener()
 
-▸ **addEventListener**\<`K`\>(`type`, `callback`, `options?`): `void`
+> **addEventListener**\<`K`\>(`type`, `callback`, `options`?): `void`
 
-#### Type parameters
+#### Type Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `K` | extends `string` |
+• **K** *extends* `string`
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `type` | `K` |
-| `callback` | `TypedEventListener`\<`EventOfType`\<`K`, `Events`\>\> |
-| `options?` | `TypedEventListenerOptions` |
+##### type
+
+`K`
+
+##### callback
+
+`TypedEventListener`\<`EventOfType`\<`K`, `Events`\>\>
+
+##### options?
+
+`TypedEventListenerOptions`
 
 #### Returns
 
 `void`
 
-___
+***
 
-### dispatchEvent
+### dispatchEvent()
 
-▸ **dispatchEvent**(`event`): ``true``
+> **dispatchEvent**(`event`): `true`
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `event` | `Events` |
+##### event
+
+`Events`
 
 #### Returns
 
-``true``
+`true`
 
-___
+***
 
-### removeEventListener
+### removeEventListener()
 
-▸ **removeEventListener**\<`K`\>(`type`, `callback`): `void`
+> **removeEventListener**\<`K`\>(`type`, `callback`): `void`
 
-#### Type parameters
+#### Type Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `K` | extends `string` |
+• **K** *extends* `string`
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `type` | `K` |
-| `callback` | `TypedEventListener`\<`EventOfType`\<`K`, `Events`\>\> |
+##### type
+
+`K`
+
+##### callback
+
+`TypedEventListener`\<`EventOfType`\<`K`, `Events`\>\>
 
 #### Returns
 

package/docs/md/enumerations/Lens_CameraFacing.md

@@ -0,0 +1,31 @@
+[**CameraKit Web SDK v1.2.0**](../README.md)
+
+***
+
+[CameraKit Web SDK](../globals.md) / Lens\_CameraFacing
+
+# Enumeration: Lens\_CameraFacing
+
+## Enumeration Members
+
+### CAMERA\_FACING\_UNSET
+
+> **CAMERA\_FACING\_UNSET**: `0`
+
+***
+
+### CAMERA\_FACING\_FRONT
+
+> **CAMERA\_FACING\_FRONT**: `1`
+
+***
+
+### CAMERA\_FACING\_BACK
+
+> **CAMERA\_FACING\_BACK**: `2`
+
+***
+
+### UNRECOGNIZED
+
+> **UNRECOGNIZED**: `-1`