@snap/camera-kit 1.0.1 → 1.2.0

package/docs/md/interfaces/LoadAssetRequest.md

@@ -1,48 +1,43 @@
-[CameraKit Web SDK - v1.0.1](../README.md) / [Exports](../modules.md) / LoadAssetRequest
+[**CameraKit Web SDK v1.2.0**](../README.md)
 
-# Interface: LoadAssetRequest
-
-Represents a request for loading assets through [AssetLoader](../modules.md#assetloader). This object specifies the asset to be loaded,
-optionally defines the lens context, includes an asset manifest if available, and indicates the priority of the load.
+***
 
-## Table of contents
+[CameraKit Web SDK](../globals.md) / LoadAssetRequest
 
-### Properties
+# Interface: LoadAssetRequest
 
-- [assetDescriptor](LoadAssetRequest.md#assetdescriptor)
-- [lens](LoadAssetRequest.md#lens)
-- [assetManifest](LoadAssetRequest.md#assetmanifest)
-- [lowPriority](LoadAssetRequest.md#lowpriority)
+Represents a request for loading assets through [AssetLoader](../type-aliases/AssetLoader.md). This object specifies the asset to be loaded,
+optionally defines the lens context, includes an asset manifest if available, and indicates the priority of the load.
 
 ## Properties
 
 ### assetDescriptor
 
-• **assetDescriptor**: `AssetDescriptor`
+> **assetDescriptor**: `AssetDescriptor`
 
 Describes the asset to be loaded.
 
-___
+***
 
 ### lens
 
-• **lens**: `undefined` \| [`Lens`](Lens.md)
+> **lens**: `undefined` \| [`Lens`](Lens.md)
 
 Specifies the lens context for the asset load, if applicable.
 
-___
+***
 
 ### assetManifest
 
-• **assetManifest**: `LensAssetManifestItem`[]
+> **assetManifest**: `LensAssetManifestItem`[]
 
 Lens asset manifest.
 
-___
+***
 
 ### lowPriority
 
-• **lowPriority**: `boolean`
+> **lowPriority**: `boolean`
 
 Indicates whether the asset fetch should be treated with lower priority compared to other
 network requests on the page. When set to true, this request may be deferred in favor of higher-priority

package/docs/md/interfaces/MediaStreamSourceOptions.md

@@ -1,29 +1,22 @@
-[CameraKit Web SDK - v1.0.1](../README.md) / [Exports](../modules.md) / MediaStreamSourceOptions
+[**CameraKit Web SDK v1.2.0**](../README.md)
+
+***
+
+[CameraKit Web SDK](../globals.md) / MediaStreamSourceOptions
 
 # Interface: MediaStreamSourceOptions
 
 Media stream source options.
 
-## Hierarchy
+## Extends
 
 - [`CameraKitDeviceOptions`](CameraKitDeviceOptions.md)
 
-  ↳ **`MediaStreamSourceOptions`**
-
-## Table of contents
-
-### Properties
-
-- [cameraType](MediaStreamSourceOptions.md#cameratype)
-- [fpsLimit](MediaStreamSourceOptions.md#fpslimit)
-- [transform](MediaStreamSourceOptions.md#transform)
-- [disableSourceAudio](MediaStreamSourceOptions.md#disablesourceaudio)
-
 ## 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.
@@ -32,13 +25,13 @@ The default value is "user", which accommodates the majority of Lenses.
 
 #### Inherited from
 
-[CameraKitDeviceOptions](CameraKitDeviceOptions.md).[cameraType](CameraKitDeviceOptions.md#cameratype)
+[`CameraKitDeviceOptions`](CameraKitDeviceOptions.md).[`cameraType`](CameraKitDeviceOptions.md#cameratype)
 
-___
+***
 
 ### 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.
@@ -46,22 +39,22 @@ Useful for controlling resource usage on varying device capabilities.
 
 #### Inherited from
 
-[CameraKitDeviceOptions](CameraKitDeviceOptions.md).[fpsLimit](CameraKitDeviceOptions.md#fpslimit)
+[`CameraKitDeviceOptions`](CameraKitDeviceOptions.md).[`fpsLimit`](CameraKitDeviceOptions.md#fpslimit)
 
-___
+***
 
 ### transform
 
-• **transform**: [`Transform2D`](../classes/Transform2D.md)
+> **transform**: [`Transform2D`](../classes/Transform2D.md)
 
 Specifies the 2D transformation to apply to the Lens.
 By default, CameraKit applies no transformation.
 
-___
+***
 
 ### disableSourceAudio
 
-• **disableSourceAudio**: `boolean`
+> **disableSourceAudio**: `boolean`
 
 Indicates whether the audio from the source should be disabled.
 By default, CameraKit passes audio to the Lens.

package/docs/md/interfaces/Preview.md

@@ -1,19 +1,17 @@
-[CameraKit Web SDK - v1.0.1](../README.md) / [Exports](../modules.md) / Preview
+[**CameraKit Web SDK v1.2.0**](../README.md)
 
-# Interface: Preview
-
-Lens preview.
+***
 
-## Table of contents
+[CameraKit Web SDK](../globals.md) / Preview
 
-### Properties
+# Interface: Preview
 
-- [imageUrl](Preview.md#imageurl)
+Lens preview.
 
 ## Properties
 
 ### imageUrl
 
-• **imageUrl**: `string`
+> **imageUrl**: `string`
 
 Link to a lens preview image.

package/docs/md/interfaces/RemoteApiRequest.md

@@ -1,46 +1,41 @@
-[CameraKit Web SDK - v1.0.1](../README.md) / [Exports](../modules.md) / RemoteApiRequest
+[**CameraKit Web SDK v1.2.0**](../README.md)
 
-# Interface: RemoteApiRequest
-
-Remote API request sent by a lens.
+***
 
-## Table of contents
+[CameraKit Web SDK](../globals.md) / RemoteApiRequest
 
-### Properties
+# Interface: RemoteApiRequest
 
-- [apiSpecId](RemoteApiRequest.md#apispecid)
-- [endpointId](RemoteApiRequest.md#endpointid)
-- [parameters](RemoteApiRequest.md#parameters)
-- [body](RemoteApiRequest.md#body)
+Remote API request sent by a lens.
 
 ## Properties
 
 ### apiSpecId
 
-• **apiSpecId**: `string`
+> **apiSpecId**: `string`
 
 Unique id of the remote API service specification.
 
-___
+***
 
 ### endpointId
 
-• **endpointId**: `string`
+> **endpointId**: `string`
 
 Unique id of the remote API service endpoint requested by this request.
 
-___
+***
 
 ### parameters
 
-• **parameters**: `Record`\<`string`, `string`\>
+> **parameters**: `Record`\<`string`, `string`\>
 
 A map of named parameters associated with the request.
 
-___
+***
 
 ### body
 
-• **body**: `ArrayBuffer`
+> **body**: `ArrayBuffer`
 
 Additional binary request payload.

package/docs/md/interfaces/RemoteApiResponse.md

@@ -1,37 +1,33 @@
-[CameraKit Web SDK - v1.0.1](../README.md) / [Exports](../modules.md) / RemoteApiResponse
+[**CameraKit Web SDK v1.2.0**](../README.md)
 
-# Interface: RemoteApiResponse
-
-Remote API response to a request sent by a lens.
+***
 
-## Table of contents
+[CameraKit Web SDK](../globals.md) / RemoteApiResponse
 
-### Properties
+# Interface: RemoteApiResponse
 
-- [status](RemoteApiResponse.md#status)
-- [metadata](RemoteApiResponse.md#metadata)
-- [body](RemoteApiResponse.md#body)
+Remote API response to a request sent by a lens.
 
 ## Properties
 
 ### status
 
-• **status**: [`RemoteApiStatus`](../modules.md#remoteapistatus)
+> **status**: [`RemoteApiStatus`](../type-aliases/RemoteApiStatus.md)
 
 Status of the response
 
-___
+***
 
 ### metadata
 
-• **metadata**: `Record`\<`string`, `string`\>
+> **metadata**: `Record`\<`string`, `string`\>
 
 A map of named metadata associated with the response.
 
-___
+***
 
 ### body
 
-• **body**: `ArrayBuffer`
+> **body**: `ArrayBuffer`
 
 Additional binary request payload.

package/docs/md/interfaces/RemoteApiService.md

@@ -1,45 +1,46 @@
-[CameraKit Web SDK - v1.0.1](../README.md) / [Exports](../modules.md) / RemoteApiService
+[**CameraKit Web SDK v1.2.0**](../README.md)
 
-# Interface: RemoteApiService
-
-Service to handle a lens Remote API request.
+***
 
-## Table of contents
+[CameraKit Web SDK](../globals.md) / RemoteApiService
 
-### Properties
-
-- [apiSpecId](RemoteApiService.md#apispecid)
-
-### Methods
+# Interface: RemoteApiService
 
-- [getRequestHandler](RemoteApiService.md#getrequesthandler)
+Service to handle a lens Remote API request.
 
 ## Properties
 
 ### apiSpecId
 
-• **apiSpecId**: `string`
+> **apiSpecId**: `string`
 
 Remote API spec ID(s).
 
 ## Methods
 
-### getRequestHandler
+### getRequestHandler()
 
-▸ **getRequestHandler**(`request`, `lens`): `undefined` \| [`RemoteApiRequestHandler`](../modules.md#remoteapirequesthandler)
+> **getRequestHandler**(`request`, `lens`): `undefined` \| [`RemoteApiRequestHandler`](../type-aliases/RemoteApiRequestHandler.md)
 
 This method is called by Camera Kit when a lens triggers a Remote API request with a corresponding spec ID.
 If the service can handle the request, the method returns a request handler; otherwise, it returns nothing.
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `request` | [`RemoteApiRequest`](RemoteApiRequest.md) | Remote API request object. |
-| `lens` | [`Lens`](Lens.md) | Lens that triggers the request. |
+##### request
+
+[`RemoteApiRequest`](RemoteApiRequest.md)
+
+Remote API request object.
+
+##### lens
+
+[`Lens`](Lens.md)
+
+Lens that triggers the request.
 
 #### Returns
 
-`undefined` \| [`RemoteApiRequestHandler`](../modules.md#remoteapirequesthandler)
+`undefined` \| [`RemoteApiRequestHandler`](../type-aliases/RemoteApiRequestHandler.md)
 
 A request handler if applicable.

package/docs/md/interfaces/Snapcode.md

@@ -1,28 +1,25 @@
-[CameraKit Web SDK - v1.0.1](../README.md) / [Exports](../modules.md) / Snapcode
+[**CameraKit Web SDK v1.2.0**](../README.md)
 
-# Interface: Snapcode
-
-[Snapcode](https://scan.snapchat.com/snapcodes) representing a lens.
+***
 
-## Table of contents
+[CameraKit Web SDK](../globals.md) / Snapcode
 
-### Properties
+# Interface: Snapcode
 
-- [imageUrl](Snapcode.md#imageurl)
-- [deepLink](Snapcode.md#deeplink)
+[Snapcode](https://scan.snapchat.com/snapcodes) representing a lens.
 
 ## Properties
 
 ### imageUrl
 
-• **imageUrl**: `string`
+> **imageUrl**: `string`
 
 Snapcode image URL scannable with Snapchat app.
 
-___
+***
 
 ### deepLink
 
-• **deepLink**: `string`
+> **deepLink**: `string`
 
 Deeplink URL that directs to a lens web page.

package/docs/md/interfaces/UriCancelRequest.md

@@ -1,22 +1,19 @@
-[CameraKit Web SDK - v1.0.1](../README.md) / [Exports](../modules.md) / UriCancelRequest
+[**CameraKit Web SDK v1.2.0**](../README.md)
 
-# Interface: UriCancelRequest
-
-## Table of contents
+***
 
-### Properties
+[CameraKit Web SDK](../globals.md) / UriCancelRequest
 
-- [uri](UriCancelRequest.md#uri)
-- [requestId](UriCancelRequest.md#requestid)
+# Interface: UriCancelRequest
 
 ## Properties
 
 ### uri
 
-• **uri**: \`$\{string}://$\{string}\`
+> **uri**: \`$\{string\}://$\{string\}\`
 
-___
+***
 
 ### requestId
 
-• **requestId**: `string`
+> **requestId**: `string`

package/docs/md/interfaces/UriRequest.md

@@ -1,50 +1,43 @@
-[CameraKit Web SDK - v1.0.1](../README.md) / [Exports](../modules.md) / UriRequest
+[**CameraKit Web SDK v1.2.0**](../README.md)
 
-# Interface: UriRequest
-
-## Table of contents
+***
 
-### Properties
+[CameraKit Web SDK](../globals.md) / UriRequest
 
-- [uri](UriRequest.md#uri)
-- [identifier](UriRequest.md#identifier)
-- [method](UriRequest.md#method)
-- [contentType](UriRequest.md#contenttype)
-- [data](UriRequest.md#data)
-- [metadata](UriRequest.md#metadata)
+# Interface: UriRequest
 
 ## Properties
 
 ### uri
 
-• **uri**: \`$\{string}://$\{string}\`
+> **uri**: \`$\{string\}://$\{string\}\`
 
-___
+***
 
 ### identifier
 
-• **identifier**: `string`
+> **identifier**: `string`
 
-___
+***
 
 ### method
 
-• **method**: ``"POST"`` \| ``"GET"``
+> **method**: `"POST"` \| `"GET"`
 
-___
+***
 
 ### contentType
 
-• **contentType**: `ContentType`
+> **contentType**: `ContentType`
 
-___
+***
 
 ### data
 
-• **data**: `ArrayBuffer`
+> **data**: `ArrayBuffer`
 
-___
+***
 
 ### metadata
 
-• **metadata**: `Record`\<`string`, `string`\>
+> **metadata**: `Record`\<`string`, `string`\>

package/docs/md/interfaces/UriResponse.md

@@ -1,43 +1,37 @@
-[CameraKit Web SDK - v1.0.1](../README.md) / [Exports](../modules.md) / UriResponse
+[**CameraKit Web SDK v1.2.0**](../README.md)
 
-# Interface: UriResponse
-
-## Table of contents
+***
 
-### Properties
+[CameraKit Web SDK](../globals.md) / UriResponse
 
-- [code](UriResponse.md#code)
-- [description](UriResponse.md#description)
-- [contentType](UriResponse.md#contenttype)
-- [data](UriResponse.md#data)
-- [metadata](UriResponse.md#metadata)
+# Interface: UriResponse
 
 ## Properties
 
 ### code
 
-• **code**: `number`
+> **code**: `number`
 
-___
+***
 
 ### description
 
-• **description**: `string`
+> **description**: `string`
 
-___
+***
 
 ### contentType
 
-• **contentType**: `ContentType`
+> **contentType**: `ContentType`
 
-___
+***
 
 ### data
 
-• **data**: `ArrayBuffer`
+> **data**: `ArrayBuffer`
 
-___
+***
 
-### metadata
+### metadata?
 
-• `Optional` **metadata**: `Record`\<`string`, `string`\>
+> `optional` **metadata**: `Record`\<`string`, `string`\>

package/docs/md/interfaces/VideoSourceOptions.md

@@ -1,28 +1,22 @@
-[CameraKit Web SDK - v1.0.1](../README.md) / [Exports](../modules.md) / VideoSourceOptions
+[**CameraKit Web SDK v1.2.0**](../README.md)
+
+***
+
+[CameraKit Web SDK](../globals.md) / VideoSourceOptions
 
 # Interface: VideoSourceOptions
 
 Video source options.
 
-## Hierarchy
+## Extends
 
 - [`CameraKitDeviceOptions`](CameraKitDeviceOptions.md)
 
-  ↳ **`VideoSourceOptions`**
-
-## Table of contents
-
-### Properties
-
-- [cameraType](VideoSourceOptions.md#cameratype)
-- [fpsLimit](VideoSourceOptions.md#fpslimit)
-- [trackingData](VideoSourceOptions.md#trackingdata)
-
 ## 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.
@@ -31,13 +25,13 @@ The default value is "user", which accommodates the majority of Lenses.
 
 #### Inherited from
 
-[CameraKitDeviceOptions](CameraKitDeviceOptions.md).[cameraType](CameraKitDeviceOptions.md#cameratype)
+[`CameraKitDeviceOptions`](CameraKitDeviceOptions.md).[`cameraType`](CameraKitDeviceOptions.md#cameratype)
 
-___
+***
 
 ### 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.
@@ -45,13 +39,13 @@ Useful for controlling resource usage on varying device capabilities.
 
 #### Inherited from
 
-[CameraKitDeviceOptions](CameraKitDeviceOptions.md).[fpsLimit](CameraKitDeviceOptions.md#fpslimit)
+[`CameraKitDeviceOptions`](CameraKitDeviceOptions.md).[`fpsLimit`](CameraKitDeviceOptions.md#fpslimit)
 
-___
+***
 
 ### trackingData
 
-• **trackingData**: `ArrayBuffer`
+> **trackingData**: `ArrayBuffer`
 
 Optional pre-computed tracking data to enhance rendering performance.
 While not commonly provided, this can be used in specific scenarios

package/docs/md/type-aliases/ArgumentValidationError.md

@@ -0,0 +1,11 @@
+[**CameraKit Web SDK v1.2.0**](../README.md)
+
+***
+
+[CameraKit Web SDK](../globals.md) / ArgumentValidationError
+
+# Type Alias: ArgumentValidationError
+
+> **ArgumentValidationError**: `NamedError`\<`"ArgumentValidationError"`\>
+
+Thrown when a method receives an argument with an unexpected value.

package/docs/md/type-aliases/AssetLoader.md

@@ -0,0 +1,26 @@
+[**CameraKit Web SDK v1.2.0**](../README.md)
+
+***
+
+[CameraKit Web SDK](../globals.md) / AssetLoader
+
+# Type Alias: AssetLoader()
+
+> **AssetLoader**: (`request`) => `Promise`\<[`AssetResponse`](AssetResponse.md)\> \| [`AssetResponse`](AssetResponse.md)
+
+An AssetLoader is used to retrieve assets. A separate loader may be defined to retrieve different asset types.
+
+## Parameters
+
+### request
+
+[`LoadAssetRequest`](../interfaces/LoadAssetRequest.md)
+
+The [LoadAssetRequest](../interfaces/LoadAssetRequest.md) detailing the asset to be loaded, its context, and loading priority.
+
+## Returns
+
+`Promise`\<[`AssetResponse`](AssetResponse.md)\> \| [`AssetResponse`](AssetResponse.md)
+
+A promise that resolves to an [AssetResponse](AssetResponse.md) for asynchronous loading,
+or an [AssetResponse](AssetResponse.md) directly for synchronous operations.

package/docs/md/type-aliases/AssetResponse.md

@@ -0,0 +1,9 @@
+[**CameraKit Web SDK v1.2.0**](../README.md)
+
+***
+
+[CameraKit Web SDK](../globals.md) / AssetResponse
+
+# Type Alias: AssetResponse
+
+> **AssetResponse**: `ArrayBuffer` \| \{`data`: `ArrayBuffer`;`checksum`: `string`; \}

package/docs/md/type-aliases/AssetTiming.md

@@ -0,0 +1,18 @@
+[**CameraKit Web SDK v1.2.0**](../README.md)
+
+***
+
+[CameraKit Web SDK](../globals.md) / AssetTiming
+
+# Type Alias: AssetTiming
+
+> **AssetTiming**: `"required"` \| `"onDemand"`
+
+Lens assets are included in a manifest, and each will indicate when that asset will be used by the lens.
+
+Assets can have the following timing values:
+- `required`: the lens will definitely request this asset immediately when the lens is applied.
+- `onDemand`: the lens may request this asset at some time while the lens is applied.
+
+Depending on the use-case, an application may want to cache both required and onDemand assets for
+a particular lens, or may decide to only cache required assets (or cache no assets).