XSound - v4.0.10
    Preparing search index...

    Class Compressor

    Effector's subclass for Compressor.

    Hierarchy (View Summary)

    Index

    Constructors

    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 compressor. 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 compressor if getter. Otherwise, return value is for method chain.

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

      Parameters

      • params: "threshold"

        This argument is string if getter. Otherwise, setter.

      Returns number

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

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

      Parameters

      • params: "knee"

        This argument is string if getter. Otherwise, setter.

      Returns number

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

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

      Parameters

      • params: "ratio"

        This argument is string if getter. Otherwise, setter.

      Returns number

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

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

      Parameters

      • params: "attack"

        This argument is string if getter. Otherwise, setter.

      Returns number

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

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

      Parameters

      • params: "release"

        This argument is string if getter. Otherwise, setter.

      Returns number

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

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

      Parameters

      Returns Compressor

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