Skip to main content

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

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

APIDescription
LensStudio:ConnectedLensMonitor
LensStudio:DeviceSettings
LensStudio:DeviceTracing
LensStudio:LensPreviewModule providing LensPreview, a headless preview that renders the open project's Lens without a panel or widgets.
LensStudio:PreviewModule providing preview functionality for Lens Studio.
LensStudio:PreviewSimulator
LensStudio:PushToDevicePlugin component for pushing lens effects and configurations to physical devices.
LensStudio:ShaderCapture
LensStudio:SpkToolkit for packaging and distributing Lens Studio projects.

Editor services

APIDescription
Editor.IRuntimeBundleExporterInterface for exporting an asset, together with the assets it references, as a runtime bundle file.
Editor.RuntimeBundleExporterLens Studio's built-in implementation of Editor.IRuntimeBundleExporter.