Preview & Publishing
The Preview panel and offscreen Lens previews, pushing a Lens to a device, device traces, Connected Lens sessions, and packaging projects and runtime bundles.
Commonly used
LensStudio:PreviewModule providing preview functionality for Lens Studio.LensStudio:PushToDevicePlugin component for pushing lens effects and configurations to physical devices.
All APIs in this topic
Get editor services with this.pluginSystem.findInterface(Editor.Model.IModel) and import modules with import * as Ui from 'LensStudio:Ui'.
Components, assets, and modules
| API | Description |
|---|---|
| LensStudio:ConnectedLensMonitor | |
| LensStudio:DeviceSettings | |
| LensStudio:DeviceTracing | |
| LensStudio:LensPreview | Module providing LensPreview, a headless preview that renders the open project's Lens without a panel or widgets. |
| LensStudio:Preview | Module providing preview functionality for Lens Studio. |
| LensStudio:PreviewSimulator | |
| LensStudio:PushToDevice | Plugin component for pushing lens effects and configurations to physical devices. |
| LensStudio:ShaderCapture | |
| LensStudio:Spk | Toolkit for packaging and distributing Lens Studio projects. |
Editor services
| API | Description |
|---|---|
| Editor.IRuntimeBundleExporter | Interface for exporting an asset, together with the assets it references, as a runtime bundle file. |
| Editor.RuntimeBundleExporter | Lens Studio's built-in implementation of Editor.IRuntimeBundleExporter. |