Class AudioEffectComponent

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

Remarks

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

See

Audio Effect Guide.

Example

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

Hierarchy (View Summary, Expand)

Constructors

constructor

Properties

enabled sceneObject uniqueIdentifier

Methods

destroy getSceneObject getTransform getTypeName isOfType isSame

Constructors

Protectedconstructor

Properties

enabled

enabled: boolean

If disabled, the Component will stop enacting its behavior.

ReadonlysceneObject

sceneObject: SceneObject

The scene object this component is on.

ReadonlyuniqueIdentifier

uniqueIdentifier: string

Methods

destroy

  • destroy(): void

    Destroys the component.

    Returns void

getSceneObject

getTransform

getTypeName

  • getTypeName(): string

    Returns the name of this object's type.

    Returns string

isOfType

  • isOfType(type: string): boolean

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

    Parameters

    • type: string

    Returns boolean

isSame

  • isSame(other: ScriptObject): 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

Constructors
Properties
Methods
MMNEPVFCICPMFPCPTTAAATR