@snap/camera-kit
Version:
Camera Kit Web
56 lines (32 loc) • 1.44 kB
Markdown
[CameraKit Web SDK - v0.22.0](../README.md) / [Exports](../modules.md) / CameraKitSourceSubscriber
# Interface: CameraKitSourceSubscriber
When creating a [CameraKitSource](../classes/CameraKitSource.md), passing a CameraKitSourceSubscriber allows logic to implemented which will
run whenever that source is attached/detached from a CameraKitSession.
## Table of contents
### Properties
- [onAttach](CameraKitSourceSubscriber.md#onattach)
- [onDetach](CameraKitSourceSubscriber.md#ondetach)
## Properties
### onAttach
• `Optional` `Readonly` **onAttach**: (`source`: [`CameraKitSource`](../classes/CameraKitSource.md), `lensCore`: `LensCore`, `reportError`: (`error`: `Error`) => `void`) => `void` \| `Promise`\<`void`\>
#### Type declaration
▸ (`source`, `lensCore`, `reportError`): `void` \| `Promise`\<`void`\>
##### Parameters
| Name | Type |
| :------ | :------ |
| `source` | [`CameraKitSource`](../classes/CameraKitSource.md) |
| `lensCore` | `LensCore` |
| `reportError` | (`error`: `Error`) => `void` |
##### Returns
`void` \| `Promise`\<`void`\>
___
### onDetach
• `Optional` `Readonly` **onDetach**: (`reportError`: (`error`: `Error`) => `void`) => `void` \| `Promise`\<`void`\>
#### Type declaration
▸ (`reportError`): `void` \| `Promise`\<`void`\>
##### Parameters
| Name | Type |
| :------ | :------ |
| `reportError` | (`error`: `Error`) => `void` |
##### Returns
`void` \| `Promise`\<`void`\>