XSound - v4.3.5
    Preparing search index...

    Interface Chorus

    Effector's subclass for Chorus.

    interface Chorus {
        context: AudioContext;
        depths: [GainNode, GainNode];
        input: GainNode;
        isActive: boolean;
        lfos: [OscillatorNode, OscillatorNode];
        output: GainNode;
        paused: boolean;
        rates: [AudioParam, AudioParam];
        get INPUT(): GainNode;
        get OUTPUT(): GainNode;
        activate(): Chorus;
        connect(): GainNode;
        deactivate(): Chorus;
        param(params: "state"): boolean;
        param(params: "type"): ChorusType;
        param(params: "time"): number | [number, number];
        param(params: "depth"): number | [number, number];
        param(params: "rate"): number | [number, number];
        param(params: "mix"): number | [number, number];
        param(params: "dry"): number;
        param(params: "wet"): number | [number, number];
        param(params: "tone"): number | [number, number];
        param(params: "feedback"): number | [number, number];
        param(params: ChorusParams): Chorus;
        params(): Required<ChorusParams>;
        start(startTime?: number): void;
        state(): boolean;
        stop(stopTime?: number, releaseTime?: number): void;
        toJSON(): string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    context depths input isActive lfos output paused rates

    Accessors

    INPUT OUTPUT

    Methods

    activate connect deactivate param params start state stop toJSON

    Properties

    context: AudioContext
    depths: [GainNode, GainNode]
    input: GainNode
    isActive: boolean = true
    lfos: [OscillatorNode, OscillatorNode]
    output: GainNode
    paused: boolean = true
    rates: [AudioParam, AudioParam]

    Accessors

    Methods

    • This method gets or sets parameters for chorus 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 chorus effector if getter. Otherwise, return value is for method chain.

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

      Parameters

      • params: "type"

        This argument is string if getter. Otherwise, setter.

      Returns ChorusType

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

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

      Parameters

      • params: "time"

        This argument is string if getter. Otherwise, setter.

      Returns number | [number, number]

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

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

      Parameters

      • params: "depth"

        This argument is string if getter. Otherwise, setter.

      Returns number | [number, number]

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

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

      Parameters

      • params: "rate"

        This argument is string if getter. Otherwise, setter.

      Returns number | [number, number]

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

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

      Parameters

      • params: "mix"

        This argument is string if getter. Otherwise, setter.

      Returns number | [number, number]

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

    • This method gets or sets parameters for chorus 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 chorus effector if getter. Otherwise, return value is for method chain.

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

      Parameters

      • params: "wet"

        This argument is string if getter. Otherwise, setter.

      Returns number | [number, number]

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

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

      Parameters

      • params: "tone"

        This argument is string if getter. Otherwise, setter.

      Returns number | [number, number]

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

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

      Parameters

      • params: "feedback"

        This argument is string if getter. Otherwise, setter.

      Returns number | [number, number]

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

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

      Parameters

      • params: ChorusParams

        This argument is string if getter. Otherwise, setter.

      Returns Chorus

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

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods