Files & System
Files and paths, processes and shells, the clipboard, storage, serialization, crypto, logging, and TypeScript compilation.
Commonly used
LensStudio:FileSystemBefore using anything in this namespace, make sure to import LensStudio:FileSystem and add filesystem in your plugin's module.json.Editor.PathA path in the filesystem, or Asset Manager.LensStudio:SubprocessBefore using anything in this namespace, make sure to import LensStudio:Subprocess and add subprocess in your plugin's module.json.LensStudio:ShellLensStudio:AppLensStudio:ClipboardModule providing clipboard read/write access for Lens Studio Editor.
Guides
Common TasksBelow are some common tasks you might need to do while creating your plugins.Basic StructuresThe following examples will guide you through the essential steps of plugin creation.Chat Tools DevelopmentThis guide provides instructions for adding Chat Tools to Lens Studio.
All APIs in this topic
Import modules with import * as Ui from 'LensStudio:Ui'.
Components, assets, and modules
| API | Description |
|---|---|
| LensStudio:Analytics | Provides analytics functionality for logging events from within a Lens. |
| LensStudio:App | |
| LensStudio:Clipboard | Module providing clipboard read/write access for Lens Studio Editor. |
| LensStudio:Crypto | Cryptography module providing secure random value generation, UUIDs, and digest operations modeled after the Web Crypto API. |
| LensStudio:FileSystem | Before using anything in this namespace, make sure to import LensStudio:FileSystem and add filesystem in your plugin's module.json. |
| LensStudio:Logger | Module providing log collection and monitoring functionality for Lens Studio plugins. |
| LensStudio:ScopedStorage.js | |
| LensStudio:Serialization | |
| LensStudio:Shell | |
| LensStudio:Subprocess | Before using anything in this namespace, make sure to import LensStudio:Subprocess and add subprocess in your plugin's module.json. |
| LensStudio:SysInfo | Provides system information for Lens Studio. |
| LensStudio:TypeScript | Module exposing the editor TypeScript compilation API for triggering and inspecting project compilations. |
| LensStudio:Uuid | Namespace providing UUID creation and manipulation utilities. |
Objects and data
| API | Description |
|---|---|
| Editor.Buffer | Wraps a byte array for data serialization and deserialization. |
| Editor.Compression | Provides compression and decompression utilities. |
| Editor.Path | A path in the filesystem, or Asset Manager. |
| SecureLocalStorage | Provides encrypted storage for each plugin module's sensitive data, like access tokens. |
Related topics
Project & SceneThe open project and its scene: scene objects, entities, layers, the asset manager, and import and export.AssetsEvery asset type a plugin can create or edit, materials and passes, animation clips, Gaussian splats, and the Asset Library.NetworkingHTTP requests, sockets and servers, WebSockets, and remote services.