# SparkAR Community Scripting Docs ## SparkAR Community Scripting Docs - [Spark AR Scripting Reference](https://sparkar-community.gitbook.io/docs/master.md) - [Audio Analyzer / Energy Meter](https://sparkar-community.gitbook.io/docs/audio-analyzer-energy-meter.md): Audio Analyzer walkthrough - [Asynchronous API Changes (v85+)](https://sparkar-community.gitbook.io/docs/asynchronous-api-changes-v85.md): With v85 of Spark AR Studio the current JavaScript API will be deprecated in favor of asynchronous APIs. - [Custom Instructions](https://sparkar-community.gitbook.io/docs/custom-instructions.md): Latest Version: 15.05.2020 - [AnimationModule](https://sparkar-community.gitbook.io/docs/animationmodule.md) - [ValueDriver](https://sparkar-community.gitbook.io/docs/animationmodule/valuedriver.md) - [TimeDriver](https://sparkar-community.gitbook.io/docs/animationmodule/timedriver.md) - [SignalRecorder](https://sparkar-community.gitbook.io/docs/animationmodule/signalrecorder.md) - [SignalRecord](https://sparkar-community.gitbook.io/docs/animationmodule/signalrecord.md) - [ScalarSampler](https://sparkar-community.gitbook.io/docs/animationmodule/scalarsampler.md) - [SamplerFactory](https://sparkar-community.gitbook.io/docs/animationmodule/samplerfactory.md): The SamplerFactory class creates different types of animation samplers. - [RotationSampler](https://sparkar-community.gitbook.io/docs/animationmodule/rotationsampler.md) - [Driver](https://sparkar-community.gitbook.io/docs/animationmodule/driver.md) - [ColorSampler](https://sparkar-community.gitbook.io/docs/animationmodule/colorsampler.md) - [ArrayOfScalarSignals](https://sparkar-community.gitbook.io/docs/animationmodule/arrayofscalarsignals.md) - [ArrayOfScalarSamplers](https://sparkar-community.gitbook.io/docs/animationmodule/arrayofscalarsamplers.md) - [AudioModule](https://sparkar-community.gitbook.io/docs/audiomodule.md) - [PlaybackController](https://sparkar-community.gitbook.io/docs/audiomodule/playbackcontroller.md) - [CameraInfoModule](https://sparkar-community.gitbook.io/docs/camera-info-module.md) - [CameraPosition](https://sparkar-community.gitbook.io/docs/camera-info-module/camera-position.md) - [DeepLinkModule](https://sparkar-community.gitbook.io/docs/deeplinkmodule.md) - [DeviceMotionModule](https://sparkar-community.gitbook.io/docs/devicemotionmodule.md) - [DiagnosticsModule](https://sparkar-community.gitbook.io/docs/diagnosticsmodule.md) - [FaceGesturesModule](https://sparkar-community.gitbook.io/docs/facegesturesmodule.md) - [FaceTracking2DModule](https://sparkar-community.gitbook.io/docs/facetracking2dmodule.md) - [Face2D](https://sparkar-community.gitbook.io/docs/facetracking2dmodule/face2d.md) - [FaceTrackingModule](https://sparkar-community.gitbook.io/docs/facetrackingmodule.md) - [Cheek](https://sparkar-community.gitbook.io/docs/facetrackingmodule/cheek.md) - [Chin](https://sparkar-community.gitbook.io/docs/facetrackingmodule/chin.md) - [Eye](https://sparkar-community.gitbook.io/docs/facetrackingmodule/eye.md) - [Eyebrow](https://sparkar-community.gitbook.io/docs/facetrackingmodule/eyebrow.md) - [Face](https://sparkar-community.gitbook.io/docs/facetrackingmodule/face.md) - [Forehead](https://sparkar-community.gitbook.io/docs/facetrackingmodule/forehead.md) - [Mouth](https://sparkar-community.gitbook.io/docs/facetrackingmodule/mouth.md) - [Nose](https://sparkar-community.gitbook.io/docs/facetrackingmodule/nose.md) - [FontsModule](https://sparkar-community.gitbook.io/docs/fontsmodule.md) - [FontId](https://sparkar-community.gitbook.io/docs/fontsmodule/fontid.md) - [HandTrackingModule](https://sparkar-community.gitbook.io/docs/handtrackingmodule.md) - [Hand](https://sparkar-community.gitbook.io/docs/handtrackingmodule/hand.md) - [InstructionModule](https://sparkar-community.gitbook.io/docs/instructionmodule.md) - [IrisTrackingModule](https://sparkar-community.gitbook.io/docs/iristrackingmodule.md) - [Eyeball](https://sparkar-community.gitbook.io/docs/iristrackingmodule/eyeball.md) - [LightingEstimationModule](https://sparkar-community.gitbook.io/docs/lightingestimationmodule.md) - [LiveStreamingModule](https://sparkar-community.gitbook.io/docs/livestreamingmodule.md) - [LiveStreamingModule.State](https://sparkar-community.gitbook.io/docs/livestreamingmodule/livestreamingmodule.state.md): The LiveStreamingModule.State enum describes the state of a live stream. - [LiveStreamingReactions](https://sparkar-community.gitbook.io/docs/livestreamingmodule/livestreamingreactions.md) - [LiveStreamingComments](https://sparkar-community.gitbook.io/docs/livestreamingmodule/livestreamingcomments.md) - [LocaleModule](https://sparkar-community.gitbook.io/docs/localemodule.md) - [MaterialsModule](https://sparkar-community.gitbook.io/docs/materialsmodule.md) - [TextureTransform](https://sparkar-community.gitbook.io/docs/materialsmodule/texturetransform.md) - [RetouchingMaterial](https://sparkar-community.gitbook.io/docs/materialsmodule/retouchingmaterial.md) - [MetallicRoughnessPbrMaterial](https://sparkar-community.gitbook.io/docs/materialsmodule/metallicroughnesspbrmaterial.md) - [MaterialBase](https://sparkar-community.gitbook.io/docs/materialsmodule/materialbase.md) - [DefaultMaterial](https://sparkar-community.gitbook.io/docs/materialsmodule/defaultmaterial.md) - [ColorPaintMaterial](https://sparkar-community.gitbook.io/docs/materialsmodule/colorpaintmaterial.md) - [BlendShapeToWarpMapMaterial](https://sparkar-community.gitbook.io/docs/materialsmodule/blendshapetowarpmapmaterial.md) - [BlendedMaterial](https://sparkar-community.gitbook.io/docs/materialsmodule/blendedmaterial.md) - [NativeUIModule](https://sparkar-community.gitbook.io/docs/nativeuimodule.md) - [Picker](https://sparkar-community.gitbook.io/docs/nativeuimodule/picker.md) - [NetworkingModule](https://sparkar-community.gitbook.io/docs/networkingmodule.md) - [PatchesModule](https://sparkar-community.gitbook.io/docs/patchesmodule.md) - [PersistenceModule](https://sparkar-community.gitbook.io/docs/persistencemodule.md) - [StorageScope](https://sparkar-community.gitbook.io/docs/persistencemodule/storagescope.md) - [PersonSegmentationModule](https://sparkar-community.gitbook.io/docs/personsegmentationmodule.md) - [RandomModule](https://sparkar-community.gitbook.io/docs/randommodule.md) - [ReactiveModule](https://sparkar-community.gitbook.io/docs/reactivemodule.md) - [AntiderivativeOverflowBehaviour](https://sparkar-community.gitbook.io/docs/reactivemodule/antiderivativeoverflowbehaviour.md): The AntiderivativeOverflowBehaviour enum describes the recovery technique used when an antiderivative overflows. - [BoundingBoxSignal](https://sparkar-community.gitbook.io/docs/reactivemodule/boundingboxsignal.md) - [ISignal](https://sparkar-community.gitbook.io/docs/reactivemodule/isignal.md) - [PixelPointSignal](https://sparkar-community.gitbook.io/docs/reactivemodule/pixelpointsignal.md) - [PixelSizeSignal](https://sparkar-community.gitbook.io/docs/reactivemodule/pixelsizesignal.md) - [Point2D](https://sparkar-community.gitbook.io/docs/reactivemodule/point2d.md) - [Point2DSignal](https://sparkar-community.gitbook.io/docs/reactivemodule/point2dsignal.md) - [Point3D](https://sparkar-community.gitbook.io/docs/reactivemodule/point3d.md) - [Point4DSignal](https://sparkar-community.gitbook.io/docs/reactivemodule/point4dsignal.md) - [PointSignal](https://sparkar-community.gitbook.io/docs/reactivemodule/pointsignal.md) - [PrimitiveOrShaderSignal](https://sparkar-community.gitbook.io/docs/reactivemodule/primitiveorshadersignal.md) - [RgbaSignal](https://sparkar-community.gitbook.io/docs/reactivemodule/rgbasignal.md) - [BoolSignal](https://sparkar-community.gitbook.io/docs/reactivemodule/boolsignal.md) - [Rotation](https://sparkar-community.gitbook.io/docs/reactivemodule/rotation.md) - [RotationSignal](https://sparkar-community.gitbook.io/docs/reactivemodule/rotationsignal.md) - [ScalarSignal](https://sparkar-community.gitbook.io/docs/reactivemodule/scalarsignal.md) - [ScalarValue](https://sparkar-community.gitbook.io/docs/reactivemodule/scalarvalue.md) - [ScaleSignal](https://sparkar-community.gitbook.io/docs/reactivemodule/scalesignal.md) - [ShaderSignal](https://sparkar-community.gitbook.io/docs/reactivemodule/shadersignal.md) - [StringSignal](https://sparkar-community.gitbook.io/docs/reactivemodule/stringsignal.md) - [StringValue](https://sparkar-community.gitbook.io/docs/reactivemodule/stringvalue.md) - [Subscription](https://sparkar-community.gitbook.io/docs/reactivemodule/subscription.md) - [BoolValue](https://sparkar-community.gitbook.io/docs/reactivemodule/boolvalue.md) - [VectorSignal](https://sparkar-community.gitbook.io/docs/reactivemodule/vectorsignal.md) - [TransformSignal](https://sparkar-community.gitbook.io/docs/reactivemodule/transformsignal.md) - [ColorSignal](https://sparkar-community.gitbook.io/docs/reactivemodule/colorsignal.md) - [EulerAnglesSignal](https://sparkar-community.gitbook.io/docs/reactivemodule/euleranglessignal.md) - [EventSource](https://sparkar-community.gitbook.io/docs/reactivemodule/eventsource.md) - [HsvaSignal](https://sparkar-community.gitbook.io/docs/reactivemodule/hsvasignal.md) - [InsetsSignal](https://sparkar-community.gitbook.io/docs/reactivemodule/insetssignal.md) - [SceneModule](https://sparkar-community.gitbook.io/docs/scenemodule.md) - [AmbientLightSource](https://sparkar-community.gitbook.io/docs/scenemodule/ambientlightsource.md) - [BrushType](https://sparkar-community.gitbook.io/docs/scenemodule/brushtype.md) - [HorizontalAlignment](https://sparkar-community.gitbook.io/docs/scenemodule/horizontalalignment.md) - [RenderMode](https://sparkar-community.gitbook.io/docs/scenemodule/rendermode.md) - [ScalingOption](https://sparkar-community.gitbook.io/docs/scenemodule/untitled.md) - [TextAlignment](https://sparkar-community.gitbook.io/docs/scenemodule/textalignment.md) - [TrackingMode](https://sparkar-community.gitbook.io/docs/scenemodule/trackingmode.md) - [SpotLightSource](https://sparkar-community.gitbook.io/docs/scenemodule/spotlightsource.md) - [PointLightSource](https://sparkar-community.gitbook.io/docs/scenemodule/pointlightsource.md) - [DirectionalLightSource](https://sparkar-community.gitbook.io/docs/scenemodule/directionallightsource.md) - [HandTrackerSceneObject](https://sparkar-community.gitbook.io/docs/scenemodule/handtrackersceneobject.md) - [Canvas](https://sparkar-community.gitbook.io/docs/scenemodule/canvas.md) - [DynamicExtrusion](https://sparkar-community.gitbook.io/docs/scenemodule/dynamicextrusion.md) - [FaceAnchor](https://sparkar-community.gitbook.io/docs/scenemodule/faceanchor.md) - [FaceMesh](https://sparkar-community.gitbook.io/docs/scenemodule/facemesh.md) - [VerticalTextAlignment](https://sparkar-community.gitbook.io/docs/scenemodule/verticaltextalignment.md): The VerticalTextAlignment enum describes how a text element is aligned vertically. - [VerticalAlignment](https://sparkar-community.gitbook.io/docs/scenemodule/verticalalignment.md): The VerticalAlignment enum describes how an element is aligned vertically. - [FaceTracker](https://sparkar-community.gitbook.io/docs/scenemodule/facetracker.md) - [FocalPlane](https://sparkar-community.gitbook.io/docs/scenemodule/focalplane.md) - [FocalDistance](https://sparkar-community.gitbook.io/docs/scenemodule/focaldistance.md) - [OutputVisibility](https://sparkar-community.gitbook.io/docs/scenemodule/outputvisibility.md) - [Mesh](https://sparkar-community.gitbook.io/docs/scenemodule/mesh.md) - [Joint](https://sparkar-community.gitbook.io/docs/scenemodule/joint.md) - [PlaneTracker](https://sparkar-community.gitbook.io/docs/scenemodule/planetracker.md) - [Plane](https://sparkar-community.gitbook.io/docs/scenemodule/plane.md) - [PlanarText](https://sparkar-community.gitbook.io/docs/scenemodule/planartext.md) - [PlanarObject](https://sparkar-community.gitbook.io/docs/scenemodule/planarobject.md) - [PlanarImage](https://sparkar-community.gitbook.io/docs/scenemodule/planarimage.md) - [PlanarFlexItem](https://sparkar-community.gitbook.io/docs/scenemodule/planarflexitem.md) - [PlanarDiv](https://sparkar-community.gitbook.io/docs/scenemodule/planardiv.md) - [ParticleTypeDescriptions](https://sparkar-community.gitbook.io/docs/scenemodule/particletypedescriptions.md) - [ParticleSystem](https://sparkar-community.gitbook.io/docs/scenemodule/particlesystem.md) - [ParticleTypeDescription](https://sparkar-community.gitbook.io/docs/scenemodule/particletypedescription.md) - [PlanarFlexContainer](https://sparkar-community.gitbook.io/docs/scenemodule/planarflexcontainer.md) - [TextExtrusion](https://sparkar-community.gitbook.io/docs/scenemodule/textextrusion.md) - [SvgImage](https://sparkar-community.gitbook.io/docs/scenemodule/svgimage.md) - [BlendShapesMesh](https://sparkar-community.gitbook.io/docs/scenemodule/blendshapesmesh.md) - [BlockSceneRoot](https://sparkar-community.gitbook.io/docs/scenemodule/blocksceneroot.md) - [BoundingBox](https://sparkar-community.gitbook.io/docs/scenemodule/boundingbox.md) - [Bounds2D](https://sparkar-community.gitbook.io/docs/scenemodule/bounds2d.md) - [Camera](https://sparkar-community.gitbook.io/docs/scenemodule/camera.md) - [CameraVisibility](https://sparkar-community.gitbook.io/docs/scenemodule/cameravisibility.md) - [BlendShape](https://sparkar-community.gitbook.io/docs/scenemodule/blendshape.md) - [Scene](https://sparkar-community.gitbook.io/docs/scenemodule/scene.md) - [SceneObjectBase](https://sparkar-community.gitbook.io/docs/scenemodule/sceneobjectbase.md) - [ScreenPlane](https://sparkar-community.gitbook.io/docs/scenemodule/screenplane.md) - [Skeleton](https://sparkar-community.gitbook.io/docs/scenemodule/skeleton.md) - [segmentation](https://sparkar-community.gitbook.io/docs/scenemodule/segmentation.md) - [Speaker](https://sparkar-community.gitbook.io/docs/scenemodule/speaker.md) - [Transform](https://sparkar-community.gitbook.io/docs/scenemodule/transform.md) - [TargetTracker](https://sparkar-community.gitbook.io/docs/scenemodule/targettracker.md) - [TextAlignmentWrapper](https://sparkar-community.gitbook.io/docs/scenemodule/textalignmentwrapper.md) - [WorldTransform](https://sparkar-community.gitbook.io/docs/scenemodule/worldtransform.md) - [SceneObject](https://sparkar-community.gitbook.io/docs/scenemodule/sceneobject.md) - [ShadersModule](https://sparkar-community.gitbook.io/docs/shadersmodule.md) - [VertexAttribute](https://sparkar-community.gitbook.io/docs/shadersmodule/vertexattribute.md): The VertexAttribute enum describes the bultin vertex attributes. - [SdfVariant](https://sparkar-community.gitbook.io/docs/shadersmodule/sdfvariant.md): The SdfVariant enum describes the SDF variant. - [PhysicallyBasedMaterialTextures](https://sparkar-community.gitbook.io/docs/shadersmodule/physicallybasedmaterialtextures.md): The PhysicallyBasedMaterialTextures enum describes the different texture slots for a physically based material. - [GradientType](https://sparkar-community.gitbook.io/docs/shadersmodule/gradienttype.md): The GradientType enum describes the type of the shader gradient. - [FacePaintMaterialTextures](https://sparkar-community.gitbook.io/docs/shadersmodule/facepaintmaterialtextures.md): The FacePaintMaterialTextures enum describes the different texture slots for a face paint material. - [DerivativeType](https://sparkar-community.gitbook.io/docs/shadersmodule/derivativetype.md): The DerivativeType enum describes the shader derivative type. - [DefaultMaterialTextures](https://sparkar-community.gitbook.io/docs/shadersmodule/defaultmaterialtextures.md): The DefaultMaterialTextures enum describes the different texture slots for a default material. - [ColorSpace](https://sparkar-community.gitbook.io/docs/shadersmodule/colorspace.md): The ColorSpace enum describes the color space. - [BuiltinUniform](https://sparkar-community.gitbook.io/docs/shadersmodule/builtinuniform.md): The BuiltinUniform enum describes the bultin shader uniforms. - [BlendMode](https://sparkar-community.gitbook.io/docs/shadersmodule/blendmode.md): The BlendMode enum describes the blending mode. - [BlendedMaterialTextures](https://sparkar-community.gitbook.io/docs/shadersmodule/untitled.md): The BlendedMaterialTextures enum describes the different texture slots for a flat material. - [SvgsModule](https://sparkar-community.gitbook.io/docs/svgsmodule.md) - [TexturesModule](https://sparkar-community.gitbook.io/docs/texturesmodule.md) - [State](https://sparkar-community.gitbook.io/docs/texturesmodule/state.md): The State enum describes the download state of an ExternalTexture. - [SourceImageRegionTexture](https://sparkar-community.gitbook.io/docs/texturesmodule/sourceimageregiontexture.md) - [SubTexture](https://sparkar-community.gitbook.io/docs/texturesmodule/subtexture.md) - [TextureBase](https://sparkar-community.gitbook.io/docs/texturesmodule/texturebase.md) - [CameraTexture](https://sparkar-community.gitbook.io/docs/texturesmodule/cameratexture.md) - [CanvasTexture](https://sparkar-community.gitbook.io/docs/texturesmodule/canvastexture.md) - [ColorTexture](https://sparkar-community.gitbook.io/docs/texturesmodule/colortexture.md) - [DeepLinkTexture](https://sparkar-community.gitbook.io/docs/texturesmodule/deeplinktexture.md) - [ExternalTexture](https://sparkar-community.gitbook.io/docs/texturesmodule/externaltexture.md) - [ImageTexture](https://sparkar-community.gitbook.io/docs/texturesmodule/imagetexture.md) - [SegmentationTexture](https://sparkar-community.gitbook.io/docs/texturesmodule/segmentationtexture.md) - [SequenceTexture](https://sparkar-community.gitbook.io/docs/texturesmodule/sequencetexture.md) - [TimeModule](https://sparkar-community.gitbook.io/docs/timemodule.md) - [TouchGesturesModule](https://sparkar-community.gitbook.io/docs/touchgesturesmodule.md) - [Type](https://sparkar-community.gitbook.io/docs/touchgesturesmodule/type.md): The Type enum describes a touch gesture. - [TouchGestureModule.Gesture.State](https://sparkar-community.gitbook.io/docs/touchgesturesmodule/touchgesturemodule.gesture.state.md): The State enum describes the state of a Gesture. - [Gesture](https://sparkar-community.gitbook.io/docs/touchgesturesmodule/gesture.md) - [LongPressGesture](https://sparkar-community.gitbook.io/docs/touchgesturesmodule/longpressgesture.md) - [PanGesture](https://sparkar-community.gitbook.io/docs/touchgesturesmodule/pangesture.md) - [PinchGesture](https://sparkar-community.gitbook.io/docs/touchgesturesmodule/pinchgesture.md) - [RawTouchGesture](https://sparkar-community.gitbook.io/docs/touchgesturesmodule/rawtouchgesture.md) - [RotateGesture](https://sparkar-community.gitbook.io/docs/touchgesturesmodule/rotategesture.md) - [TapGesture](https://sparkar-community.gitbook.io/docs/touchgesturesmodule/tapgesture.md) - [UnitsModule](https://sparkar-community.gitbook.io/docs/unitsmodule.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on a page URL with the `ask` query parameter: ``` GET https://sparkar-community.gitbook.io/docs/master.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.