@snap/camera-kit 0.7.0

package/docs/md/interfaces/Lens.md

@@ -0,0 +1,84 @@
+[CameraKit Web SDK - v0.7.0-alpha.1](../README.md) / [Exports](../modules.md) / Lens
+
+# Interface: Lens
+
+## Table of contents
+
+### Properties
+
+- [id](Lens.md#id)
+- [name](Lens.md#name)
+- [iconUrl](Lens.md#iconurl)
+- [vendorData](Lens.md#vendordata)
+- [cameraFacingPreference](Lens.md#camerafacingpreference)
+- [preview](Lens.md#preview)
+- [lensCreator](Lens.md#lenscreator)
+
+## Properties
+
+### id
+
+• **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.
+
+___
+
+### name
+
+• **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`
+
+Icon resource URI that represents this lens if available.
+
+___
+
+### vendorData
+
+• **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
+
+▪ [key: `string`]: `string`
+
+___
+
+### cameraFacingPreference
+
+• **cameraFacingPreference**: `Lens_CameraFacing`
+
+Specifies a [Lens_CameraFacing] that this lens is designed for.
+
+___
+
+### preview
+
+• **preview**: `undefined` \| `Preview`
+
+Preview that represents this lens if available.
+
+___
+
+### lensCreator
+
+• **lensCreator**: `undefined` \| `LensCreator`
+
+Information about the lens creator.

package/docs/md/interfaces/LensSource.md

@@ -0,0 +1,68 @@
+[CameraKit Web SDK - v0.7.0-alpha.1](../README.md) / [Exports](../modules.md) / LensSource
+
+# Interface: LensSource
+
+A source of a lens group.
+
+## Table of contents
+
+### Methods
+
+- [isGroupOwner](LensSource.md#isgroupowner)
+- [getLens](LensSource.md#getlens)
+- [getLensGroup](LensSource.md#getlensgroup)
+
+## Methods
+
+### isGroupOwner
+
+▸ **isGroupOwner**(`groupId`): `boolean`
+
+Whether the given source is able to load lenses of the supplied group.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `groupId` | `string` | Group ID to check. |
+
+#### Returns
+
+`boolean`
+
+___
+
+### getLens
+
+▸ **getLens**(`lensId`, `groupId`): `Promise`<`ArrayBuffer`\>
+
+Returns an encoded lens object.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `lensId` | `string` | Lens ID to get. |
+| `groupId` | `string` | Group ID the lens belongs to. |
+
+#### Returns
+
+`Promise`<`ArrayBuffer`\>
+
+___
+
+### getLensGroup
+
+▸ **getLensGroup**(`groupId`): `Promise`<`ArrayBuffer`[]\>
+
+Returns encoded lens objects.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `groupId` | `string` | Group ID to get lenses of. |
+
+#### Returns
+
+`Promise`<`ArrayBuffer`[]\>

package/docs/md/interfaces/MediaStreamSourceOptions.md

@@ -0,0 +1,22 @@
+[CameraKit Web SDK - v0.7.0-alpha.1](../README.md) / [Exports](../modules.md) / MediaStreamSourceOptions
+
+# Interface: MediaStreamSourceOptions
+
+## Table of contents
+
+### Properties
+
+- [transform](MediaStreamSourceOptions.md#transform)
+- [disableSourceAudio](MediaStreamSourceOptions.md#disablesourceaudio)
+
+## Properties
+
+### transform
+
+• **transform**: [`Transform2D`](../classes/Transform2D.md)
+
+___
+
+### disableSourceAudio
+
+• **disableSourceAudio**: `boolean`

package/docs/md/interfaces/UriCancelRequest.md

@@ -0,0 +1,22 @@
+[CameraKit Web SDK - v0.7.0-alpha.1](../README.md) / [Exports](../modules.md) / UriCancelRequest
+
+# Interface: UriCancelRequest
+
+## Table of contents
+
+### Properties
+
+- [uri](UriCancelRequest.md#uri)
+- [requestId](UriCancelRequest.md#requestid)
+
+## Properties
+
+### uri
+
+• **uri**: \`${string}://${string}\`
+
+___
+
+### requestId
+
+• **requestId**: `string`

package/docs/md/interfaces/UriHandler.md

@@ -0,0 +1,63 @@
+[CameraKit Web SDK - v0.7.0-alpha.1](../README.md) / [Exports](../modules.md) / UriHandler
+
+# Interface: UriHandler
+
+Provides a way for a lens to call into external services that work under HTTP-like protocol.
+
+## Table of contents
+
+### Properties
+
+- [uri](UriHandler.md#uri)
+
+### Methods
+
+- [handleRequest](UriHandler.md#handlerequest)
+- [cancelRequest](UriHandler.md#cancelrequest)
+
+## Properties
+
+### uri
+
+• **uri**: \`${string}://${string}\` \| \`${string}://${string}\`[]
+
+[scheme]://[route] pattern that this handler processes or an array of patterns.
+
+## Methods
+
+### handleRequest
+
+▸ **handleRequest**(`request`, `reply`, `lens`): `void`
+
+Called to process the provided request.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `request` | [`UriRequest`](UriRequest.md) | Lens request. |
+| `reply` | (`response`: [`UriResponse`](UriResponse.md)) => `void` | A callback function to send response back. The function can be called none or multiple number of times. |
+| `lens` | [`Lens`](Lens.md) | Lens the request is coming from. |
+
+#### Returns
+
+`void`
+
+___
+
+### cancelRequest
+
+▸ `Optional` **cancelRequest**(`request`, `lens`): `void`
+
+Called to indicated that URI request initated earlier is cancelled.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `request` | [`UriCancelRequest`](UriCancelRequest.md) | Lens request. |
+| `lens` | [`Lens`](Lens.md) | Lens the request is coming from. |
+
+#### Returns
+
+`void`

package/docs/md/interfaces/UriRequest.md

@@ -0,0 +1,43 @@
+[CameraKit Web SDK - v0.7.0-alpha.1](../README.md) / [Exports](../modules.md) / UriRequest
+
+# Interface: UriRequest
+
+## Table of contents
+
+### Properties
+
+- [uri](UriRequest.md#uri)
+- [identifier](UriRequest.md#identifier)
+- [method](UriRequest.md#method)
+- [contentType](UriRequest.md#contenttype)
+- [data](UriRequest.md#data)
+
+## Properties
+
+### uri
+
+• **uri**: \`${string}://${string}\`
+
+___
+
+### identifier
+
+• **identifier**: `string`
+
+___
+
+### method
+
+• **method**: ``"GET"`` \| ``"POST"``
+
+___
+
+### contentType
+
+• **contentType**: `ContentType`
+
+___
+
+### data
+
+• **data**: `ArrayBuffer`

package/docs/md/interfaces/UriResponse.md

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

package/docs/md/interfaces/VideoSourceOptions.md

@@ -0,0 +1,15 @@
+[CameraKit Web SDK - v0.7.0-alpha.1](../README.md) / [Exports](../modules.md) / VideoSourceOptions
+
+# Interface: VideoSourceOptions
+
+## Table of contents
+
+### Properties
+
+- [trackingData](VideoSourceOptions.md#trackingdata)
+
+## Properties
+
+### trackingData
+
+• **trackingData**: `ArrayBuffer`