https://github.com/huggingface/snapchat-lens-api
Type definitions for Snapchat Lenses scripting
https://github.com/huggingface/snapchat-lens-api
snapchat
Last synced: 8 months ago
JSON representation
Type definitions for Snapchat Lenses scripting
- Host: GitHub
- URL: https://github.com/huggingface/snapchat-lens-api
- Owner: huggingface
- Created: 2019-03-20T00:19:08.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-04-15T19:20:38.000Z (about 7 years ago)
- Last Synced: 2025-09-30T18:02:31.271Z (8 months ago)
- Topics: snapchat
- Size: 134 KB
- Stars: 14
- Watchers: 6
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Snapchat Lens API
Snapchat Lenses include a scripting library for creating rich interactive experiences. With scripts, Lenses can respond to touch input, play animation and audio, modify Scene Objects, etc.
Snapchat provides a Javascript interpreter and exposes a number of variables and classes, which are documented in the [official API documentation](https://lensstudio.snapchat.com/api/).
> This type definition builds upon the official API, which it re-packages in a format that's easy to consume by production-grade applications.
### Install using npm
```
npm i snapchat-lens-api
```
If you're using Typescript in your build process, add the following to your `tsconfig.json`:
```
"types": [ "./node_modules/snapchat-lens-api" ]
```
### Feedback
Any feedback? Please open an issue.
