XSound - v4.1.3
    Preparing search index...

    Interface OverDrive

    Effector's subclass for OverDrive.

    interface OverDrive {
        context: AudioContext;
        depth: GainNode;
        input: GainNode;
        isActive: boolean;
        lfo: OscillatorNode;
        output: GainNode;
        paused: boolean;
        rate: AudioParam;
        get INPUT(): GainNode;
        get OUTPUT(): GainNode;
        activate(): OverDrive;
        connect(): GainNode;
        deactivate(): OverDrive;
        param(params: "state"): boolean;
        param(params: "drive"): number;
        param(params: "level"): number;
        param(params: "oversample"): OverSampleType;
        param(params: OverDriveParams): OverDrive;
        params(): Required<OverDriveParams>;
        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 overdrive 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 overdrive effector if getter. Otherwise, return value is for method chain.

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

      Parameters

      • params: "drive"

        This argument is string if getter. Otherwise, setter.

      Returns number

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

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

      Parameters

      • params: "level"

        This argument is string if getter. Otherwise, setter.

      Returns number

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

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

      Parameters

      • params: "oversample"

        This argument is string if getter. Otherwise, setter.

      Returns OverSampleType

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

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

      Parameters

      • params: OverDriveParams

        This argument is string if getter. Otherwise, setter.

      Returns OverDrive

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

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods