@snap/camera-kit 1.0.1 → 1.2.0

package/docs/md/functions/bootstrapCameraKit.md

@@ -0,0 +1,66 @@
+[**CameraKit Web SDK v1.2.0**](../README.md)
+
+***
+
+[CameraKit Web SDK](../globals.md) / bootstrapCameraKit
+
+# Function: bootstrapCameraKit()
+
+> **bootstrapCameraKit**(`configuration`, `provide`?): `Promise`\<[`CameraKit`](../classes/CameraKit.md)\>
+
+Bootstrap CameraKit. This will download the WebAssembly code which powers CameraKit's rendering engine, and return
+an instance of [CameraKit](../classes/CameraKit.md).
+
+CameraKit must be provided with some configuration (the application's API token), and there are some additional
+configurations which are optional.
+
+Descriptions of the available configurations can be found in the documentation for
+[CameraKitBootstrapConfiguration](../interfaces/CameraKitBootstrapConfiguration.md)
+
+---
+
+There is also a second, more advanced way to modify CameraKit to provide greater flexibility to support less common
+use cases.
+
+This requires some knowledge of CameraKit's dependency injection system, and allows applications to provide their
+own custom implementations of certain CameraKit components. This functionality will only be needed by applications
+with very specific, more advanced requirements.
+
+## Parameters
+
+### configuration
+
+[`CameraKitBootstrapConfiguration`](../interfaces/CameraKitBootstrapConfiguration.md)
+
+Configure CameraKit with e.g. credentials, global resource endpoints, etc.
+
+### provide?
+
+(`c`) => [`PublicContainer`](../type-aliases/PublicContainer.md)
+
+Optional function that can make modifications to CameraKit's root DI container.
+
+## Returns
+
+`Promise`\<[`CameraKit`](../classes/CameraKit.md)\>
+
+A [CameraKit](../classes/CameraKit.md) instance, which is the entry point to CameraKit's API.
+
+## Example
+
+```ts
+// The most common way to bootstrap:
+const cameraKit = await bootstrapCameraKit({ apiToken: myApiToken })
+
+// For special advanced use-cases, it is possible to provide custom implementations for certain CameraKit components.
+const cameraKit = await bootstrapCameraKit(config, (container) => {
+  return container.provides(myCustomRemoteMediaAssetLoaderFactory)
+})
+```
+
+## Throws
+
+- [ConfigurationError](../type-aliases/ConfigurationError.md) when provided configuration object is invalid
+ - [PlatformNotSupportedError](../type-aliases/PlatformNotSupportedError.md) when current platform is not supported by CameraKit
+ - [BootstrapError](../type-aliases/BootstrapError.md) when a failure occurs while initializing CameraKit and downloading the render engine
+WebAssembly binary.

package/docs/md/functions/createExtension.md

@@ -0,0 +1,50 @@
+[**CameraKit Web SDK v1.2.0**](../README.md)
+
+***
+
+[CameraKit Web SDK](../globals.md) / createExtension
+
+# Function: createExtension()
+
+> **createExtension**(): `PartialContainer`
+
+Extensions offer a way to provide custom implementations of certain parts of the CameraKit SDK.
+
+This enables more advanced use-cases, in which the default behavior of the SDK is substantially altered. For example,
+replacing the default implementation that loads remote lens assets with a custom implementation that returns
+different assets based on some business logic within the application.
+
+An extension is implemented as a PartialContainer – a collection of factory functions, each with its own
+dependencies, which each provide some "Service". A Service can be of any type, and the CameraKit SDK defines its
+own Services, some of which can be overridden by providing a custom implementation of the type via an extension.
+
+Here's an example of how extensions might be used:
+```ts
+import { bootstrapCameraKit, createExtension, remoteMediaAssetLoaderFactory } from '@snap/camera-kit'
+
+const myCustomRemoteAssetLoader = Injectable(
+  remoteMediaAssetLoaderFactory.token,
+  [remoteMediaAssetLoaderFactory.token] as const,
+  (defaultLoader: AssetLoader): AssetLoader => {
+    return async (asset, lens) => {
+      if (lens?.id === MY_SPECIAL_LENS) {
+        return (await fetch('my/asset.glb')).arrayBuffer()
+      }
+      return defaultLoader(asset, lens)
+    }
+  },
+)
+
+const myExtension = createExtension().provides(myCustomRemoteAssetLoader);
+const cameraKit = bootstrapCameraKit(config, container => container.provides(myExtension));
+```
+
+This also enables greater modularity – the person/team creating the extension can do so in their own package, which
+could be shared by many applications that all require the same functionality.
+
+## Returns
+
+`PartialContainer`
+
+A PartialContainer which can be used to create a collection of Services, and can later be provided
+to CameraKit's DI container during [bootstrapCameraKit](bootstrapCameraKit.md).

package/docs/md/functions/createImageSource.md

@@ -0,0 +1,30 @@
+[**CameraKit Web SDK v1.2.0**](../README.md)
+
+***
+
+[CameraKit Web SDK](../globals.md) / createImageSource
+
+# Function: createImageSource()
+
+> **createImageSource**(`image`, `options`): [`CameraKitSource`](../classes/CameraKitSource.md)
+
+Create a [CameraKitSource](../classes/CameraKitSource.md) from an
+[HTMLImageElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement).
+
+## Parameters
+
+### image
+
+`HTMLImageElement`
+
+Image element.
+
+### options
+
+`Partial`\<[`CameraKitDeviceOptions`](../interfaces/CameraKitDeviceOptions.md)\> = `{}`
+
+Options.
+
+## Returns
+
+[`CameraKitSource`](../classes/CameraKitSource.md)

package/docs/md/functions/createMediaStreamSource.md

@@ -0,0 +1,30 @@
+[**CameraKit Web SDK v1.2.0**](../README.md)
+
+***
+
+[CameraKit Web SDK](../globals.md) / createMediaStreamSource
+
+# Function: createMediaStreamSource()
+
+> **createMediaStreamSource**(`stream`, `options`): [`CameraKitSource`](../classes/CameraKitSource.md)
+
+Create a [CameraKitSource](../classes/CameraKitSource.md) from any
+[MediaStream](https://developer.mozilla.org/en-US/docs/Web/API/MediaStream).
+
+## Parameters
+
+### stream
+
+`MediaStream`
+
+Any MediaStream, such as obtained via `canvas.captureStream()` or `mediaDevices.getUserMedia()`.
+
+### options
+
+`Partial`\<[`MediaStreamSourceOptions`](../interfaces/MediaStreamSourceOptions.md)\> = `{}`
+
+Options.
+
+## Returns
+
+[`CameraKitSource`](../classes/CameraKitSource.md)

package/docs/md/functions/createVideoSource.md

@@ -0,0 +1,31 @@
+[**CameraKit Web SDK v1.2.0**](../README.md)
+
+***
+
+[CameraKit Web SDK](../globals.md) / createVideoSource
+
+# Function: createVideoSource()
+
+> **createVideoSource**(`video`, `options`): [`CameraKitSource`](../classes/CameraKitSource.md)
+
+Create a [CameraKitSource](../classes/CameraKitSource.md) from an
+[HTMLVideoElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLVideoElement).
+
+## Parameters
+
+### video
+
+`HTMLVideoElement`
+
+CameraKit performs best when the source video is 720p – arbitrary resolutions are supported, but very
+high resolutions may not perform well.
+
+### options
+
+`Partial`\<[`VideoSourceOptions`](../interfaces/VideoSourceOptions.md)\> = `{}`
+
+Options.
+
+## Returns
+
+[`CameraKitSource`](../classes/CameraKitSource.md)

package/docs/md/functions/estimateLensPerformance.md

@@ -0,0 +1,18 @@
+[**CameraKit Web SDK v1.2.0**](../README.md)
+
+***
+
+[CameraKit Web SDK](../globals.md) / estimateLensPerformance
+
+# Function: estimateLensPerformance()
+
+> **estimateLensPerformance**(): `Promise`\<[`EstimatedLensPerformance`](../interfaces/EstimatedLensPerformance.md)\>
+
+Run benchmarks which attempt to predict expected lens performance, and assign a cluster (i.e. a performance rating)
+which the CameraKit SDK can use to optimize certain lenses.
+
+## Returns
+
+`Promise`\<[`EstimatedLensPerformance`](../interfaces/EstimatedLensPerformance.md)\>
+
+A rating from 1-6, indicating expected Lens performance.

package/docs/md/functions/filePickerFactory.md

@@ -0,0 +1,22 @@
+[**CameraKit Web SDK v1.2.0**](../README.md)
+
+***
+
+[CameraKit Web SDK](../globals.md) / filePickerFactory
+
+# Function: filePickerFactory()
+
+> **filePickerFactory**(...`args`): [`FilePicker`](../type-aliases/FilePicker.md)
+
+Default file picker factory function. The file picker is triggered when a lens issues a file request.
+Client applications can override this factory function to provide their custom file picker.
+
+## Parameters
+
+### args
+
+...[]
+
+## Returns
+
+[`FilePicker`](../type-aliases/FilePicker.md)

package/docs/md/functions/getExtensionRequestContext.md

@@ -0,0 +1,21 @@
+[**CameraKit Web SDK v1.2.0**](../README.md)
+
+***
+
+[CameraKit Web SDK](../globals.md) / getExtensionRequestContext
+
+# Function: getExtensionRequestContext()
+
+> **getExtensionRequestContext**(...`args`): `ArrayBuffer`
+
+Returns extension request context.
+
+## Parameters
+
+### args
+
+...[]
+
+## Returns
+
+`ArrayBuffer`

package/docs/md/functions/lensSourcesFactory.md

@@ -0,0 +1,37 @@
+[**CameraKit Web SDK v1.2.0**](../README.md)
+
+***
+
+[CameraKit Web SDK](../globals.md) / lensSourcesFactory
+
+# Function: lensSourcesFactory()
+
+> **lensSourcesFactory**(...`args`): [`LensSource`](../interfaces/LensSource.md)[]
+
+By default, no custom [LensSource](../interfaces/LensSource.md) is provided to CameraKit. But to enable certain advanced use-cases,
+applications may provide their own [LensSource](../interfaces/LensSource.md).
+
+Perhaps the most convenient way to do this is with ConcatInjectable, as shown here:
+
+## Parameters
+
+### args
+
+...[]
+
+## Returns
+
+[`LensSource`](../interfaces/LensSource.md)[]
+
+## Example
+
+```ts
+import { bootstrapCameraKit, lensSourcesFactory, LensSource } from '@snap/camera-kit'
+
+const cameraKit = bootstrapCameraKit(config, (container) => {
+  return container.provides(ConcatInjectable(
+    lensSourcesFactory.token,
+    (): LensSource => { return ... }
+  ))
+})
+```

package/docs/md/functions/remoteApiServicesFactory.md

@@ -0,0 +1,19 @@
+[**CameraKit Web SDK v1.2.0**](../README.md)
+
+***
+
+[CameraKit Web SDK](../globals.md) / remoteApiServicesFactory
+
+# Function: remoteApiServicesFactory()
+
+> **remoteApiServicesFactory**(...`args`): [`RemoteApiServices`](../type-aliases/RemoteApiServices.md)
+
+## Parameters
+
+### args
+
+...[]
+
+## Returns
+
+[`RemoteApiServices`](../type-aliases/RemoteApiServices.md)

package/docs/md/globals.md

@@ -0,0 +1,124 @@
+[**CameraKit Web SDK v1.2.0**](README.md)
+
+***
+
+# CameraKit Web SDK v1.2.0
+
+## Bootstrapping and Configuration
+
+- [EstimatedLensPerformance](interfaces/EstimatedLensPerformance.md)
+- [CameraKitBootstrapConfiguration](interfaces/CameraKitBootstrapConfiguration.md)
+- [LensPerformanceCluster](type-aliases/LensPerformanceCluster.md)
+- [PublicContainer](type-aliases/PublicContainer.md)
+- [ConfigurationError](type-aliases/ConfigurationError.md)
+- [PlatformNotSupportedError](type-aliases/PlatformNotSupportedError.md)
+- [BootstrapError](type-aliases/BootstrapError.md)
+- [estimateLensPerformance](functions/estimateLensPerformance.md)
+- [bootstrapCameraKit](functions/bootstrapCameraKit.md)
+- [createExtension](functions/createExtension.md)
+
+## Lenses
+
+- [CameraKit](classes/CameraKit.md)
+- [LensRepository](classes/LensRepository.md)
+- [CameraKitSession](classes/CameraKitSession.md)
+- [Lens](interfaces/Lens.md)
+- [LensLaunchData](interfaces/LensLaunchData.md)
+- [LoadAssetRequest](interfaces/LoadAssetRequest.md)
+- [Keyboard](interfaces/Keyboard.md)
+- [LensMetricsEvents](type-aliases/LensMetricsEvents.md)
+- [AssetTiming](type-aliases/AssetTiming.md)
+- [AssetLoader](type-aliases/AssetLoader.md)
+- [LensView](type-aliases/LensView.md)
+- [LensWait](type-aliases/LensWait.md)
+- [RenderTarget](type-aliases/RenderTarget.md)
+- [CameraKitSessionEvents](type-aliases/CameraKitSessionEvents.md)
+
+## Metrics
+
+- [LensPerformanceMeasurement](classes/LensPerformanceMeasurement.md)
+- [LensPerformanceMetrics](classes/LensPerformanceMetrics.md)
+- [ComputedFrameMetrics](interfaces/ComputedFrameMetrics.md)
+- [LensMetricsEvents](type-aliases/LensMetricsEvents.md)
+- [LensView](type-aliases/LensView.md)
+- [LensWait](type-aliases/LensWait.md)
+
+## Other
+
+- [Lens\_CameraFacing](enumerations/Lens_CameraFacing.md)
+- [TypedCustomEvent](classes/TypedCustomEvent.md)
+- [TypedEventTarget](classes/TypedEventTarget.md)
+- [Font](interfaces/Font.md)
+- [LensHttpRequest](interfaces/LensHttpRequest.md)
+- [UriRequest](interfaces/UriRequest.md)
+- [UriResponse](interfaces/UriResponse.md)
+- [UriCancelRequest](interfaces/UriCancelRequest.md)
+- [LensCreator](interfaces/LensCreator.md)
+- [Preview](interfaces/Preview.md)
+- [Snapcode](interfaces/Snapcode.md)
+- [LensUserData](interfaces/LensUserData.md)
+- [BitmojiUserInfo](interfaces/BitmojiUserInfo.md)
+- [FriendUserInfo](interfaces/FriendUserInfo.md)
+- [LensSource](interfaces/LensSource.md)
+- [FunctionSourceOptions](interfaces/FunctionSourceOptions.md)
+- [KeyboardActiveEvent](interfaces/KeyboardActiveEvent.md)
+- [RemoteApiRequest](interfaces/RemoteApiRequest.md)
+- [RemoteApiResponse](interfaces/RemoteApiResponse.md)
+- [RemoteApiService](interfaces/RemoteApiService.md)
+- [PublicServices](type-aliases/PublicServices.md)
+- [LensHttpHandler](type-aliases/LensHttpHandler.md)
+- [FetchHandler](type-aliases/FetchHandler.md)
+- [FilePickerOptions](type-aliases/FilePickerOptions.md)
+- [FilePickerResult](type-aliases/FilePickerResult.md)
+- [FilePicker](type-aliases/FilePicker.md)
+- [Uri](type-aliases/Uri.md)
+- [LensLaunchParams](type-aliases/LensLaunchParams.md)
+- [Zodiac](type-aliases/Zodiac.md)
+- [AssetResponse](type-aliases/AssetResponse.md)
+- [LegalError](type-aliases/LegalError.md)
+- [LensContentValidationError](type-aliases/LensContentValidationError.md)
+- [LensError](type-aliases/LensError.md)
+- [CameraKitSourceError](type-aliases/CameraKitSourceError.md)
+- [LensImagePickerError](type-aliases/LensImagePickerError.md)
+- [CacheKeyNotFoundError](type-aliases/CacheKeyNotFoundError.md)
+- [WebGLError](type-aliases/WebGLError.md)
+- [BenchmarkError](type-aliases/BenchmarkError.md)
+- [LensExecutionError](type-aliases/LensExecutionError.md)
+- [LensAbortError](type-aliases/LensAbortError.md)
+- [PersistentStoreError](type-aliases/PersistentStoreError.md)
+- [LensAssetError](type-aliases/LensAssetError.md)
+- [ArgumentValidationError](type-aliases/ArgumentValidationError.md)
+- [CameraKitSessionEventListener](type-aliases/CameraKitSessionEventListener.md)
+- [KeyboardEvents](type-aliases/KeyboardEvents.md)
+- [KeyboardEventListener](type-aliases/KeyboardEventListener.md)
+- [Matrix](type-aliases/Matrix.md)
+- [RemoteApiStatus](type-aliases/RemoteApiStatus.md)
+- [RemoteApiCancelRequestHandler](type-aliases/RemoteApiCancelRequestHandler.md)
+- [RemoteApiRequestHandler](type-aliases/RemoteApiRequestHandler.md)
+- [RemoteApiServices](type-aliases/RemoteApiServices.md)
+- [extensionRequestContext](variables/extensionRequestContext.md)
+- [getExtensionRequestContext](functions/getExtensionRequestContext.md)
+- [filePickerFactory](functions/filePickerFactory.md)
+- [lensSourcesFactory](functions/lensSourcesFactory.md)
+- [remoteApiServicesFactory](functions/remoteApiServicesFactory.md)
+
+## Rendering
+
+- [CameraKit](classes/CameraKit.md)
+- [CameraKitSource](classes/CameraKitSource.md)
+- [CameraKitSession](classes/CameraKitSession.md)
+- [LensPerformanceMeasurement](classes/LensPerformanceMeasurement.md)
+- [LensPerformanceMetrics](classes/LensPerformanceMetrics.md)
+- [Transform2D](classes/Transform2D.md)
+- [CreateSessionOptions](interfaces/CreateSessionOptions.md)
+- [CameraKitSourceSubscriber](interfaces/CameraKitSourceSubscriber.md)
+- [CameraKitDeviceOptions](interfaces/CameraKitDeviceOptions.md)
+- [CameraKitSourceInfo](interfaces/CameraKitSourceInfo.md)
+- [MediaStreamSourceOptions](interfaces/MediaStreamSourceOptions.md)
+- [VideoSourceOptions](interfaces/VideoSourceOptions.md)
+- [ComputedFrameMetrics](interfaces/ComputedFrameMetrics.md)
+- [RenderTarget](type-aliases/RenderTarget.md)
+- [CameraKitSessionEvents](type-aliases/CameraKitSessionEvents.md)
+- [createImageSource](functions/createImageSource.md)
+- [createMediaStreamSource](functions/createMediaStreamSource.md)
+- [createVideoSource](functions/createVideoSource.md)

package/docs/md/interfaces/BitmojiUserInfo.md

@@ -1,22 +1,19 @@
-[CameraKit Web SDK - v1.0.1](../README.md) / [Exports](../modules.md) / BitmojiUserInfo
+[**CameraKit Web SDK v1.2.0**](../README.md)
 
-# Interface: BitmojiUserInfo
-
-## Table of contents
+***
 
-### Properties
+[CameraKit Web SDK](../globals.md) / BitmojiUserInfo
 
-- [avatarId](BitmojiUserInfo.md#avatarid)
-- [selfieId](BitmojiUserInfo.md#selfieid)
+# Interface: BitmojiUserInfo
 
 ## Properties
 
-### avatarId
+### avatarId?
 
-• `Optional` **avatarId**: `string`
+> `optional` **avatarId**: `string`
 
-___
+***
 
-### selfieId
+### selfieId?
 
-• `Optional` **selfieId**: `string`
+> `optional` **selfieId**: `string`