@snap/camera-kit 1.0.0 → 1.1.0

package/docs/md/interfaces/CameraKitSourceInfo.md

@@ -1,43 +1,37 @@
-[CameraKit Web SDK - v1.0.0](../README.md) / [Exports](../modules.md) / CameraKitSourceInfo
+[**CameraKit Web SDK v1.1.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.0](../README.md) / [Exports](../modules.md) / CameraKitSourceSubscriber
+[**CameraKit Web SDK v1.1.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.0](../README.md) / [Exports](../modules.md) / ComputedFrameMetrics
+[**CameraKit Web SDK v1.1.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.0](../README.md) / [Exports](../modules.md) / CreateSessionOptions
+[**CameraKit Web SDK v1.1.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.0](../README.md) / [Exports](../modules.md) / EstimatedLensPerformance
+[**CameraKit Web SDK v1.1.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.1.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.0](../README.md) / [Exports](../modules.md) / FriendUserInfo
+[**CameraKit Web SDK v1.1.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.0](../README.md) / [Exports](../modules.md) / FunctionSourceOptions
+[**CameraKit Web SDK v1.1.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.

package/docs/md/interfaces/Lens.md

@@ -1,114 +1,103 @@
-[CameraKit Web SDK - v1.0.0](../README.md) / [Exports](../modules.md) / Lens
+[**CameraKit Web SDK v1.1.0**](../README.md)
 
-# Interface: Lens
-
-## Table of contents
+***
 
-### Properties
+[CameraKit Web SDK](../globals.md) / Lens
 
-- [id](Lens.md#id)
-- [groupId](Lens.md#groupid)
-- [name](Lens.md#name)
-- [iconUrl](Lens.md#iconurl)
-- [vendorData](Lens.md#vendordata)
-- [cameraFacingPreference](Lens.md#camerafacingpreference)
-- [preview](Lens.md#preview)
-- [lensCreator](Lens.md#lenscreator)
-- [snapcode](Lens.md#snapcode)
-- [featureMetadata](Lens.md#featuremetadata)
+# Interface: Lens
 
 ## Properties
 
 ### id
 
-• **id**: `string`
+> **id**: `string`
 
 Non-empty identifier of a unique lens available to be applied in current session.
 
 NOTE: This value may contain unsafe characters
 and therefore may require additional processing depending on usages.
 
-___
+***
 
 ### groupId
 
-• **groupId**: `string`
+> **groupId**: `string`
 
 The unique identifier for the group that this lens is a part of,
 correlating to a collection of lenses grouped for organizational or functional purposes.
 
-___
+***
 
 ### name
 
-• **name**: `string`
+> **name**: `string`
 
 Human readable name of this lens.
 
 NOTE: This value may contain unsafe characters
 and therefore may require additional processing depending on usages.
 
-___
+***
 
 ### iconUrl
 
-• **iconUrl**: `undefined` \| `string`
+> **iconUrl**: `undefined` \| `string`
 
 Icon resource URI that represents this lens if available.
 
-___
+***
 
 ### vendorData
 
-• **vendorData**: `Object`
+> **vendorData**: `object`
 
 Vendor specific metadata associated with this lens, empty by default.
 
 NOTE: Metadata values may contain unsafe characters
 and therefore may require additional processing depending on usages.
 
-#### Index signature
+#### Index Signature
 
-▪ [key: `string`]: `string`
+ \[`key`: `string`\]: `string`
 
-___
+***
 
 ### cameraFacingPreference
 
-• **cameraFacingPreference**: [`Lens_CameraFacing`](../enums/Lens_CameraFacing.md)
+> **cameraFacingPreference**: [`Lens_CameraFacing`](../enumerations/Lens_CameraFacing.md)
 
-Specifies a [Lens_CameraFacing](../enums/Lens_CameraFacing.md) that this lens is designed for.
+Specifies a [Lens_CameraFacing](../enumerations/Lens_CameraFacing.md) that this lens is designed for.
 
-___
+***
 
 ### preview
 
-• **preview**: `undefined` \| [`Preview`](Preview.md)
+> **preview**: `undefined` \| [`Preview`](Preview.md)
 
 Preview representing this lens, if available.
 
-___
+***
 
 ### lensCreator
 
-• **lensCreator**: `undefined` \| [`LensCreator`](LensCreator.md)
+> **lensCreator**: `undefined` \| [`LensCreator`](LensCreator.md)
 
 Information about the lens creator.
 
-___
+***
 
 ### snapcode
 
-• **snapcode**: `undefined` \| [`Snapcode`](Snapcode.md)
+> **snapcode**: `undefined` \| [`Snapcode`](Snapcode.md)
 
 A [snapcode](https://scan.snapchat.com/snapcodes) that represents the lens if available.
 
 The snapcode points to the lens in the Snapchat app, when used on mobile, or a dedicated web page.
 
-___
+***
 
 ### featureMetadata
 
-• **featureMetadata**: `Any`[]
+> **featureMetadata**: `Any`[]
 
 Metadata pertaining to a specific set of lens features

package/docs/md/interfaces/LensCreator.md

@@ -1,17 +1,15 @@
-[CameraKit Web SDK - v1.0.0](../README.md) / [Exports](../modules.md) / LensCreator
+[**CameraKit Web SDK v1.1.0**](../README.md)
 
-# Interface: LensCreator
-
-Lens creator.
+***
 
-## Table of contents
+[CameraKit Web SDK](../globals.md) / LensCreator
 
-### Properties
+# Interface: LensCreator
 
-- [displayName](LensCreator.md#displayname)
+Lens creator.
 
 ## Properties
 
 ### displayName
 
-• **displayName**: `string`
+> **displayName**: `string`

package/docs/md/interfaces/LensHttpRequest.md

@@ -0,0 +1,60 @@
+[**CameraKit Web SDK v1.1.0**](../README.md)
+
+***
+
+[CameraKit Web SDK](../globals.md) / LensHttpRequest
+
+# Interface: LensHttpRequest
+
+Represents context for an HTTP request made by a Lens.
+
+This interface provides detailed information about the request, such as its identifier,
+method, data payload, headers, and associated Lens object.
+
+## Properties
+
+### url
+
+> **url**: `string`
+
+The URL of the HTTP request.
+
+***
+
+### identifier
+
+> **identifier**: `string`
+
+A unique identifier for the HTTP request.
+
+***
+
+### method
+
+> **method**: `string`
+
+The HTTP method of the request (e.g., GET, POST, PUT, DELETE).
+
+***
+
+### data
+
+> **data**: `ArrayBuffer`
+
+The raw data payload for the HTTP request, represented as an `ArrayBuffer`.
+
+***
+
+### headers
+
+> **headers**: `Record`\<`string`, `string`\>
+
+The headers included in the HTTP request.
+
+***
+
+### lens
+
+> **lens**: [`Lens`](Lens.md)
+
+The [Lens](Lens.md) that initiated this request.

package/docs/md/interfaces/LensLaunchData.md

@@ -1,4 +1,8 @@
-[CameraKit Web SDK - v1.0.0](../README.md) / [Exports](../modules.md) / LensLaunchData
+[**CameraKit Web SDK v1.1.0**](../README.md)
+
+***
+
+[CameraKit Web SDK](../globals.md) / LensLaunchData
 
 # Interface: LensLaunchData
 
@@ -7,28 +11,20 @@ Some Lenses may accept (or require) certain data provided to them when the Lens
 This data may include things like user info (to render the user's name, for example, or perform some task based on
 their birth date), or arbitrary `launchParams` defined by the Lens.
 
-## Table of contents
-
-### Properties
-
-- [userId](LensLaunchData.md#userid)
-- [userData](LensLaunchData.md#userdata)
-- [launchParams](LensLaunchData.md#launchparams)
-
 ## Properties
 
-### userId
+### userId?
 
-• `Optional` **userId**: `string`
+> `optional` **userId**: `string`
 
-___
+***
 
-### userData
+### userData?
 
-• `Optional` **userData**: [`LensUserData`](LensUserData.md)
+> `optional` **userData**: [`LensUserData`](LensUserData.md)
 
-___
+***
 
-### launchParams
+### launchParams?
 
-• `Optional` **launchParams**: [`LensLaunchParams`](../modules.md#lenslaunchparams)
+> `optional` **launchParams**: [`LensLaunchParams`](../type-aliases/LensLaunchParams.md)