SparkAR Community Scripting Docs
  • Spark AR Scripting Reference
  • Audio Analyzer / Energy Meter
  • Asynchronous API Changes (v85+)
  • Custom Instructions
  • AnimationModule
    • ValueDriver
    • TimeDriver
    • SignalRecorder
    • SignalRecord
    • ScalarSampler
    • SamplerFactory
    • RotationSampler
    • Driver
    • ColorSampler
    • ArrayOfScalarSignals
    • ArrayOfScalarSamplers
  • AudioModule
    • PlaybackController
  • CameraInfoModule
    • CameraPosition
  • DeepLinkModule
  • DeviceMotionModule
  • DiagnosticsModule
  • FaceGesturesModule
  • FaceTracking2DModule
    • Face2D
  • FaceTrackingModule
    • Cheek
    • Chin
    • Eye
    • Eyebrow
    • Face
    • Forehead
    • Mouth
    • Nose
  • FontsModule
    • FontId
  • HandTrackingModule
    • Hand
  • InstructionModule
  • IrisTrackingModule
    • Eyeball
  • LightingEstimationModule
  • LiveStreamingModule
    • LiveStreamingModule.State
    • LiveStreamingReactions
    • LiveStreamingComments
  • LocaleModule
  • MaterialsModule
    • TextureTransform
    • RetouchingMaterial
    • MetallicRoughnessPbrMaterial
    • MaterialBase
    • DefaultMaterial
    • ColorPaintMaterial
    • BlendShapeToWarpMapMaterial
    • BlendedMaterial
  • NativeUIModule
    • Picker
  • NetworkingModule
  • PatchesModule
  • PersistenceModule
    • StorageScope
  • PersonSegmentationModule
  • RandomModule
  • ReactiveModule
    • AntiderivativeOverflowBehaviour
    • BoundingBoxSignal
    • ISignal
    • PixelPointSignal
    • PixelSizeSignal
    • Point2D
    • Point2DSignal
    • Point3D
    • Point4DSignal
    • PointSignal
    • PrimitiveOrShaderSignal
    • RgbaSignal
    • BoolSignal
    • Rotation
    • RotationSignal
    • ScalarSignal
    • ScalarValue
    • ScaleSignal
    • ShaderSignal
    • StringSignal
    • StringValue
    • Subscription
    • BoolValue
    • VectorSignal
    • TransformSignal
    • ColorSignal
    • EulerAnglesSignal
    • EventSource
    • HsvaSignal
    • InsetsSignal
  • SceneModule
    • AmbientLightSource
    • BrushType
    • HorizontalAlignment
    • RenderMode
    • ScalingOption
    • TextAlignment
    • TrackingMode
    • SpotLightSource
    • PointLightSource
    • DirectionalLightSource
    • HandTrackerSceneObject
    • Canvas
    • DynamicExtrusion
    • FaceAnchor
    • FaceMesh
    • VerticalTextAlignment
    • VerticalAlignment
    • FaceTracker
    • FocalPlane
    • FocalDistance
    • OutputVisibility
    • Mesh
    • Joint
    • PlaneTracker
    • Plane
    • PlanarText
    • PlanarObject
    • PlanarImage
    • PlanarFlexItem
    • PlanarDiv
    • ParticleTypeDescriptions
    • ParticleSystem
    • ParticleTypeDescription
    • PlanarFlexContainer
    • TextExtrusion
    • SvgImage
    • BlendShapesMesh
    • BlockSceneRoot
    • BoundingBox
    • Bounds2D
    • Camera
    • CameraVisibility
    • BlendShape
    • Scene
    • SceneObjectBase
    • ScreenPlane
    • Skeleton
    • segmentation
    • Speaker
    • Transform
    • TargetTracker
    • TextAlignmentWrapper
    • WorldTransform
    • SceneObject
  • ShadersModule
    • VertexAttribute
    • SdfVariant
    • PhysicallyBasedMaterialTextures
    • GradientType
    • FacePaintMaterialTextures
    • DerivativeType
    • DefaultMaterialTextures
    • ColorSpace
    • BuiltinUniform
    • BlendMode
    • BlendedMaterialTextures
  • SvgsModule
  • TexturesModule
    • State
    • SourceImageRegionTexture
    • SubTexture
    • TextureBase
    • CameraTexture
    • CanvasTexture
    • ColorTexture
    • DeepLinkTexture
    • ExternalTexture
    • ImageTexture
    • SegmentationTexture
    • SequenceTexture
  • TimeModule
  • TouchGesturesModule
    • Type
    • TouchGestureModule.Gesture.State
    • Gesture
    • LongPressGesture
    • PanGesture
    • PinchGesture
    • RawTouchGesture
    • RotateGesture
    • TapGesture
  • UnitsModule
Powered by GitBook
On this page

Was this helpful?

Custom Instructions

Latest Version: 15.05.2020

Here is list of all available custom instructions in Spark AR capabilities menu:

  • This effect uses flashing images, Token: effect_uses_flashing_images

  • This effect uses flashing lights, Token: effect_uses_flashing_lights

  • Try this effect with headphones, Token: try_with_headphones

  • Say something, Token: say_something

  • Tap and slide to change, Token: tap_and_slide_to_change

  • Choose an option, Token: choose_an_option

  • Find a flat surface, Token: find_a_surface

  • Find the pattern, Token: find_the_pattern

  • Find the object, Token: find_the_object

  • Find the image, Token: find_the_image

  • Swipe up and down, Token: swipe_up_and_down

  • Swipe down, Token: swipe_down

  • Swipe up, Token: swipe_up

  • Swipe left and right, Token: swipe_left_and_right

  • Swipe right, Token: swipe_right

  • Swipe left, Token: swipe_left

  • Rotate your device, Token: rotate_your_device

  • Use two fingers to rotate, Token: use_2_fingers_to_rotate

  • Pinch to change, Token: Pinch_to_change

  • Tap to place on a surface, Token: tap_to_place_on_surface

  • Tilt your head from side to side, Token: tilt_head_side_to_side

  • Turn your head to the left, Token: turn_head_left

  • Turn your head to the right, Token: turn_head_right

  • Blow a kiss, Token: blow_a_kiss

  • Close your right eye, Token: close_right_eye

  • Close your left eye, Token: close_left_eye

  • Pinch to zoom, Token: pinch_to_zoce

  • Tap to play, Token: tap_to_play

  • Lower your eyebrows, Token: lower_your_eyebrows

  • Tap and hold record to start, Token: press_to_launch

  • Tap to try on, Token: tap_try_on

  • Raise your eyebrows, Token: raise_your_eyebrows

  • Tilt your head back, Token: tilt_your_head_back

  • Tap to move around, Token: tap_to_move_around

  • Open your mouth, Token: open_your_mouth

  • Tap your eyes, Token: tap_your_eyes

  • Open your mouth, Token: instruction_fallback

  • Tap to start, Token: tap_to_start

  • Turn your head, Token: turn_head

  • Tap to start again, Token: tap_to_reply

  • Smile, Token: smile

  • Tap to change character, Token: tap_change_character

  • Pucker your lips, Token: pucker_lips

  • Tap and hold, Token: touch_hold

  • Try it with friends, Token: try_with_friends

  • Switch camera to see more, Token: flip_camera_to_see_more

  • Tilt your head to the side, Token: tilt_head

  • Blink your eyes, Token: blink_eyes

  • Look around through your camera, Token: look_around

  • Move closer, Token: move_camera_closer

  • Switch camera to place on a surface, Token: switch_camera_view_to_place

  • Switch camera, Token: flip_camera

  • Tap to place, Token: tap_to_place

  • Tap to change, Token: tap_to_change

  • Tap to continue, Token: tap_to_advance

  • Tap to add text, Token: tap_to_add_text

  • Talk to change your voice, Token: talk_to_change_voice

  • Shake your head, Token: shake_head

  • Nod your head, Token: nod_head

  • Raise your eyebrows, Token: raise_eyebrows

  • Turn your sound on, Token: effect_include_sound

  • Find a face, Token: find_face

  • Open your mouth, Token: open_mouth

PreviousAsynchronous API Changes (v85+)NextAnimationModule

Last updated 4 years ago

Was this helpful?