XSound - v4.1.3
    Preparing search index...

    Interface Tremolo

    Effector's subclass for Tremolo.

    interface Tremolo {
        context: AudioContext;
        depth: GainNode;
        input: GainNode;
        isActive: boolean;
        lfo: OscillatorNode;
        output: GainNode;
        paused: boolean;
        rate: AudioParam;
        get INPUT(): GainNode;
        get OUTPUT(): GainNode;
        activate(): Tremolo;
        connect(): GainNode;
        deactivate(): Tremolo;
        param(params: "type"): OscillatorType;
        param(params: "depth"): number;
        param(params: "rate"): number;
        param(params: TremoloParams): Tremolo;
        params(): Required<TremoloParams>;
        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 tremolo effector. This method is overloaded for type interface and type check.

      Parameters

      • params: "type"

        This argument is string if getter. Otherwise, setter.

      Returns OscillatorType

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

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

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

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

      Parameters

      • params: TremoloParams

        This argument is string if getter. Otherwise, setter.

      Returns Tremolo

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