Lens Scripting API
    Preparing search index...

    Class DirectivityEffect

    An Audio Component effect that simulates sound attenuation based on the orientation of the transform relative to the AudioListenerComponent.

    // @input Component.AudioComponent audio

    var spatialAudio = script.audio.spatialAudio;
    var directivityEffect = spatialAudio.directivityEffect;
    directivityEffect.enabled = true;
    directivityEffect.shapeDecay = 10;
    directivityEffect.shapeFactor = 0.5;

    Hierarchy (View Summary)

    Index

    Properties

    enabled shapeDecay shapeFactor

    Methods

    getTypeName getTypeName isOfType isSame

    Properties

    enabled: boolean

    Whether the audio directivity effect is applied or not.

    Lens Scripting Version 147

    false
    shapeDecay: number

    The width of main lobe.

    Lens Scripting Version 147

    1
    shapeFactor: number

    A ratio that specifies the shape of pattern directivity from omnidirectional(0) to cardioid (1.0).

    Lens Scripting Version 147

    1

    Methods

    • Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

      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