Lens Scripting API
    Preparing search index...

    Class AudioEffectComponent

    Used to add effects to audio recorded by the device, such as Robot, Alien, etc.

    When present in the scene, it will automatically apply the selected audio effect to recordings made with the Lens.

    Audio Effect Guide.

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

    Hierarchy (View Summary)

    Index

    Properties

    enabled isEnabledInHierarchy sceneObject uniqueIdentifier

    Methods

    destroy getSceneObject getTransform getTypeName isOfType isSame

    Properties

    enabled: boolean

    If disabled, the Component will stop enacting its behavior.

    isEnabledInHierarchy: boolean

    Returns true if this Component, its SceneObject, and all of that SceneObjects parents are enabled.

    sceneObject: SceneObject

    The SceneObject this component is on.

    uniqueIdentifier: string

    Methods

    • Destroys the component.

      Returns void

    • Returns the name of this object's type.

      Returns string

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

      Parameters

      • type: string

      Returns boolean

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

      Parameters

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Properties
    Methods