Scripting Object Reference

The following is a description of all scripting modules.

AnimationModule

The `AnimationModule` class implements object animation.

Classes

Class	Description
`ArrayOfScalarSamplers`	The `ArrayOfScalarSamplers` class describes an array of scalar samplers.
`ArrayOfScalarSignals`	The `ArrayOfScalarSignals` class describes an array of scalar signals.
`ColorSampler`	The `ColorSampler` class encapsulates a color sampler.
`Driver`	The `Driver` class encapsulates an animation driver.
`RotationSampler`	The `RotationSampler` class is an animation sampler for object rotation.
`SamplerFactory`	The `SamplerFactory` class creates different types of animation samplers.
`ScalarSampler`	The `ScalarSampler` class encapsulates a scalar value sampler.
`SignalRecord`	The `SignalRecord` class encapsulates recording data for a value signal
`SignalRecorder`	The `SignalRecorder` class enables recording and playback of signal values
`TimeDriver`	The `TimeDriver` class controls an animation.
`ValueDriver`	The `ValueDriver` class controls an animation value.

AudioModule

The `AudioModule` class enables sound effects.

Classes

Class	Description
`PlaybackController`	The `PlaybackController` class allows to control playback of audio

CameraInfoModule

The `CameraInfoModule` class provides access to details about the device camera.

Enums

Value	Description
`CameraPosition`	The `CameraPosition` enum describes the direction the camera is facing.

CameraShareModule

The `CameraShareModule` class exposes methods and properties to allow an external app to send data to an effect.

DeviceMotionModule

The `DeviceMotionModule` class enables device movement detection.

DiagnosticsModule

The `DiagnosticsModule` class enables diagnostic logging.

FaceGesturesModule

The `FaceGesturesModule` class enables face orientation detection.

FaceTrackingModule

The `FaceTrackingModule` class enables facial movement and expression detection.

Classes

Class	Description
`Cheek`	The `Cheek` class exposes the details of a detected cheek.
`Chin`	The `Chin` class exposes the details of a detected chin.
`Eye`	The `Eye` class exposes the details of a detected eye.
`Eyebrow`	The `Eyebrow` class exposes the details of a detected eyebrow.
`Face`	The `Face` class exposes details of a detected face.
`Forehead`	The `Forehead` class exposes the details of a detected forehead.
`Mouth`	The `Mouth` class exposes the details of a detected mouth.
`Nose`	The `Nose` class exposes the details of a detected nose.

FontsModule

The `FontsModule` class is used for working with custom fonts in effects.

Classes

Class	Description
`FontId`	The `FontsId` class identifies a font in an effect.

HandTrackingModule

The `HandTrackingModule` class enables hand tracking.

Classes

Class	Description
`Hand`	The `Hand` class describes a hand detected in a scene.

InstructionModule

The `InstructionModule` class enables effects to provide instructions to the user.

Enums

Value	Description
`Type`	Deprecated: the `Type` enum indicates the type of instruction issued.

LightingEstimationModule

The `LightingEstimation` module encapsulates access to estimations of lighting in the scene.

LiveStreamingModule

The `LiveStreamingModule` class enables to retrieve information from a live stream from within the effect, such as reactions and comments

Classes

Class Description

Class	Description
`LiveStreamingComments`	The `LiveStreamingComments` class provides access to the Facebook Live comments stream.
`LiveStreamingReactions`	The `LiveStreamingReactions` class provides access to the Facebook Live reactions stream. For low volumes of reactions this will correspond to the stream of reaction bubbles that float by the broadcast, for higher volumes of reactions this will an approximate count of how many times the reaction button was tapped, with some rate limiting per-user. This number will not correspond to the number of reactions displayed elsewhere because that number only counts each user's reaction once.

LiveStreamingComments

The LiveStreamingComments class provides access to the Facebook Live comments stream.

LiveStreamingReactions

