# Asynchronous API Changes (v85+) With v85 of Spark AR Studio the current JavaScript API will be deprecated in favor of asynchronous APIs. This means some APIs will be deprecated and will need to be replaced in your projects. When creating new projects, new APIs should be used instead. ### What happens to existing projects APIs will be deprecated after 6 months in existing live effects, and 3 months in resubmitted projects. If you’re using a deprecated API, you’ll: 1. See a message in Spark AR Studio when you open the project. 2. Get an email and notification to let you know how to update it. ## New APIs ## Deprecated `BlendShapesMesh` **Note: duplicated functionality of Array\** ## `BlockSceneRoot` **Added inputs.setBoolean(name: String, signal: BoolSignal): Promise\** * Deprecates `setBooleanInput(name: String, signal: BoolSignal): void` **Added inputs.setColor(name: String, signal: ColorSignal): Promise\** * Deprecates `setColorInput(name: String, signal: ColorSignal): void` **Added inputs.setPoint(name: String, signal: PointSignal): Promise\** * Deprecates `setPointInput(name: String, signal: PointSignal): void` **Added inputs.setPoint2D(name: String, signal: PixelPointSignal): Promise\** * Deprecates `setPixelPointInput(name: String, signal: PixelPointSignal): void` **Added inputs.setScalar(name: String, signal: ScalarSignal): Promise\** * Deprecates `setScalarInput(name: String, signal: ScalarSignal): void` **Added inputs.setShader(name: String, signal: ShaderSignal): Promise\** * Deprecates `setShaderInput(name: String, signal: ShaderSignal): void` **Added inputs.setString(name: String, signal: StringSignal): Promise\** * Deprecates `setStringInput(name: String, signal: StringSignal): void` **Added inputs.setVector(name: String, signal: VectorSignal): Promise\** * Deprecates `setVectorInput(name: String, signal: VectorSignal): void` **Added outputs.getBoolean(name: String): Promise\** * Deprecates `getBooleanOutput(name: String): BoolSignal` **Added outputs.getBooleanOrFallback(name: String, fallback: BoolSignal): BoolSignal** **Added outputs.getColor(name: String): Promise\** * Deprecates `getColorOutput(name: String): ColorSignal` **Added outputs.getColorOrFallback(name: String, fallback: ColorSignal): ColorSignal** **Added outputs.getPoint(name: String): Promise\** * Deprecates `getPointOutput(name: String): PointSignal` **Added outputs.getPointOrFallback(name: String, fallback: PointSignal): PointSignal** **Added outputs.getPoint2D(name: String): Promise\** * Deprecates `getPixelPointOutput(name: String): PixelPointSignal` **Added outputs.getPoint2DOrFallback(name: String, fallback: PixelPointSignal): PixelPointSignal** **Added outputs.getScalar(name: String): Promise\** * Deprecates `getScalarOutput(name: String): ScalarSignal` **Added outputs.getScalarOrFallback(name: String, fallback: ScalarSignal): ScalarSignal** **Added outputs.getShader(name: String): Promise\** * Deprecates `getShaderOutput(name: String): ShaderSignal` **Added outputs.getShaderOrFallback(name: String, fallback: ShaderSignal): ShaderSignal** **Added outputs.getString(name: String): Promise\** * Deprecates `getStringOutput(name: String): StringSignal` **Added outputs.getStringOrFallback(name: String, fallback: StringSignal): StringSignal** **Added outputs.getVector(name: String): Promise\** * Deprecates `getVectorOutput(name: String): VectorSignal` **Added outputs.getVectorOrFallback(name: String, fallback: VectorSignal): VectorSignal** ## `Canvas` **Added void setMode(mode: Signal\, config { fallback: SceneModule.RenderMode }): void** **Added (get) mode: Signal\** * Deprecates `(get) renderMode: SceneModule.RenderMode` **Added (set) mode: Signal\** * Deprecates `(set) renderMode: SceneModule.RenderMode` ## `CustomMaterial` **Added getBoolParameter(paramName: string): Promise\** * Deprecates `boolParameter(paramName: string): BoolValue` **Added getBoolParameterOrFallback(paramName: string, fallback: BoolSignal): BoolSignal** **Added getFloatParameter(paramName: string): Promise\** * Deprecates `floatParameter(paramName: string): ScalarValue` #### Added `getFloatParameterOrFallback(paramName: string, fallback: ScalarSignal): ScalarSignal` **Added getTexture(paramName: string): Promise\** **Added setBoolParameter(paramName: string, source: BoolSignal): Promise\** * Deprecates `setBoolParameter(paramName: string, source: BoolSignal): void` **Added setFloatParameter(paramName: string, source: ScalarSignal): Promise\** * Deprecates `setFloatParameter(paramName: string, source: ScalarSignal): void` **Added setTexture(paramName: string, texture: TextureBase): Promise\** * Deprecates `setTexture(paramName: string, texture: TextureBase): void` ## `DefaultMaterial` **Added getEmissive(): Promise\** * Deprecates `(get) emissive: TextureBase` **Added getMultiply(): Promise\** * Deprecates `(get) multiply: TextureBase` **Added getReflective(): Promise\** * Deprecates `(get) reflective: TextureBase` ## `DiagnosticsModule` **Added typeSystem.getTypeDescriptions(): Promise\** * Deprecates `getTypeDescriptions(): Object` **Added typeSystem.getModuleNames(): Promise\>** * Deprecates `getModuleNames(): Array` ## `Face` **Deprecated and marked for removal deformationCoefficientAt(index: number): ScalarSignal** **Deprecated and marked for removal landmark2D(index: number): PointSignal** #### `FaceMesh` **Added getMaterial(): Promise\** * Deprecates `(get) material: MaterialBase` ## `FontsModule` **Deprecated get(fontName: string): FontId** * Use `findUsingPattern(namePattern: string, config: {limit: number}): Promise>` family of methods instead ## `InstructionModule` **Added (get) automaticHintsEnabled: BoolSignal** * Deprecates `(get) automaticInstructionsEnabled: boolean` **Added (set) automaticHintsEnabled: BoolSignal** * Deprecates `(set) automaticInstructionsEnabled: boolean` ## `LocaleModule` **Deprecated (get) fromDevice: string** * Use `(get) locale: StringSignal` instead ## `MaterialBase` **Added getDiffuse(): Promise\** * Deprecates `(get) diffuse: TextureBase` ## `MaterialsModule` **Deprecated get(materialName: string): MaterialBase** * Use `findUsingPattern(namePattern: string, config: {limit: number}): Promise>` family of methods instead ## `Mesh` **Added getMaterial(): Promise\** * Deprecates `(get) material: MaterialBase` **Deprecated (get) blendShapes: BlendShapesMesh** * Use `getBlendShapes(): Promise>` instead **Deprecated (get) materialIdentifier: String** * Use `getMaterial(): Promise` instead ## `MetallicRoughnessPbrMaterial` **Added getBaseColor(): Promise\** * Deprecates `(get) baseColor: TextureBase` **Added getEmissive(): Promise\** * Deprecates `(get) emissive: TextureBase` **Added getMetallicRoughness(): Promise\** * Deprecates `(get) metallicRoughness: TextureBase` ## `ParticleSystem` **Added getMaterial(): Promise\** * Deprecates `(get) material: MaterialBase` **Added getTypes(): Promise\>** * Deprecates `(get) types: Array` **Added (get) innerRadius: ScalarSignal** * Deprecates `(get) innerRadius: ScalarValue` **Added (get) outerRadius: ScalarSignal** * Deprecates `(get) outerRadius: ScalarValue` #### Deprecated `ParticleTypeDescriptions` **Note: duplicated functionality of Array\** ## `PatchesModule` **Added inputs.setBoolean(name: String, signal: BoolSignal): Promise\** * Deprecates `nsetBooleanValue(name: String, signal: BoolSignal): void` **Added inputs.setColor(name: String, signal: ColorSignal): Promise\** * Deprecates `setColorValue(name: String, signal: ColorSignal): void` **Added inputs.setPoint(name: String, signal: PointSignal): Promise\** * Deprecates `setPointValue(name: String, signal: PointSignal): void` **Added inputs.setPoint2D(name: String, signal: PixelPointSignal): Promise\** * Deprecates `setPoint2DValue(name: String, signal: PixelPointSignal): void` **Added inputs.setPulse(name: String, signal: EventSource): Promise\** * Deprecates `setPulseValue(name: String, signal: EventSource): void` **Added inputs.setScalar(name: String, signal: ScalarSignal): Promise\** * Deprecates `setScalarValue(name: String, signal: ScalarSignal): void` **Added inputs.setString(name: String, signal: StringSignal): Promise\** * Deprecates `setStringValue(name: String, signal: StringSignal): void` **Added inputs.setVector(name: String, signal: VectorSignal): Promise\** * Deprecates `setVectorValue(name: String, signal: VectorSignal): void` **Added outputs.getBoolean(name: String): Promise\** * Deprecates `getBooleanValue(name: String): BoolSignal` **Added outputs.getBooleanOrFallback(name: String, fallback: BoolSignal): BoolSignal** **Added outputs.getColor(name: String): Promise\** * Deprecates `getColorValue(name: String): ColorSignal` **Added outputs.getColorOrFallback(name: String, fallback: ColorSignal): ColorSignal** **Added outputs.getPoint(name: String): Promise\** * Deprecates `getPointValue(name: String): PointSignal` **Added outputs.getPointOrFallback(name: String, fallback: PointSignal): PointSignal** **Added outputs.getPoint2D(name: String): Promise\** * Deprecates `getPoint2DValue(name: String): PixelPointSignal` **Added outputs.getPoint2DOrFallback(name: String, fallback: PixelPointSignal): PixelPointSignal** **Added outputs.getPulse(name: String): Promise\** * Deprecates `getPulseValue(name: String): EventSource` **Added outputs.getScalar(name: String): Promise\** * Deprecates `getScalarValue(name: String): ScalarSignal` **Added outputs.getScalarOrFallback(name: String, fallback: ScalarSignal): ScalarSignal** **Added outputs.getString(name: String): Promise\** * Deprecates `getStringValue(name: String): StringSignal` **Added outputs.getStringOrFallback(name: String, fallback: StringSignal): StringSignal** **Added outputs.getVector(name: String): Promise\** * Deprecates `getVectorValue(name: String): VectorSignal` **Added outputs.getVectorOrFallback(name: String, fallback: VectorSignal): VectorSignal** ## `PlanarImage` **Added getMaterial(): Promise\** * Deprecates `(get) material: MaterialBase` #### `PlanarText` **Added getMaterial(): Promise\** * Deprecates `(get) material: MaterialBase` ## `Plane` **Added getMaterial(): Promise\** * Deprecates `(get) material: MaterialBase` #### `SceneObjectBase` **Deprecated (get) materialIdentifier: string** * Use `getMaterial(): Promise` on `SceneObjectBase` which support materials **Deprecated find(name: string): SceneObjectBase** * Use `findByPath(pathQuery: string, config: {limit: number}): Promise>` family of methods instead **Deprecated child(name: string): SceneObjectBase** * Use `findByPath(pathQuery: string, config: {limit: number}): Promise>` family of methods instead ## `Scene` **Deprecated find(name: string): SceneObjectBase** * Use `findByPath(pathQuery: string, config: {limit: number}): Promise>` family of methods instead **Deprecated child(name: string): SceneObjectBase** * Use `findByPath(pathQuery: string, config: {limit: number}): Promise>` family of methods instead ## `SvgImage` **Added getSvg(): Promise\** ## `SvgsModule` **Deprecated get(svgName: string): Svg** * Use `findUsingPattern(namePattern: string, config: {limit: number}): Promise>` family of methods instead ## `TextAlignmentWrapper` **Added (get) horizontal: Signal\** **Added (set) horizontal: Signal\** * Deprecates `(set) horizontal: TextAlignment` **Added (get) vertical: Signal\** **Added (set) vertical: Signal\** * Deprecates `(set) vertical: VerticalTextAlignment` ## `TextExtrusion` **Added getFrontMaterial(): Promise\** **Added getFont(): Promise\** **Added getBackMaterial(): Promise\** **Added getSideMaterial(): Promise\** **Deprecated (set) faceMaterial: MaterialBase** * Use `(set) frontMaterial: MaterialBase` and `(set) backMaterial: MaterialBase` instead ## `TexturesModule` **Deprecated get(textureName: string): TextureBase** * Use `findUsingPattern(namePattern: string, config: {limit: number}): Promise>` family of methods instead **Asynchronous API Changes (v85+)** With v85 of Spark AR Studio the current JavaScript API will be deprecated in favor of asynchronous APIs. This means some APIs will be deprecated and will need to be replaced in your projects. When creating new projects, new APIs should be used instead. **What happens to existing projects** APIs will be deprecated after 6 months in existing live effects, and 3 months in resubmitted projects. If you’re using a deprecated API, you’ll: 1. See a message in Spark AR Studio when you open the project. 2. Get an email and notification to let you know how to update it. \*\*\*\*