XSound - v4.3.10
    Preparing search index...

    Interface BitCrusher

    Effector's subclass for BitCrusher.

    interface BitCrusher {
        context: AudioContext;
        depth: GainNode;
        input: GainNode;
        isActive: boolean;
        lfo: OscillatorNode;
        output: GainNode;
        paused: boolean;
        rate: AudioParam;
        get INPUT(): GainNode;
        get OUTPUT(): GainNode;
        activate(): BitCrusher;
        connect(): GainNode;
        deactivate(): BitCrusher;
        param(params: "state"): boolean;
        param(params: "bits"): number;
        param(params: "oversample"): OverSampleType;
        param(params: BitCrusherParams): BitCrusher;
        params(): Required<BitCrusherParams>;
        start(_startTime?: number): void;
        state(): boolean;
        stop(_stopTime?: number, _releaseTime?: number): void;
        toJSON(): string;
    }

    Hierarchy (View Summary)

    Index
    context depth input isActive lfo output paused rate
    INPUT OUTPUT
    activate connect deactivate param params start state stop toJSON
    context: AudioContext
    depth: GainNode
    input: GainNode
    isActive: boolean = true
    lfo: OscillatorNode
    output: GainNode
    paused: boolean = true
    rate: AudioParam

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

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

      Parameters

      • params: "bits"

        This argument is string if getter. Otherwise, setter.

      Returns number

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

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

      Parameters

      • params: "oversample"

        This argument is string if getter. Otherwise, setter.

      Returns OverSampleType

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

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

      Parameters

      • params: BitCrusherParams

        This argument is string if getter. Otherwise, setter.

      Returns BitCrusher

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

    Settings
    Member Visibility

    On This Page
    Properties
    Accessors
    Methods