Lens Scripting API
    Preparing search index...

    Assets List

    Below is a list of all the classes that is a subclass of Asset.

    Asset Description
    AnimationAsset Represents animation data. Can have multiple AnimationPropertyLayers. Used in AnimationClip.
    AnimationCurveTrack Container for one or more AnimationCurves. Can be sampled to drive attributes (e.g. animation, vfx, code etc.)
    AnimationLayer Configures an animation layer for a single SceneObject.
    Gives access to position, rotation, scale and blend shape animation tracks.
    AnimationTrack Represents the base class for animation tracks.
    AsrModule Allows the Lens to incorporate voice transcription with higher quality than the Built-In.VoiceMlModule
    AudioEffectAsset Configures an audio effect for AudioEffectComponent.
    AudioTrackAsset Represents an audio file asset.
    BinAsset A file based asset.
    BitmojiModule Provides access to functionalities related to Bitmoji avatar.
    Built-In.BluetoothCentralModule BluetoothCentralModule
    BodyTrackingAsset Configures 3D Body Tracking for the ObjectTracking3D component.
    CameraModule Provides access to a specific camera on Spectacles device.
    CameraRollModule Provides an interface to the device’s camera roll and allows users to select multiple media.
    CloudStorageModule Provides access to Cloud Storage capabilities.
    CollisionMesh Defines the physical boundaries of an object for collision detection.
    CommerceKitModule The main entry point for integrating commerce functionalities into a Lens.
    It is typically added as an Asset in a Lens Studio project. This module provides access to the primary method
    for configuring and creating a Built-In.Client
    ConnectedLensModule Enables the creation and management of networked Lens experiences, allowing for real-time communication and interaction between users through Connected Lenses.
    DeepLinkModule The DeepLinkModule brings the concept of deep linking, familiar from mobile platforms like Android and iOS, to Spectacles. This module allows Lenses to send and receive deep link URIs between Spectacles and the Spectacles App.
    DeformingCollisionMesh Used for collision meshes that can change shape or form dynamically.
    DepthModule Provides access to a DepthFrameSession on Spectacles device.
    DeviceTrackingModule The module that allows Device Tracking capabilities in a Lens. Used for managing permissions.
    DialogModule Provides access to Question Answering Service powered by VoiceML.
    ExternalMusicModule Provides an interface to the ExternalMusic feature, and opts the Lens into using the feature when present in the scene.
    FaceTrackingScope The face that a tracker should use. Allows you to to apply the same face index to a group of Components.
    FixedCollisionMesh Used for collision meshes that remain static and do not change their shape over time.
    FloatAnimationTrack The base class for animation tracks using float values.
    FloatAnimationTrackKeyFramed Represents an animation track using float value keyframes.
    FloatBezierAnimationTrackKeyFramed Represents an animation track using vec3 value keyframes for a bezier curve.
    Font A font asset used for rendering text.
    GaussianSplattingAsset Asset that contains Gaussian Splats. Used with GaussianSplattingVisual.
    GestureModule Allows to detect hand gestures using machine learning algorithms.
    GltfAsset Represents a GLTF 3D Model.
    HairDataAsset Hair asset converted from an FBX containing splines to be used with HairVisual.
    HandTracking3DAsset Enables Hand Tracking 3D for the ObjectTracking3D component.
    IntAnimationTrack The base class for animation tracks using integer values.
    IntStepAnimationTrackKeyFramed Represents an animation track using stepped integer value keyframes.
    IntStepNoLerpAnimationTrackKeyFramed Represents an animation track using stepped integer value keyframes.
    InternetModule Provides access to the open internet. Available only on Spectacles and Camera Kit.
    LeaderboardModule Enables usage of Leaderboard API within a Lens.
    LevelsetColliderAsset Collider asset generated from a mesh to be used with the HairVisual as part of the hair simulation.
    LicensedAudioTrackAsset A Licensed Sounds audio track from Asset LIbrary.
    LocalizationsAsset Asset that provides the necessary localized text for your Lens.
    LocationAsset Provides a frame of reference in which to localize objects to the real world. Use with LocatedAtComponent.
    LocationCloudStorageModule Provides access to location cloud storage depending upon the LocationCloudStorageOptions.
    MLAsset Represents a machine learning model that can be integrated with an MLComponent.
    MapModule Allows access to map texture data around a specified location.
    MarkerAsset Represents a texture to be tracked with MarkerTrackingComponent.
    Material An asset that describes how visual objects should appear.
    Matter Settings for the physical substance, such as friction and bounciness, of a collider. If unset, uses the default matter from the world settings.
    MotionControllerModule Provides access to MotionController.
    Object3DAsset Base class for configuring object tracking in the ObjectTracking3D component.
    ObjectPrefab Represents reusable SceneObject hierarchy stored as a resource.
    PersonTrackingScope The person that a tracker should use. Allows you to to apply the same person index to a group of Components. Useful for correlating tracking between Body Tracking and Face Tracking.
    ProcessedLocationModule Declares the precise location tracking permission for your Lens project.
    QuaternionAnimationTrack The base class for animation tracks using quaternion values.
    QuaternionAnimationTrackKeyFramed Represents an animation track using quaternion value keyframes.
    QuaternionAnimationTrackXYZEuler Represents a rotation animation track using euler angles.
    RawLocationModule Declares the coarse location tracking permission for your Lens project.
    RemoteMediaModule Allows the Lens to download and integrate remote media content such as 3D GLTF assets, images, audio tracks, and video textures into Lenses.
    RemoteReferenceAsset Provides a reference to a remote asset (i.e. assets outside of the Lens size limit) that can be downloaded at runtime using script.
    RemoteServiceModule Provides access to Snap authorized remote services.
    RenderMesh Represents a mesh asset.
    ScanModule Provides access to a Scan system that allows users to scan objects, places, and cars with a database of item labels within a Lens.
    ScriptAsset Represents a JavaScript or TypeScript script that can be used to add logic in your Lens.
    SegmentationModel Segmentation model used for SegmentationTextureProvider.
    ShoppingModule Allows the creation of Shopping Lenses with an integrated Product Catalog.
    SpectaclesMobileKitModule SpectaclesMobileKitModule serves as the primary entry point for the Spectacles Mobile Kit, enabling interaction with
    a specific mobile application, such as requesting data or receiving events.

    ⚠️ Best Practice: Only one SpectaclesMobileKitModule should be used per Lens.

    ⚠️ Privacy Note: Using SpectaclesMobileKitModule requires the INTERNET permission. By default, access to sensitive
    data is restricted when a Lens uses internet-connected components. To enable access to both sensitive data and the
    internet simultaneously, certain Experimental APIs must be activated through a feature called Extended Permissions.
    Note that Lenses using Extended Permissions cannot be published.
    SupabaseModule Provides access to Supabase authentication and database capabilities.
    SupabaseProject Represents a Supabase project with configuration details.
    TextInputModule Declares the Input Framework (Text) permission for your Lens project.
    TextToSpeechModule Allows generation of audio from a given text with a variety of options.
    Texture Represents a texture file asset.
    TextureTrackingScope Provides a Texture to do face tracking on for entities like Head, Built-In.FaceStretch
    TrackingScope The scope, such as the texture it should track against, in which a tracker, such as FaceMaskVisual, EyeColorVisual, BodyDepthTextureProvider, should be applied.
    UpperBodyTrackingAsset Configures 3D Upper Body Tracking for the ObjectTracking3D component.
    VFXAsset Defines a VFX to use with VFXComponent.
    Vec2AnimationTrack Represents an animation track using vec2 value keyframes.
    Vec2AnimationTrackKeyFramed Represents an animation track using vec2 value keyframes.
    Vec3AnimationTrack Represents an animation track using vec3 value keyframes.
    Vec3AnimationTrackKeyFramed Represents an animation track using vec3 value keyframes.
    Vec3AnimationTrackXYZ Represents an animation track using vec3 animation tracks.
    Vec4AnimationTrack Represents an animation track using vec4 value keyframes.
    Vec4AnimationTrackKeyFramed Represents an animation track using vec4 value keyframes.
    VoiceMLModule Allows the Lens to incorporate transcription, keyword detection, voice command detection and other NLP based features into Lenses.
    WorldQueryModule Provides access to various APIs which can perform hit test for real surfaces to sample the depth and normal at a certain location.
    Built-In.WorldSettingsAsset WorldSettingsAsset
    WorldUnderstandingModule Declares permissions for your Lens project.

    Settings

    Member Visibility

    On This Page

    Assets List