XSound - v4.3.5
    Preparing search index...

    Interface StereoEffectorAbstract

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

    interface StereoEffector {
        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(): StereoEffector;
        connect(): GainNode;
        deactivate(): StereoEffector;
        params(): void;
        start(startTime?: number): void;
        state(): boolean;
        stop(stopTime?: number, releaseTime?: number): void;
        toJSON(): string;
    }

    Hierarchy (View Summary)

    Implements

    Index

    Properties

    context depths input isActive lfos output paused rates

    Accessors

    INPUT OUTPUT

    Methods

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