Skip to main content

Script Objects

Script Objects represent script data.

Anchor​

An object containing the position of an object relative to a LocationAsset.

Lens Studio v4.19.0+
Scripting Name: Anchor
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

AnimationMixerLayer​

Controls animation playback for a single animation layer. See also: AnimationMixer.

Lens Studio v1.0.0+
Scripting Name: AnimationMixerLayer
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

BackgroundSettings​

Settings for rendering the background on a Text component. Accessible through the Text component's backgroundSettings property.

Lens Studio v2.1+
Scripting Name: BackgroundSettings
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

BaseMultiplayerSessionOptions​

Base class for MultiplayerSession options. This class is not used directly - use ConnectedLensSessionOptions instead.

Lens Studio v4.0+
Scripting Name: BaseMultiplayerSessionOptions
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

BasePlaceholder​

Base class for Input and Output Placeholders used by MLComponent.

Lens Studio v3.0+
Scripting Name: BasePlaceholder
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

BasicTransform​

Provides basic information about a transformation. See also: DeviceTracking

Lens Studio v2.2+
Scripting Name: BasicTransform
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

Bitmoji3DResource​

Provides information about the current user's 3D Bitmoji avatar to be downloaded via the RemoteMediaModule.

Lens Studio v4.22.0+
Scripting Name: Bitmoji3DResource
Inherits from DynamicResource

This is the API for Lens Studio 4. For the latest API documentation, click here.

BoxShape​

A box collision shape.

Lens Studio v4.4+
Scripting Name: BoxShape
Inherits from Shape

This is the API for Lens Studio 4. For the latest API documentation, click here.

Camera.BaseRenderTarget​

The base class from which ColorRenderTarget and DepthStencilRenderTarget are derived from

Lens Studio v3.4+
Scripting Name: BaseRenderTarget
Inherits from ScriptObject
Outer Classes: Camera

This is the API for Lens Studio 4. For the latest API documentation, click here.

Camera.ColorRenderTarget​

Color based RenderTarget.

Lens Studio v3.4+
Scripting Name: ColorRenderTarget
Outer Classes: Camera

This is the API for Lens Studio 4. For the latest API documentation, click here.

Camera.DepthStencilRenderTarget​

This class inherits from the BaseRenderTarget class. BaseRenderTarget class is not available for creation and is used like the base class for DepthStencilRenderTarget class to provide access to targetTexture, inputTexture and maskTexture properties.

Lens Studio v4.1+
Scripting Name: DepthStencilRenderTarget
Outer Classes: Camera

This is the API for Lens Studio 4. For the latest API documentation, click here.

CapsuleShape​

A capsule collision shape. Also known as a capped cylinder.

Lens Studio v4.4+
Scripting Name: CapsuleShape
Inherits from Shape

This is the API for Lens Studio 4. For the latest API documentation, click here.

CloudStorageListOptions​

Options associated with the listValues method call.

Lens Studio v4.19.0+
Scripting Name: CloudStorageListOptions
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

CloudStorageOptions​

Used to configure Cloud Storage Module with various options. Note: if session scoped storage is required, this option must be provided.

Lens Studio v4.19.0+
Scripting Name: CloudStorageOptions
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

CloudStorageReadOptions​

Options associated with the getValue/deleteValue methods for Cloud Storage.

Lens Studio v4.19.0+
Scripting Name: CloudStorageReadOptions
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

CloudStorageWriteOptions​

Options associated with the setValue method for Cloud Storage.

Lens Studio v4.19.0+
Scripting Name: CloudStorageWriteOptions
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

CloudStore​

An instance of Cloud Storage that can store data in a multiplayer experience.

Lens Studio v4.19.0+
Scripting Name: CloudStore
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

Collision​

A state generated for ColliderComponent collision events.

Lens Studio v4.10.0+
Scripting Name: Physics.Collision
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

CollisionEnterEventArgs​

Args used for ColliderComponent.onCollisionEnter, which is triggered when a collision begins.

Lens Studio v4.10.0+
Scripting Name: Physics.CollisionEnterEventArgs
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

CollisionExitEventArgs​

Args used for ColliderComponent.onCollisionExit, which is triggered when a collision ends.

Lens Studio v4.10.0+
Scripting Name: Physics.CollisionExitEventArgs
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

CollisionStayEventArgs​

Args used for ColliderComponent.onCollisionStay, which is triggered every frame while a collision continues.

Lens Studio v4.10.0+
Scripting Name: Physics.CollisionStayEventArgs
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

ConeShape​

A cone collision shape.

Lens Studio v4.13.0+
Scripting Name: ConeShape
Inherits from Shape

This is the API for Lens Studio 4. For the latest API documentation, click here.

ConnectedLensModule.ConnectionInfo​

Information that is bootstrapped to the user who just connected to the session.

Lens Studio v4.25.0+
Scripting Name: ConnectionInfo
Inherits from ScriptObject
Outer Classes: ConnectedLensModule

This is the API for Lens Studio 4. For the latest API documentation, click here.

ConnectedLensModule.HostUpdateInfo​

Information about the host update.

Lens Studio v4.31.0+
Scripting Name: HostUpdateInfo
Inherits from ScriptObject
Outer Classes: ConnectedLensModule

This is the API for Lens Studio 4. For the latest API documentation, click here.

ConnectedLensModule.RealtimeStoreCreationInfo​

Provides extra context about a RealtimeStore's creation.

Lens Studio v4.28.0+
Scripting Name: RealtimeStoreCreationInfo
Inherits from ScriptObject
Outer Classes: ConnectedLensModule

This is the API for Lens Studio 4. For the latest API documentation, click here.

ConnectedLensModule.RealtimeStoreDeleteInfo​

Gives information about the Realtime Store delete operation.

Lens Studio v4.25.0+
Scripting Name: RealtimeStoreDeleteInfo
Inherits from ScriptObject
Outer Classes: ConnectedLensModule

This is the API for Lens Studio 4. For the latest API documentation, click here.

ConnectedLensModule.RealtimeStoreKeyRemovalInfo​

Provides information about a key being removed from a RealtimeStore.

Lens Studio v4.28.0+
Scripting Name: RealtimeStoreKeyRemovalInfo
Inherits from ScriptObject
Outer Classes: ConnectedLensModule

This is the API for Lens Studio 4. For the latest API documentation, click here.

ConnectedLensModule.RealtimeStoreOwnershipUpdateInfo​

Provides information about a RealtimeStore's ownership being updated.

Lens Studio v4.28.0+
Scripting Name: RealtimeStoreOwnershipUpdateInfo
Inherits from ScriptObject
Outer Classes: ConnectedLensModule

This is the API for Lens Studio 4. For the latest API documentation, click here.

ConnectedLensModule.RealtimeStoreUpdateInfo​

Gives information about the Realtime Store update operation.

Lens Studio v4.25.0+
Scripting Name: RealtimeStoreUpdateInfo
Inherits from ScriptObject
Outer Classes: ConnectedLensModule

This is the API for Lens Studio 4. For the latest API documentation, click here.

ConnectedLensModule.UserInfo​

Provides information about a user in a Connected Lens session.

Lens Studio v4.0+
Scripting Name: UserInfo
Inherits from ScriptObject
Outer Classes: ConnectedLensModule

This is the API for Lens Studio 4. For the latest API documentation, click here.

ConnectedLensSessionOptions​

Settings for configuring a Connected Lens session.

Lens Studio v4.0+
Scripting Name: ConnectedLensSessionOptions

This is the API for Lens Studio 4. For the latest API documentation, click here.

Constraint​

Constraints body motion in configurable ways, for simulating physical objects such as joints and hinges.

Lens Studio v4.10.0+
Scripting Name: Physics.Constraint
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

Contact​

Contact point between two colliding objects. See also: ColliderComponent, CollisionEnterEventArgs, CollisionExitEventArgs, CollisionStayEventArgs.

Lens Studio v4.10.0+
Scripting Name: Physics.Contact
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

CylinderShape​

A cylinder collision shape.

Lens Studio v4.13.0+
Scripting Name: CylinderShape
Inherits from Shape

This is the API for Lens Studio 4. For the latest API documentation, click here.

Delay​

Creates a buffer for the audio data.

Lens Studio v3.4+
Scripting Name: Delay
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

DelayBuilder​

Builder class for the Delay.

Lens Studio v3.4+
Scripting Name: DelayBuilder
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

Delta​

Local estimate of the derivative of the input data along the selected axis. Outputs the derivative of the input features along the window.

Lens Studio v3.4+
Scripting Name: Delta
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

DeltaBuilder​

Builder class for Delta.

Lens Studio v3.4+
Scripting Name: DeltaBuilder
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

DeviceCamera​

Provides information about the device's camera.

Lens Studio v4.0+
Scripting Name: DeviceCamera
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

DeviceInfoSystem​

Provides information about the device running the Lens. Accessible through global.deviceInfoSystem.

Lens Studio v4.0+
Scripting Name: DeviceInfoSystem
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

Dialog.Answer​

Provides answer information in response to DialogModule.askQuestions().

Lens Studio v4.28.0+
Scripting Name: Answer
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

DirectMultiplayerSessionOptions​

Lens Studio v4.0+
Scripting Name: DirectMultiplayerSessionOptions

This is the API for Lens Studio 4. For the latest API documentation, click here.

DirectivityEffect​

An Audio Component effect that simulates sound attenuation based on the orientation of the transform relative to the AudioListenerComponent.

Lens Studio v4.0+
Scripting Name: DirectivityEffect
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

DistanceEffect​

An audio effect that simulates sound attenuation based on the distance between the Audio and the AudioListenerComponent.

Lens Studio v4.0+
Scripting Name: DistanceEffect
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

DropshadowSettings​

Used in Text's dropShadowSettings property. Configures how dropshadow will appear on a Text component.

Lens Studio v2.0.0+
Scripting Name: DropshadowSettings
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

DynamicResource​

A resource that is resolved at runtime.

Lens Studio v4.22.0+
Scripting Name: DynamicResource
Inherits from ScriptObject
Child Classes: Bitmoji3DResource

This is the API for Lens Studio 4. For the latest API documentation, click here.

EventRegistration​

Lens Studio v4.0+
Scripting Name: EventRegistration
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

Filter​

Intersection filter settings. Unifies settings for world probes and collider overlap tests. See also: ColliderComponent, Physics.

Lens Studio v4.10.0+
Scripting Name: Physics.Filter
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

FixedConstraint​

Fully constrain rotation and translation. See also: ConstraintComponent.

Lens Studio v4.10.0+
Scripting Name: Physics.FixedConstraint
Inherits from Constraint

This is the API for Lens Studio 4. For the latest API documentation, click here.

FocusEndEventArgs​

Arguments used with the InteractionComponent.onFocusEnd event.

Lens Studio v4.0+
Scripting Name: FocusEndEventArgs
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

FocusStartEventArgs​

Arguments used with the InteractionComponent.onFocusStart event.

Lens Studio v4.0+
Scripting Name: FocusStartEventArgs
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

GeneralDataStore​

Class for storing and retrieving data based on keys. Used by PersistentStorageSystem. For more information, see the Persistent Storage guide.

Lens Studio v2.0.0+
Scripting Name: GeneralDataStore
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

GltfSettings​

Settings for importing a glTF Asset. Use this with GltfAsset component's tryInstantiateWithSetting method.

Lens Studio v4.31.0+
Scripting Name: GltfSettings
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

HandSpecificData​

Provides additional data for the tracked hand. You can figure out whether the tracked hand is the left hand by accessing the isLeft property [true/false], as well as the probability of this data through the isLeftProbability property [0-1].

Lens Studio v4.0+
Scripting Name: HandSpecificData
Inherits from ObjectSpecificData

This is the API for Lens Studio 4. For the latest API documentation, click here.

HingeConstraint​

Constraints translation and a single axis of rotation. See also: ConstraintComponent.

Lens Studio v4.10.0+
Scripting Name: Physics.HingeConstraint
Inherits from Constraint

This is the API for Lens Studio 4. For the latest API documentation, click here.

InputBuilder​

Builds InputPlaceHolders for MLComponent.

Lens Studio v3.0+
Scripting Name: InputBuilder
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

InputPlaceholder​

Controls input data for a neural network used by an MLComponent. For more information, see the MLComponent Scripting guide.

Lens Studio v3.0+
Scripting Name: InputPlaceholder
Inherits from BasePlaceholder

This is the API for Lens Studio 4. For the latest API documentation, click here.

LevelsetShape​

A levelset collision shape. A levelset is an asset that is generated to approximate a mesh.

Lens Studio v4.4+
Scripting Name: LevelsetShape
Inherits from Shape

This is the API for Lens Studio 4. For the latest API documentation, click here.

LocalizationSystem​

Helps convert data types to localized string representations. Accessible through global.localizationSystem.

Note that formatted or localized strings may appear differently to users depending on their region. The example results given here are representative of a user in the United States, but may appear differently for users in other regions.

Lens Studio v2.0.0+
Scripting Name: LocalizationSystem
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

LocationCloudStorageOptions​

Used to configure LocationCloudStorage module with various options.

Lens Studio v4.28.0+
Scripting Name: LocationCloudStorageOptions
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

LocationCloudStore​

Instance of location cloud store which has similar interfaces as cloud store.

Lens Studio v4.28.0+
Scripting Name: LocationCloudStore
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

MFCC​

Mel-frequency cepstral coefficients.

Lens Studio v3.4+
Scripting Name: MFCC
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

MFCCBuilder​

Builder class for the MFCC (Mel Frequency Cepstral Co-efficients).

Lens Studio v3.4+
Scripting Name: MFCCBuilder
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

ManipulateEndEventArgs​

Arguments used with the ManipulateComponent.onManipulateEnd event.

Lens Studio v4.0+
Scripting Name: ManipulateEndEventArgs
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

ManipulateStartEventArgs​

Arguments used with the ManipulateComponent.onManipulateStart event.

Lens Studio v4.0+
Scripting Name: ManipulateStartEventArgs
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

MelSpectrogram​

Computes a mel scale spectrogram - a spectrogram where the frequencies are converted to the mel scale.

Lens Studio v3.4+
Scripting Name: MelSpectrogram
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

MelSpectrogramBuilder​

A builder class for MelSpectrogram.

Lens Studio v3.4+
Scripting Name: MelSpectrogramBuilder
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

MeshShape​

Allows meshes to be used as collision shapes, for ColliderComponent and BodyComponent.

Lens Studio v4.28.0+
Scripting Name: MeshShape
Inherits from Shape

This is the API for Lens Studio 4. For the latest API documentation, click here.

MultiplayerSession​

An instance of a Connected Lens session among a group of participants who were successfully invited into the experience.

Lens Studio v4.0+
Scripting Name: MultiplayerSession
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

NoiseReduction​

Lens Studio v4.12.0+
Scripting Name: NoiseReduction
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

NoiseReductionBuilder​

Lens Studio v4.12.0+
Scripting Name: NoiseReductionBuilder
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

ObjectSpecificData​

Provides additional data for the tracked object. For example, with hand tracking, you can figure out whether the tracked hand is the left hand by accessing the isLeft property [true/false], as well as the probability of this data through the isLeftProbability property [0-1].

Lens Studio v4.0+
Scripting Name: ObjectSpecificData
Inherits from ScriptObject
Child Classes: HandSpecificData

This is the API for Lens Studio 4. For the latest API documentation, click here.

OutlineSettings​

Used in Text's outlineSettings property. Configures how text outlining will appear on a Text component.

Lens Studio v2.0.0+
Scripting Name: OutlineSettings
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

OutputBuilder​

Builds OutputPlaceholders for MLComponent.

Lens Studio v3.0+
Scripting Name: OutputBuilder
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

OutputPlaceholder​

Provides output data from the neural network used by an MLComponent. For more information, see the MLComponent Scripting guide.

Lens Studio v3.0+
Scripting Name: OutputPlaceholder
Inherits from BasePlaceholder

This is the API for Lens Studio 4. For the latest API documentation, click here.

Overlap​

Exposes state generated for ColliderComponent overlap events. See also: ColliderComponent, OverlapEnterEventArgs, OverlapExitEventArgs, OverlapStayEventArgs.

Lens Studio v4.10.0+
Scripting Name: Physics.Overlap
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

OverlapEnterEventArgs​

Args used for ColliderComponent.onOverlapEnter, which is triggered when the collider begins overlapping another object. Typically used for volume triggers.

Lens Studio v4.10.0+
Scripting Name: Physics.OverlapEnterEventArgs
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

OverlapExitEventArgs​

Args used for ColliderComponent.onOverlapEnd, which is triggered when the collider stops overlapping another object. Typically used for volume triggers.

Lens Studio v4.10.0+
Scripting Name: Physics.OverlapExitEventArgs
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

OverlapStayEventArgs​

Args used for ColliderComponent.onOverlapStay, which is triggered every frame while the collider continues overlapping another object. Typically used for volume triggers.

Lens Studio v4.10.0+
Scripting Name: Physics.OverlapStayEventArgs
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

Pass​

Controls properties for the VFXAsset. Accessible through VFXAsset.properties. Any scriptable properties on a VFX Graph will automatically become properties of this Properties class. For example, if the VFX Graph defines a variable named baseColor, a script would be able to access that property as vfxAsset.properties.baseColor.

Lens Studio v1.0.0+
Scripting Name: Asset.Pass
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

PassWrapper​

Similar to Pass, except used by VFX Assets.

Lens Studio v4.0+
Scripting Name: PassWrapper
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

PassWrappers​

Allows for retrieval of a collection of Pass objects used by VFXAsset

Lens Studio v4.0+
Scripting Name: PassWrappers
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

PersistentStorageSystem​

Allows data to be stored and retrieved between Lens sessions. In other words, data can be saved on device and loaded back in the next time the Lens is opened. Can be accessed with global.persistentStorageSystem.

See the Persistent Storage guide for more information.

Lens Studio v2.0.0+
Scripting Name: PersistentStorageSystem
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

PitchShifter​

Lens Studio v4.12.0+
Scripting Name: PitchShifter
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

PitchShifterBuilder​

Lens Studio v4.12.0+
Scripting Name: PitchShifterBuilder
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

PointCloud​

Represents 3D locations of stationary features in the environment. The resulting cloud of points provides a sparse description of the 3D environment.

Lens Studio v4.4+
Scripting Name: PointCloud
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

PointConstraint​

A type of constraint that only allows rotation. See also: ConstraintComponent.

Lens Studio v4.10.0+
Scripting Name: Physics.PointConstraint
Inherits from Constraint

This is the API for Lens Studio 4. For the latest API documentation, click here.

PositionEffect​

An Audio Component effect that allows the Lens to simulate sound based on the direction of the Audio Listener relative to the Audio Component.

Lens Studio v4.0+
Scripting Name: PositionEffect
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

Probe​

Performs collision tests (such as ray casts) in one or more world. See Physics.createGlobalProbe(), Physics.createRootProbe(), WorldComponent.createProbe().

Lens Studio v4.10.0+
Scripting Name: Physics.Probe
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

Properties​

Lens Studio v4.0+
Scripting Name: Properties
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

RayCastHit​

Hit results of a ray-cast provided to script. See Probe.

Lens Studio v4.10.0+
Scripting Name: Physics.RayCastHit
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

RealtimeStoreCreateOptions​

The options for the realtime store.

Lens Studio v4.19.0+
Scripting Name: RealtimeStoreCreateOptions
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

Rect​

An axis aligned rectangle. Used by anchors and offsets in ScreenTransform to represent screen boundaries.

Lens Studio v2.0.0+
Scripting Name: Rect
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

RemoteApiRequest​

Lens Studio v4.12.0+
Scripting Name: RemoteApiRequest
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

RemoteApiResponse​

Lens Studio v4.12.0+
Scripting Name: RemoteApiResponse
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

RotatedRect​

Lens Studio v4.13.0+
Scripting Name: RotatedRect
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

RotationOptions​

Used with DeviceTracking.rotationOptions to change settings for Rotation tracking mode.

Lens Studio v1.6.0+
Scripting Name: RotationOptions
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

Sampler​

Lens Studio v4.53.0+
Scripting Name: Sampler
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

SamplerBuilder​

Class for building Sampler.

Lens Studio v4.49.0+
Scripting Name: SamplerBuilder
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

SamplerWrapper​

An accessor for Pass.samplers when using PassWrappers

Lens Studio v4.0+
Scripting Name: SamplerWrapper
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

SamplerWrappers​

Lens Studio v4.0+
Scripting Name: SamplerWrappers
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

SceneObject​

An object in the scene hierarchy, containing a Transform and possibly Components. A script can access the SceneObject holding it through the method script.getSceneObject().

Lens Studio v1.0.0+
Scripting Name: SceneObject
Inherits from SerializableWithUID

This is the API for Lens Studio 4. For the latest API documentation, click here.

ScriptObject​

Base class for objects representing Script data.

Lens Studio v1.0.0+
Scripting Name: ScriptObject
Child Classes: Anchor, AnimationMixerLayer, BackgroundSettings, BaseMultiplayerSessionOptions, BasePlaceholder, BasicTransform, Camera.BaseRenderTarget, CloudStorageListOptions, CloudStorageOptions, CloudStorageReadOptions, CloudStorageWriteOptions, CloudStore, Collision, CollisionEnterEventArgs, CollisionExitEventArgs, CollisionStayEventArgs, ConnectedLensModule.ConnectionInfo, ConnectedLensModule.HostUpdateInfo, ConnectedLensModule.RealtimeStoreCreationInfo, ConnectedLensModule.RealtimeStoreDeleteInfo, ConnectedLensModule.RealtimeStoreKeyRemovalInfo, ConnectedLensModule.RealtimeStoreOwnershipUpdateInfo, ConnectedLensModule.RealtimeStoreUpdateInfo, ConnectedLensModule.UserInfo, Constraint, Contact, Delay, DelayBuilder, Delta, DeltaBuilder, DeviceCamera, DeviceInfoSystem, Dialog.Answer, DirectivityEffect, DistanceEffect, DropshadowSettings, DynamicResource, EventRegistration, Filter, FocusEndEventArgs, FocusStartEventArgs, GeneralDataStore, GltfSettings, IEventParameters, InputBuilder, LocalizationSystem, LocationCloudStorageOptions, LocationCloudStore, ManipulateEndEventArgs, ManipulateStartEventArgs, MelSpectrogram, MelSpectrogramBuilder, MFCC, MFCCBuilder, MultiplayerSession, NoiseReduction, NoiseReductionBuilder, ObjectSpecificData, OutlineSettings, OutputBuilder, Overlap, OverlapEnterEventArgs, OverlapExitEventArgs, OverlapStayEventArgs, Pass, PassWrapper, PassWrappers, PersistentStorageSystem, PitchShifter, PitchShifterBuilder, PointCloud, PositionEffect, Probe, Properties, Provider, RayCastHit, RealtimeStoreCreateOptions, Rect, RemoteApiRequest, RemoteApiResponse, RotatedRect, RotationOptions, Sampler, SamplerBuilder, SamplerWrapper, SamplerWrappers, ScriptScene, SelectEndEventArgs, SelectStartEventArgs, SerializableWithUID, Shape, SpatialAudio, Spectrogram, SpectrogramBuilder, StencilState, StorageOptions, SurfaceOptions, TapEventArgs, TextFill, TextInputSystem, TextToSpeech.Options, TextToSpeech.PhonemeInfo, TextToSpeech.WordInfo, TouchDataProvider, TouchEndEventArgs, TouchMoveEventArgs, TouchStartEventArgs, TrackedMesh, TrackedMeshHistogramResult, TrackedMeshHitTestResult, TrackedPlane, TrackedPoint, Transform, Transformer, TransformerBuilder, TriangleHit, TriggerPrimaryEventArgs, UserContextSystem, VertexSimulationSettings, VoiceML.AdditionalParam, VoiceML.BaseNlpModel, VoiceML.BaseNlpResponse, VoiceML.KeywordModelGroup, VoiceML.ListeningErrorEventArgs, VoiceML.ListeningOptions, VoiceML.ListeningUpdateEventArgs, VoiceML.NlpResponseStatus, VoiceML.PostProcessingAction, VoiceML.PostProcessingActionResponse, VoiceML.PostProcessingActionResponseStatus, VoiceML.SpeechContext, WorldOptions, WorldTrackingCapabilities

This is the API for Lens Studio 4. For the latest API documentation, click here.

ScriptScene​

Represents the Lens scene. Accessible through global.scene.

Lens Studio v1.0.0+
Scripting Name: ScriptScene
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

SelectEndEventArgs​

Arguments used with the InteractionComponent.onSelectEnd event.

Lens Studio v4.0+
Scripting Name: SelectEndEventArgs
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

SelectStartEventArgs​

Arguments used with the InteractionComponent.onSelectStart event.

Lens Studio v4.0+
Scripting Name: SelectStartEventArgs
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

SerializableWithUID​

Low-level data class.

Lens Studio v1.0.0+
Scripting Name: SerializableWithUID
Inherits from ScriptObject
Child Classes: Asset, Component, SceneObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

Shape​

Base type for collision shapes.

Lens Studio v4.4+
Scripting Name: Shape
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

SpatialAudio​

Lens Studio v4.0+
Scripting Name: SpatialAudio
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

Spectrogram​

Representation the signal strength over time at various frequencies present in a particular waveform. Created by applying Fast Fourier Transform (FFT) on the overlapping segments of the audio data.

Lens Studio v3.4+
Scripting Name: Spectrogram
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

SpectrogramBuilder​

The builder class for Spectrogram.

Lens Studio v3.4+
Scripting Name: SpectrogramBuilder
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

SphereShape​

A sphere collision shape.

Lens Studio v4.4+
Scripting Name: SphereShape
Inherits from Shape

This is the API for Lens Studio 4. For the latest API documentation, click here.

StencilState​

The stencil test state for Pass.

Lens Studio v4.1+
Scripting Name: StencilState
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

StorageOptions​

Settings for saving values in a MultiplayerSession.

Lens Studio v4.0+
Scripting Name: StorageOptions
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

SurfaceOptions​

Used with DeviceTracking.surfaceOptions to change settings for Surface tracking mode.

Lens Studio v1.6.0+
Scripting Name: SurfaceOptions
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

TapEventArgs​

Arguments used with the InteractionComponent.onTap event.

Lens Studio v4.0+
Scripting Name: TapEventArgs
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

TextFill​

Fill settings used by several text related classes. Used in Text's textFill property, DropshadowSettings' fill property, and OutlineSettings' fill property.

Lens Studio v2.0.0+
Scripting Name: TextFill
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

TextInputSystem​

Provides access to the device's input system. Accessible through global.textInputSystem.

Lens Studio v4.13.0+
Scripting Name: TextInputSystem
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

TextToSpeech.Options​

Provides the configuration for the Text to Speech Module. It is used to control the language of the generated voice, the voice’s style and pace.

Lens Studio v4.4+
Scripting Name: Options
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

TextToSpeech.PhonemeInfo​

Provides a map of what phoneme is said at what time in the synthesized speech.

Lens Studio v4.13.0+
Scripting Name: PhonemeInfo
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

TextToSpeech.WordInfo​

Parameter returned in the onTTSCompleteHandler callback providing timing details for word pronunciation.

Lens Studio v4.4+
Scripting Name: WordInfo
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

TouchDataProvider​

This provider is returned by global.touchSystem and allows your lens to handle any touches on the screen, and optionally let certain touch types to pass through (let Snapchat handle the touch).

Possible TouchType exception values:

  • "TouchTypeNone"
  • "TouchTypeTouch"
  • "TouchTypeTap"
  • "TouchTypeDoubleTap"
  • "TouchTypeScale"
  • "TouchTypePan"
  • "TouchTypeSwipe"

Lens Studio v1.0.0+
Scripting Name: TouchDataProvider
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

TouchEndEventArgs​

Lens Studio v4.0+
Scripting Name: TouchEndEventArgs
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

TouchMoveEventArgs​

Arguments used with the InteractionComponent.onTouchMove event.

Lens Studio v4.0+
Scripting Name: TouchMoveEventArgs
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

TouchStartEventArgs​

Arguments used with the InteractionComponent.onTouchStart event.

Lens Studio v4.0+
Scripting Name: TouchStartEventArgs
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

TrackedMesh​

Represents a mesh generated by world tracking. Only available when world mesh tracking is supported and enabled.

Lens Studio v3.2+
Scripting Name: TrackedMesh
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

TrackedMeshHistogramResult​

Provides histogram information about tracked world mesh faces in a given area. Returned by DeviceTracking.calculateWorldMeshHistogram().

Lens Studio v3.2+
Scripting Name: TrackedMeshHistogramResult
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

TrackedMeshHitTestResult​

Provides information about a TrackedMesh surface hit during a raycast. Is returned in an array when calling DeviceTracking.hitTestWorldMesh() or DeviceTracking.raycastWorldMesh().

Lens Studio v3.2+
Scripting Name: TrackedMeshHitTestResult
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

TrackedPlane​

A representation for plane detected by native tracking. Can be used with TrackedPoint.

Lens Studio v3.4+
Scripting Name: TrackedPlane
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

TrackedPoint​

A point on the real world not attached to any detected plane.

Lens Studio v3.4+
Scripting Name: TrackedPoint
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

Transform​

Controls the position, rotation, and scale of a SceneObject. Every SceneObject automatically has a Transform attached.

Lens Studio v1.0.0+
Scripting Name: Transform
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

Transformer​

Applies additional transform processing on data for InputPlaceholders and OutputPlaceholders used with MLComponent. For more information, see the MLComponent Overview.

Lens Studio v3.0+
Scripting Name: Transformer
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

TransformerBuilder​

Builds Transformer objects for MLComponent.

Lens Studio v3.0+
Scripting Name: TransformerBuilder
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

TriangleHit​

Triangle hit information, available when a ray cast intersects a collision mesh.

Lens Studio v4.31.0+
Scripting Name: Physics.TriangleHit
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

TriggerPrimaryEventArgs​

Arguments used with the InteractionComponent.onTriggerPrimary event.

Lens Studio v4.0+
Scripting Name: TriggerPrimaryEventArgs
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

UserContextSystem​

Provides information about the user such as display name, birthday, and current weather. Accessible through global.userContextSystem.

All callbacks will execute as soon as the requested information is available. In some rare cases, the requested information may be completely unavailable, and the callback will never occur.

Note that formatted or localized strings may appear differently to users depending on their region.

Lens Studio v2.0.0+
Scripting Name: UserContextSystem
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

VertexSimulationSettings​

Provides settings for vertex physics in the ClothVisual component.

Lens Studio v4.0+
Scripting Name: VertexSimulationSettings
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

VoiceML.AdditionalParam​

Additional parameters are used to provide additional data for NlpModels and NlpResponses.

Lens Studio v4.4+
Scripting Name: AdditionalParam
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

VoiceML.BaseNlpModel​

NlpModels are used to provide the VoiceML NLP engine information about how the transcript of the input audio should be processed. BaseNlpModels is the abstract base class all NlpModels (NlpKeywordModel, NlpIntentModel) inherit from.

You can specify multiple NlpModels to process the same audio, all of their results will be returned in ListeningUpdateEventArgs

Lens Studio v4.4+
Scripting Name: BaseNlpModel
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

VoiceML.BaseNlpResponse​

The abstract base class all NlpResponses inherit from. NlpResponses are used as the result from the VoiceML NLP engine with information after processing the transcript of the input audio.

Lens Studio v4.4+
Scripting Name: BaseNlpResponse
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

VoiceML.KeywordModelGroup​

An NLP model used to detect keywords in the transcript of the input audio. For example, you can have keyword detection which will trigger every time the word "red" is said, and another trigger for the word "yellow".

Lens Studio v4.4+
Scripting Name: KeywordModelGroup
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

VoiceML.ListeningErrorEventArgs​

ListeningErrorEventArgs object returns in onListeningError callback. It contains the error code and description of the error.

Lens Studio v4.4+
Scripting Name: ListeningErrorEventArgs
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

VoiceML.ListeningOptions​

Provides the configuration for the audio input processing output. This can either include NLP processing using the (nlpModels) or directly retrieving the transcription. speechContext provides the ability to further improve the transcription accuracy given an assumed context.

Lens Studio v4.4+
Scripting Name: ListeningOptions
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

VoiceML.ListeningUpdateEventArgs​

The parameter when the callback registered on from VoiceMLModule.onListeningUpdate is called. This is to mark the input audio transcription (and possibly NlpModels as a result) was updated.

Lens Studio v4.4+
Scripting Name: ListeningUpdateEventArgs
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

VoiceML.NlpCommandResponse​

May be returned when enableSystemCommands() API is used. The NlpCommandResponse contains the results of the servers' NLP command model classification on the last sentence and indicates that a predetermined system command was detected. Current supported commands:

  • “Take a Snap”: takes a snapshot.
  • “Start Recording”: starts a video recording if not already started.
  • "Stop Recording”: stops an ongoing video recording, if applicable.

Lens Studio v4.7+
Scripting Name: NlpCommandResponse

This is the API for Lens Studio 4. For the latest API documentation, click here.

VoiceML.NlpIntentModel​

Specifies which NLP Intent model should run to classify the transcription of the input audio. NLP Intent classification meant to extract the meaning of a sentence rather than detecting certain keywords. Multiple intent models can be used on the same transcription, and will run only on complete sentences (isFinalTranscription = True). Supported intent models: VOICE_ENABLED_UI.

Lens Studio v4.4+
Scripting Name: NlpIntentModel
Inherits from VoiceML.BaseNlpModel

This is the API for Lens Studio 4. For the latest API documentation, click here.

VoiceML.NlpIntentResponse​

Returned when NlpIntentModel was specificed in the ListeningOptions, it contains the results of the NLP Intent model classification on the last sentence. NlpIntentResponse will only run on complete sentences (isFinalTranscription = true).

Lens Studio v4.4+
Scripting Name: NlpIntentResponse

This is the API for Lens Studio 4. For the latest API documentation, click here.

VoiceML.NlpKeywordModel​

Used to detect usage of certain keywords from the input audio.

Keyword detection (whose results will be returned in NlpKeywordResponse in the ListeningUpdateEventArgs) can happen in the mid input sentence (and in such case isFinalTranscription=false) or can happen at the end of the sentence (isFinalTranscription=true). Mid sentence detection have closer proximity to the time the word was spoken, but might be less accurate.

Lens Studio v4.4+
Scripting Name: NlpKeywordModel
Inherits from VoiceML.BaseNlpModel

This is the API for Lens Studio 4. For the latest API documentation, click here.

VoiceML.NlpKeywordResponse​

NlpKeywordResponse will be returned if KeywordModel has been supplied as an input model in the ListeningOptions. The keyword model allows detection of keywords (or short phrases) in an input audio.

Lens Studio v4.4+
Scripting Name: NlpKeywordResponse

This is the API for Lens Studio 4. For the latest API documentation, click here.

VoiceML.NlpResponseStatus​

The NLP Response Status indicates wether the NLP was successful in parsing the sentence.

Lens Studio v4.4+
Scripting Name: NlpResponseStatus
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

VoiceML.PostProcessingAction​

The PostProcessingAction is the base class for QnaAction and other post processing actions that need to processed after the transcription phase.

Lens Studio v4.28.0+
Scripting Name: PostProcessingAction
Inherits from ScriptObject
Child Classes: VoiceML.QnaAction

This is the API for Lens Studio 4. For the latest API documentation, click here.

VoiceML.PostProcessingActionResponse​

The PostProcessingActionResponse is the base class for QnaActionRespose and other post processing actions responses. It holds the id and status properties for all deriving objects.

Lens Studio v4.28.0+
Scripting Name: PostProcessingActionResponse
Inherits from ScriptObject
Child Classes: VoiceML.QnaResponse

This is the API for Lens Studio 4. For the latest API documentation, click here.

VoiceML.PostProcessingActionResponseStatus​

Lens Studio v4.28.0+
Scripting Name: PostProcessingActionResponseStatus
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

VoiceML.QnaAction​

Lens Studio v4.28.0+
Scripting Name: QnaAction
Inherits from PostProcessingAction

This is the API for Lens Studio 4. For the latest API documentation, click here.

VoiceML.QnaResponse​

Lens Studio v4.28.0+
Scripting Name: QnaResponse

This is the API for Lens Studio 4. For the latest API documentation, click here.

VoiceML.SpeechContext​

Speech context is used in cases where specific words are expected from the users, the transcription accuracy of these words can be improved, by straightening their likelihood in context. The strength is scaled 1-10 (10 being the strongest increase) the default value is 5.

Lens Studio v4.4+
Scripting Name: SpeechContext
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

WorldOptions​

Holds settings for world mesh tracking in DeviceTracking component. Accessible through DeviceTracking.worldOptions.

Lens Studio v3.2+
Scripting Name: WorldOptions
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

WorldTrackingCapabilities​

Provides information about whether certain world tracking features are supported by the device.

Lens Studio v3.2+
Scripting Name: WorldTrackingCapabilities
Inherits from ScriptObject

This is the API for Lens Studio 4. For the latest API documentation, click here.

Was this page helpful?
Yes
No