The LiveStreamingReactions class provides access to the Facebook Live reactions stream. For low volumes of reactions this will correspond to the stream of reaction bubbles that float by the broadcast, for higher volumes of reactions this will an approximate count of how many times the reaction button was tapped, with some rate limiting per-user. This number will not correspond to the number of reactions displayed elsewhere because that number only counts each user's reaction once.

Enums

Value	Description
`State`	The `LiveStreamingModule.State` enum describes the state of a live stream.

LocaleModule

The `LocaleModule` class encapsulates access to the locale identifier of the device.

MaterialsModule

The `Materials` module enables working with textures and making adjustments to qualities like opacity and reflectivity.

Classes

Class	Description
`BlendShapeToWarpMapMaterial`	The `BlendShapeToWarpMapMaterial` class.
`BlendedMaterial`	The `BlendedMaterial` class encapsulates materials blended from multiple textures.
`ColorPaintMaterial`	The `ColorPaintMaterial` class encapsulates a face-paint material.
`CustomMaterial`	The `CustomMaterial` class describes a custom material shader.
`DefaultMaterial`	The `DefaultMaterial` class encapsulates an image-based material.
`MaterialBase`	The `MaterialBase` class exposes properties common to all material types.
`RetouchingMaterial`	The `RetouchingMaterial` class encapsulates parameters which define the extend of certain beautification techniques.
`TextureTransform`	The `TextureTransform` class encapsulates scaling and translation transforms about a textures UV axis.

NativeUIModule

The `NativeUI` module exposes editable text.

NetworkingModule

The `NetworkingModule` class enables effects to fetch information from a network. To use the Networking class you must add the Networking capability to the project manifest. You also need to add to the allow list domains you'd like to access in the Capabilities menu. AR Studio requires the URL passed to the `fetch()` method to be an HTTPS URL, with a certificate that chains up to a trusted certificate authority. Self-signed and other non-trusted certificates should not be expected to work.

PatchesModule

The `PatchesModule` module allows interop between JS scripting and the AR Studio patches visual scripting system.

PrefabsModule

The `PrefabsModule` module provides functionality for working with external meshes.

Classes

Class	Description
`Prefab`	The `Prefab` class represents a downloadable prefab mesh.
`PrefabGltf`	The `PrefabGltf` class represents a GLTF prefab mesh.

Enums

Value	Description
`State`	The `State` enum describes the state of a prefab mesh.

RandomModule

The `RandomModule` class enables random number generation.

ReactiveModule

The `ReactiveModule` class exposes methods for reactive programming.

Classes

Class	Description
`BoolSignal`	The `BoolSignal` class monitors a boolean value.
`BoolValue`	The `BoolValue` class contains a Boolean value.
`BoundingBoxSignal`	The `BoundingBoxSignal` class monitors bounding box values.
`ColorSignal`	The `ColorSignal` class monitors a color.
`EulerAnglesSignal`	The `EulerAnglesSignal` class monitors Euler angle signal values.
`EventSource`	The `EventSource` class provides methods for monitoring signals.
`HsvaSignal`	The `HsvaSignal` class monitors a HSVA color value.
`InsetsSignal`	The `InsetsSignal` class monitors the insets of the effect safe area.
`PixelPointSignal`	The `PixelPointSignal` class monitors a 2D coordinate.
`PixelSizeSignal`	The `PixelSizeSignal` class monitors the pixel size of the camera info preview.
`Point2D`	The `Point2D` class contains a 2D coordinate.
`Point3D`	The `Point3D` class contains a 3D coordinate.
`PointSignal`	The PointSignal class monitors a 3D coordinate.
`RgbaSignal`	The `RgbaSignal` class monitors a RGBA color value.
`Rotation`	The `Rotation` class encapsulates an object's rotation.
`RotationSignal`	The `RotationSignal` class monitors rotation values.
`ScalarSignal`	The `ScalarSignal` class monitors a numerical value.
`ScalarValue`	The `ScalarValue` class contains a scalar value.
`ScaleSignal`	The ScalarSignal class monitors an objects scale.
`StringSignal`	The `StringSignal` class monitors a string value.
`StringValue`	The `StringValue` class contains a string value.
`Subscription`	The `Subscription` class implements object value monitoring.
`TransformSignal`	The `TransformSignal` class monitors a scene transform.
`VectorSignal`	The `VectorSignal` class monitors a vector.

Enums

Value	Description
`AntiderivativeOverflowBehaviour`	The `AntiderivativeOverflowBehaviour` enum describes the recovery technique used when an antiderivative overflows.

SceneModule

The `SceneModule` class exposes properties and methods to access the objects in a scene.

Classes

Class	Description
`AmbientLightSource`	The `AmbientLightSource` class describes an ambient lighting source.
`BlendShape`	The `BlendShape` class describes a face which can be blended.
`BlendShapesFace`	The `BlendShapesFace` class encapsulates multiple blend faces.
`BlendShapesMesh`	The `BlendShapesMesh` class encapsulates multiple blendable meshes.
`BoundingBox`	The `BoundingBox` class describes the bounds of a scene element in the local coordinate system.
`Bounds2D`	The `Bounds2D` class describes the bounds of a scene element.
`Camera`	The `Camera` class exposes details about the device camera focal area.
`CameraVisibility`	The `CameraVisibility` class describes whether or not an object is visible from various camera views.
`Canvas`	The `Canvas` class describes a scene canvas.
`DirectionalLightSource`	The `DirectionalLightSource` class describes a directional light source.
`DynamicExtrusion`	The `DynamicExtrusion` class provides functionality for creating extruded 3D objects using a brush.
`FaceAnchor`	The `FaceAnchor` class describes an anchored face.
`FaceMesh`	The `FaceMesh` class describes a face mesh.
`FaceTracker`	The `FaceTracker` class propagates details of detected faces to the scene.
`FocalDistance`	The `FocalDistance` class describes a focal distance.
`FocalPlane`	The `FocalPlane` class exposes details about the focal plane of the device camera.
`HandTrackerSceneObject`	The `HandTrackerSceneObject` class encapsulates a hand tracking object.
`Joint`	The `Joint` class encapsulates a joint scene object.
`Mesh`	The `Mesh` class describes a scene mesh.
`OutputVisibility`	The `OutputVisibility` class describes whether or not an object is visible from various outputs.
`ParticleEmitterInterpolations`	The `ParticleEmitterInterpolations` class controls the particle interpolation system.
`ParticleSystem`	The `ParticleSystem` class implements the particle management system for the scene.
`ParticleTypeDescription`	The `ParticleTypeDescription` class provides functionality for setting particle sprite densities in the scene.
`ParticleTypeDescriptions`	The `ParticleTypeDescriptions` class provides a container for particle type descriptions.
`PlanarDiv`	The `PlanarDiv` class describes a div on a plane.
`PlanarFlexContainer`	The `PlanarFlexContainer` class describes a flex container on a plane.
`PlanarFlexItem`	The `PlanarFlexItem` class describes a flex item on a plane.
`PlanarImage`	The `PlanarImage` class describes an image rendered on a plane.
`PlanarObject`	The `PlanarObject` class describes an object on a plane.
`PlanarText`	The `PlanarText` class describes text on a plane.
`Plane`	The `Plane` class describes a plane.
`PlaneTracker`	The `PlaneTracker` class provides functionality for locating a 3D plane based on 2D screen coordinates.
`PointLightSource`	The `PointLightSource` class describes a point light source.
`PointTracker`	The 'PointerTracker' class describes a point tracker object.
`Scene`	The `Scene` class implements properties and methods to access the objects in a scene.
`SceneObject`	The `SceneObject` class describes an object in a scene.
`SceneObjectBase`	The `SceneObjectBase` class describes a scene object.
`ScreenPlane`	The `ScreenPlane` class describes a screen plane.
`Skeleton`	The `Skeleton` class describes a skeleton object.
`Speaker`	The `AudioSource` class encapsulates an audio source for a scene.
`SpotLightSource`	The `SpotLightSource` class describes a spot light source.
`TargetTracker`	The `TargetTracker` encapsulates a tracker for some target.
`TextAlignmentWrapper`	The `TextAlignmentWrapper` class contains text alignment details.
`Transform`	The `Transform` class describes an object transform for a scene.
`WorldTransform`	The `WorldTransform` class describes an object tranform for a sceneObject in world space.
`segmentation`	The `segmentation` class encapsulates image segmentation.

