@snap/camera-kit
Version:
Camera Kit Web
104 lines (54 loc) • 2.01 kB
Markdown
[**CameraKit Web SDK v1.13.0**](../README.md)
***
[](../globals.md) / Lens
> **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**: `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**: `string`
Human readable name of this lens.
NOTE: This value may contain unsafe characters
and therefore may require additional processing depending on usages.
***
> **iconUrl**: `undefined` \| `string`
Icon resource URI that represents this lens if available.
***
> **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.
\[`key`: `string`\]: `string`
***
> **cameraFacingPreference**: [`Lens_CameraFacing`](../enumerations/Lens_CameraFacing.md)
Specifies a [Lens_CameraFacing](../enumerations/Lens_CameraFacing.md) that this lens is designed for.
***
> **preview**: `undefined` \| [`Preview`](Preview.md)
Preview representing this lens, if available.
***
> **lensCreator**: `undefined` \| [`LensCreator`](LensCreator.md)
Information about the lens creator.
***
> **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**: `Any`[]
Metadata pertaining to a specific set of lens features