@snap/camera-kit/docs/md/interfaces/Lens.md

Camera Kit Web

[CameraKit Web SDK - v0.22.0](../README.md) / [Exports](../modules.md) / Lens

# Interface: Lens

## Table of contents

### Properties

- [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)

## 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.

___

### groupId

• **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`

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`](../enums/Lens_CameraFacing.md)

Specifies a [Lens_CameraFacing](../enums/Lens_CameraFacing.md) that this lens is designed for.

___

### preview

• **preview**: `undefined` \| [`Preview`](Preview.md)

Preview representing this lens, if available.

___

### lensCreator

• **lensCreator**: `undefined` \| [`LensCreator`](LensCreator.md)

Information about the lens creator.

___

### snapcode

• **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`[]

Metadata pertaining to a specific set of lens features