Enums

Value	Description
`HorizontalAlignment`	The `HorizontalAlignment` enum describes how an element is aligned horizontally.
`RenderMode`	The RenderMode enum describes how to render a scene object.
`ScalingOption`	The `ScalingOption` enum describes how an element is scaled.
`TextAlignment`	The `TextAlignment` enum describes how a text element is aligned horizontally.
`TrackingMode`	The `TrackingMode` enum describes how a PlaneTracker is tracking an object.
`VerticalAlignment`	The `VerticalAlignment` enum describes how an element is aligned vertically.
`VerticalTextAlignment`	The `VerticalTextAlignment` enum describes how a text element is aligned vertically.

SceneUnderstandingModule

The `SceneUnderstandingModule` provides access to details about recognition of real objects captured by the camera

Classes

Class	Description
`SceneCategory`	The `SceneCategory` class encapsulates details of recognized real-world objects

Enums

Value	Description
`SceneCategories`	The `SceneCategories` enum lists possible objects that can be recognized in a scene by the `SceneUnderstanding` module

TexturesModule

The `TexturesModule` class enables images, animation sequences, videos, colors, and other visual artifacts to be combined to form materials.

Classes

Class	Description
`CanvasTexture`	The `CanvasTexture` class enables painting with a brush to a texture.
`ColorTexture`	The `ColorTexture` class encapsulates a texture that has a color (including alpha channel).
`DeepLinkTexture`	The `DeepLinkTexture` class represents an image texture passed in via the sharing SDK.
`ExternalTexture`	The `ExternalTexture` class encapsulates a visual asset that is downloaded over the network.
`ImageTexture`	The `ImageTexture` class encapsulates an image that may be used to form materials for rendering in the scene.
`SegmentationTexture`	The `SegmentationTexture` class encapsulates a texture that will be used for image segmentation.
`SequenceTexture`	The `SequenceTexture` class is a collection of still images that form an animation.
`SubTexture`	The `SubTexture` class exposes details of a texture in UV coordinates.
`TextureBase`	The `TextureBase` class describes a texture.

TimeModule

The `TimeModule` class enables time-based events.

TouchGesturesModule

The `TouchGesturesModule` class enables touch gesture detection.

Classes

Class	Description
`Gesture`	The `Gesture` class encapsulates details of a detected gesture.
`LongPressGesture`	The `LongPressGesture` class contains the details of a detected long-press gesture.
`PanGesture`	The `PanGesture` class contains the details of a detected pan gesture.
`PinchGesture`	The `PinchGesture` class contains the details of a detected pinch gesture.
`RawTouchGesture`	The RawTouchGesture class encapsulates raw touch data.
`RotateGesture`	The `RotateGesture` class contains the details of a detected rotate gesture.
`TapGesture`	The `TapGesture` class contains the details of a detected tap gesture.

UnitsModule

The `UnitsModule` class provides functionality for converting values into world-space units.

Enums

Value	Description
`WorldUnit`	The `WorldUnit` enum describes the unit of measurement used in world-space.

ViewportsModule

The `ViewportsModule` class exposes the viewport wrapper.

Classes

Class	Description
`ViewportWrapper`	The `ViewportWrapper` classes encapsulates the viewport which renders the scene.

WeatherModule

The `WeatherModule` class provides information about the current weather