XSound - v4.1.3
    Preparing search index...

    Interface EffectorAbstract

    This class is superclass for effector classes. Also, this class is used for implementing custom effector.

    interface Effector {
        context: AudioContext;
        depth: GainNode;
        input: GainNode;
        isActive: boolean;
        lfo: OscillatorNode;
        output: GainNode;
        paused: boolean;
        rate: AudioParam;
        get INPUT(): GainNode;
        get OUTPUT(): GainNode;
        activate(): Effector;
        connect(): GainNode;
        deactivate(): Effector;
        params(): void;
        start(startTime?: number): void;
        state(): boolean;
        stop(stopTime?: number, releaseTime?: number): void;
        toJSON(): string;
    }

    Hierarchy (View Summary)

    Implements

    Index

    Properties

    context depth input isActive lfo output paused rate

    Accessors

    INPUT OUTPUT

    Methods

    activate connect deactivate 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 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