XSound - v4.2.0
    Preparing search index...

    Interface Panner

    Effector's subclass for Panner.

    interface Panner {
        context: AudioContext;
        depth: GainNode;
        input: GainNode;
        isActive: boolean;
        lfo: OscillatorNode;
        output: GainNode;
        paused: boolean;
        rate: AudioParam;
        get INPUT(): GainNode;
        get OUTPUT(): GainNode;
        activate(): Panner;
        connect(): GainNode;
        deactivate(): Panner;
        param(params: "state"): boolean;
        param(params: "x"): number;
        param(params: "y"): number;
        param(params: "z"): number;
        param(params: "ox"): number;
        param(params: "oy"): number;
        param(params: "oz"): number;
        param(params: "refDistance"): number;
        param(params: "maxDistance"): number;
        param(params: "rolloffFactor"): number;
        param(params: "coneInnerAngle"): number;
        param(params: "coneOuterAngle"): number;
        param(params: "coneOuterGain"): number;
        param(params: "panningModel"): PanningModelType;
        param(params: "distanceModel"): DistanceModelType;
        param(params: PannerParams): Panner;
        params(): Required<PannerParams>;
        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 panner. 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 panner if getter. Otherwise, return value is for method chain.

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

      Parameters

      • params: "x"

        This argument is string if getter. Otherwise, setter.

      Returns number

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

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

      Parameters

      • params: "y"

        This argument is string if getter. Otherwise, setter.

      Returns number

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

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

      Parameters

      • params: "z"

        This argument is string if getter. Otherwise, setter.

      Returns number

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

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

      Parameters

      • params: "ox"

        This argument is string if getter. Otherwise, setter.

      Returns number

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

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

      Parameters

      • params: "oy"

        This argument is string if getter. Otherwise, setter.

      Returns number

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

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

      Parameters

      • params: "oz"

        This argument is string if getter. Otherwise, setter.

      Returns number

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

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

      Parameters

      • params: "refDistance"

        This argument is string if getter. Otherwise, setter.

      Returns number

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

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

      Parameters

      • params: "maxDistance"

        This argument is string if getter. Otherwise, setter.

      Returns number

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

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

      Parameters

      • params: "rolloffFactor"

        This argument is string if getter. Otherwise, setter.

      Returns number

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

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

      Parameters

      • params: "coneInnerAngle"

        This argument is string if getter. Otherwise, setter.

      Returns number

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

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

      Parameters

      • params: "coneOuterAngle"

        This argument is string if getter. Otherwise, setter.

      Returns number

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

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

      Parameters

      • params: "coneOuterGain"

        This argument is string if getter. Otherwise, setter.

      Returns number

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

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

      Parameters

      • params: "panningModel"

        This argument is string if getter. Otherwise, setter.

      Returns PanningModelType

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

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

      Parameters

      • params: "distanceModel"

        This argument is string if getter. Otherwise, setter.

      Returns DistanceModelType

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

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

      Parameters

      • params: PannerParams

        This argument is string if getter. Otherwise, setter.

      Returns Panner

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