XSound - v4.2.0
    Preparing search index...

    Interface PitchShifter

    Effector's subclass for Pitch Shifter.

    interface PitchShifter {
        context: AudioContext;
        depth: GainNode;
        input: GainNode;
        isActive: boolean;
        lfo: OscillatorNode;
        output: GainNode;
        paused: boolean;
        rate: AudioParam;
        get INPUT(): GainNode;
        get OUTPUT(): GainNode;
        activate(): PitchShifter;
        connect(): GainNode;
        deactivate(): PitchShifter;
        param(params: "state"): boolean;
        param(params: "pitch"): number;
        param(params: "speed"): number;
        param(params: "dry"): number;
        param(params: "wet"): number;
        param(params: PitchShifterParams): PitchShifter;
        params(): Required<PitchShifterParams>;
        start(): void;
        state(): boolean;
        stop(): 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 pitch shifter. 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 pitch shifter if getter. Otherwise, return value is for method chain.

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

      Parameters

      • params: "pitch"

        This argument is string if getter. Otherwise, setter.

      Returns number

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

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

      Parameters

      • params: "speed"

        This argument is string if getter. Otherwise, setter.

      Returns number

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

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

      Parameters

      • params: "dry"

        This argument is string if getter. Otherwise, setter.

      Returns number

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

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

      Parameters

      • params: "wet"

        This argument is string if getter. Otherwise, setter.

      Returns number

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

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

      Parameters

      Returns PitchShifter

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

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods