XSound - v4.3.10
    Preparing search index...

    Interface AmpSimulator

    Effector's subclass for Amp Simulator.

    interface AmpSimulator {
        context: AudioContext;
        depth: GainNode;
        input: GainNode;
        isActive: boolean;
        lfo: OscillatorNode;
        output: GainNode;
        paused: boolean;
        rate: AudioParam;
        get INPUT(): GainNode;
        get OUTPUT(): GainNode;
        activate(): AmpSimulator;
        connect(): GainNode;
        deactivate(): AmpSimulator;
        param(params: "state"): boolean;
        param(params: "type"): PreampType;
        param(
            params: "preamp",
        ): MarshallParams | MesaBoogieParams | FenderParams | undefined;
        param(params: "cabinet"): SimpleCabinetParams | undefined;
        param(
            params: AmpSimulatorParams,
        ): Marshall | MesaBoogie | Fender | SimpleCabinet;
        params(): Required<AmpSimulatorParams>;
        start(startTime?: number): void;
        state(): boolean;
        stop(stopTime?: number, releaseTime?: number): void;
        toJSON(): string;
    }

    Hierarchy (View Summary)

    Index
    context depth input isActive lfo output paused rate
    INPUT OUTPUT
    activate connect deactivate param params start state stop toJSON
    context: AudioContext
    depth: GainNode
    input: GainNode
    isActive: boolean = true
    lfo: OscillatorNode
    output: GainNode
    paused: boolean = true
    rate: AudioParam

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

    • This method gets or sets parameters for Amp Simulator This method is overloaded for type interface and type check.

      Parameters

      • params: "type"

        This argument is string if getter. Otherwise, setter.

      Returns PreampType

      Return value is parameter for Amp Simulator if getter. Otherwise, return value is for method chain.

    • This method gets or sets parameters for Amp Simulator This method is overloaded for type interface and type check.

      Parameters

      • params: "preamp"

        This argument is string if getter. Otherwise, setter.

      Returns MarshallParams | MesaBoogieParams | FenderParams | undefined

      Return value is parameter for Amp Simulator if getter. Otherwise, return value is for method chain.

    • This method gets or sets parameters for Amp Simulator This method is overloaded for type interface and type check.

      Parameters

      • params: "cabinet"

        This argument is string if getter. Otherwise, setter.

      Returns SimpleCabinetParams | undefined

      Return value is parameter for Amp Simulator if getter. Otherwise, return value is for method chain.

    • This method gets or sets parameters for Amp Simulator This method is overloaded for type interface and type check.

      Parameters

      Returns Marshall | MesaBoogie | Fender | SimpleCabinet

      Return value is parameter for Amp Simulator 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

    • This method stops LFO, then creates instance of OscillatorNode again.

      Parameters

      • OptionalstopTime: number

        This argument is in order to schedule parameter.

      • OptionalreleaseTime: number

        This argument is in order to schedule parameter when it is necessary to consider release time.

      Returns void

    Settings
    Member Visibility

    On This Page
    Properties
    Accessors
    Methods