AudioEffectComponent

Lens Studio v1.7.0+

Scripting Name: Component.AudioEffectComponent

Inherits from Component

Description

Used to add an audio effect to a Lens. When present in the scene, it will automatically apply the selected audio effect to recordings made with the Lens. See the Audio Effect guide for more information.

Inherited Methods

---

destroy() : void

Destroys the component.

---

getSceneObject() : SceneObject

Returns the SceneObject the component is attached to.

---

getTransform() : Transform

Returns the Transform this component is attached to.

---

getTypeName() : String

Returns the name of this object’s type.

---

isOfType(String type) : Boolean

Returns true if the object matches or derives from the passed in type.

---

isSame(ScriptObject other) : Boolean

Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

Inherited Properties

---

enabled : Boolean

If disabled, the Component will stop enacting its behavior.

Examples

// Disable the audio effect
// @input Component.AudioEffectComponent audioEffect
script.audioEffect.enabled = false;