XSound - v4.2.0
    Preparing search index...

    Interface Flanger

    Effector's subclass for Flanger.

    interface Flanger {
        context: AudioContext;
        depth: GainNode;
        input: GainNode;
        isActive: boolean;
        lfo: OscillatorNode;
        output: GainNode;
        paused: boolean;
        rate: AudioParam;
        get INPUT(): GainNode;
        get OUTPUT(): GainNode;
        activate(): Flanger;
        connect(): GainNode;
        deactivate(): Flanger;
        param(params: "state"): boolean;
        param(params: "time"): number;
        param(params: "depth"): number;
        param(params: "rate"): number;
        param(params: "mix"): number;
        param(params: "dry"): number;
        param(params: "wet"): number;
        param(params: "tone"): number;
        param(params: "feedback"): number;
        param(params: FlangerParams): Flanger;
        params(): Required<FlangerParams>;
        start(startTime?: number): void;
        state(): boolean;
        stop(stopTime?: number, releaseTime?: number): void;
        toJSON(): string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    context depth input isActive lfo output paused rate

    Accessors

    INPUT OUTPUT

    Methods

    activate connect deactivate param params start state stop toJSON

    Properties

    context: AudioContext
    depth: GainNode
    input: GainNode
    isActive: boolean = true
    lfo: OscillatorNode
    output: GainNode
    paused: boolean = true
    rate: AudioParam

    Accessors

    Methods

    • This method gets or sets parameters for flanger effector. This method is overloaded for type interface and type check.

      Parameters

      • params: "state"

        This argument is string if getter. Otherwise, setter.

      Returns boolean

      Return value is parameter for flanger effector if getter. Otherwise, return value is for method chain.

    • This method gets or sets parameters for flanger effector. This method is overloaded for type interface and type check.

      Parameters

      • params: "time"

        This argument is string if getter. Otherwise, setter.

      Returns number

      Return value is parameter for flanger effector if getter. Otherwise, return value is for method chain.

    • This method gets or sets parameters for flanger effector. This method is overloaded for type interface and type check.

      Parameters

      • params: "depth"

        This argument is string if getter. Otherwise, setter.

      Returns number

      Return value is parameter for flanger effector if getter. Otherwise, return value is for method chain.

    • This method gets or sets parameters for flanger effector. This method is overloaded for type interface and type check.

      Parameters

      • params: "rate"

        This argument is string if getter. Otherwise, setter.

      Returns number

      Return value is parameter for flanger effector if getter. Otherwise, return value is for method chain.

    • This method gets or sets parameters for flanger effector. This method is overloaded for type interface and type check.

      Parameters

      • params: "mix"

        This argument is string if getter. Otherwise, setter.

      Returns number

      Return value is parameter for flanger effector if getter. Otherwise, return value is for method chain.

    • This method gets or sets parameters for flanger effector. This method is overloaded for type interface and type check.

      Parameters

      • params: "dry"

        This argument is string if getter. Otherwise, setter.

      Returns number

      Return value is parameter for flanger effector if getter. Otherwise, return value is for method chain.

    • This method gets or sets parameters for flanger effector. This method is overloaded for type interface and type check.

      Parameters

      • params: "wet"

        This argument is string if getter. Otherwise, setter.

      Returns number

      Return value is parameter for flanger effector if getter. Otherwise, return value is for method chain.

    • This method gets or sets parameters for flanger effector. This method is overloaded for type interface and type check.

      Parameters

      • params: "tone"

        This argument is string if getter. Otherwise, setter.

      Returns number

      Return value is parameter for flanger effector if getter. Otherwise, return value is for method chain.

    • This method gets or sets parameters for flanger effector. This method is overloaded for type interface and type check.

      Parameters

      • params: "feedback"

        This argument is string if getter. Otherwise, setter.

      Returns number

      Return value is parameter for flanger effector if getter. Otherwise, return value is for method chain.

    • This method gets or sets parameters for flanger effector. This method is overloaded for type interface and type check.

      Parameters

      • params: FlangerParams

        This argument is string if getter. Otherwise, setter.

      Returns Flanger

      Return value is parameter for flanger effector if getter. Otherwise, return value is for method chain.

    • This method starts LFO. Namely, this method starts effector.

      Parameters

      • OptionalstartTime: number

        This argument is in order to schedule parameter.

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods