@snap/camera-kit
Version:
Camera Kit Web
66 lines (34 loc) • 1.02 kB
Markdown
[**CameraKit Web SDK v1.13.0**](../README.md)
***
[CameraKit Web SDK](../globals.md) / LensSource
# Interface: LensSource
Provides Lens metadata for one or more Lens groups.
When a Lens or Lens group is requested via the [LensRepository](../classes/LensRepository.md), CameraKit will find the LensSource which
claims ownership of that group. The appropriate LensSource method will be called and must return an ArrayBuffer
containing the encoded Lens metadata -- this can be obtained from a CameraKit backend API.
## Methods
### isGroupOwner()
> **isGroupOwner**(`groupId`): `boolean`
#### Parameters
##### groupId
`string`
#### Returns
`boolean`
***
### loadLens()
> **loadLens**(`lensId`, `groupId`): `Promise`\<`ArrayBuffer`\>
#### Parameters
##### lensId
`string`
##### groupId
`string`
#### Returns
`Promise`\<`ArrayBuffer`\>
***
### loadLensGroup()
> **loadLensGroup**(`groupId`): `Promise`\<`ArrayBuffer`\>
#### Parameters
##### groupId
`string`
#### Returns
`Promise`\<`ArrayBuffer`\>