@sv443-network/userutils 2.0.0 → 2.0.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @sv443-network/userutils
 
+## 2.0.1
+
+### Patch Changes
+
+- 63af1a7: Change default limiter options to be more balanced
+
 ## 2.0.0
 
 ### Major Changes

package/README.md

@@ -490,7 +490,7 @@ This is the processing workflow applied to the media element:
   
 A limiter (compression) is applied to the audio to prevent clipping.  
 Its properties can be changed by calling the returned function `setLimiterOptions()`  
-The default props are `{ threshold: -2, knee: 40, ratio: 12, attack: 0.003, release: 0.25 }`  
+The limiter options set by default are `{ threshold: -12, knee: 30, ratio: 12, attack: 0.003, release: 0.25 }`  
   
 ⚠️ This function has to be run in response to a user interaction event, else the browser will reject it because of the strict autoplay policy.  
 ⚠️ Make sure to call the returned function `enable()` after calling this function to actually enable the amplification.  
@@ -502,7 +502,7 @@ The returned object of the type `AmplifyMediaResult` has the following propertie
 | `getGain()` | Returns the current gain multiplier |
 | `enable()` | Call to enable the amplification for the first time or if it was disabled before |
 | `disable()` | Call to disable amplification |
-| `setLimiterOptions()` | Used for changing the [options of the DynamicsCompressorNode](https://developer.mozilla.org/en-US/docs/Web/API/DynamicsCompressorNode/DynamicsCompressorNode#options) - the default is `{ threshold: -2, knee: 40, ratio: 12, attack: 0.003, release: 0.25 }` |
+| `setLimiterOptions()` | Used for changing the [options of the DynamicsCompressorNode](https://developer.mozilla.org/en-US/docs/Web/API/DynamicsCompressorNode/DynamicsCompressorNode#options) - the default is `{ threshold: -12, knee: 30, ratio: 12, attack: 0.003, release: 0.25 }` |
 | `context` | The AudioContext instance |
 | `source` | The MediaElementSourceNode instance |
 | `gainNode` | The GainNode instance used for actually boosting the gain |

package/dist/index.global.js

@@ -9,7 +9,7 @@
 // ==UserLibrary==
 // @name         UserUtils
 // @description  Library with various utilities for userscripts - register listeners for when CSS selectors exist, intercept events, manage persistent user configurations, modify the DOM more easily and more
-// @version      2.0.0
+// @version      2.0.1
 // @license      MIT
 // @copyright    Sv443 (https://github.com/Sv443)
 
@@ -341,7 +341,7 @@ var UserUtils = (function (exports) {
       },
       /**
        * Set the options of the [limiter / DynamicsCompressorNode](https://developer.mozilla.org/en-US/docs/Web/API/DynamicsCompressorNode/DynamicsCompressorNode#options)  
-       * The default is `{ threshold: -2, knee: 40, ratio: 12, attack: 0.003, release: 0.25 }`
+       * The default is `{ threshold: -12, knee: 30, ratio: 12, attack: 0.003, release: 0.25 }`
        */
       setLimiterOptions(options) {
         for (const [key, val] of Object.entries(options))
@@ -353,8 +353,8 @@ var UserUtils = (function (exports) {
       limiterNode: context.createDynamicsCompressor()
     };
     props.setLimiterOptions({
-      threshold: -2,
-      knee: 40,
+      threshold: -12,
+      knee: 30,
       ratio: 12,
       attack: 3e-3,
       release: 0.25

package/dist/index.js

@@ -320,7 +320,7 @@ function amplifyMedia(mediaElement, initialMultiplier = 1) {
     },
     /**
      * Set the options of the [limiter / DynamicsCompressorNode](https://developer.mozilla.org/en-US/docs/Web/API/DynamicsCompressorNode/DynamicsCompressorNode#options)  
-     * The default is `{ threshold: -2, knee: 40, ratio: 12, attack: 0.003, release: 0.25 }`
+     * The default is `{ threshold: -12, knee: 30, ratio: 12, attack: 0.003, release: 0.25 }`
      */
     setLimiterOptions(options) {
       for (const [key, val] of Object.entries(options))
@@ -332,8 +332,8 @@ function amplifyMedia(mediaElement, initialMultiplier = 1) {
     limiterNode: context.createDynamicsCompressor()
   };
   props.setLimiterOptions({
-    threshold: -2,
-    knee: 40,
+    threshold: -12,
+    knee: 30,
     ratio: 12,
     attack: 3e-3,
     release: 0.25

package/dist/index.mjs

@@ -318,7 +318,7 @@ function amplifyMedia(mediaElement, initialMultiplier = 1) {
     },
     /**
      * Set the options of the [limiter / DynamicsCompressorNode](https://developer.mozilla.org/en-US/docs/Web/API/DynamicsCompressorNode/DynamicsCompressorNode#options)  
-     * The default is `{ threshold: -2, knee: 40, ratio: 12, attack: 0.003, release: 0.25 }`
+     * The default is `{ threshold: -12, knee: 30, ratio: 12, attack: 0.003, release: 0.25 }`
      */
     setLimiterOptions(options) {
       for (const [key, val] of Object.entries(options))
@@ -330,8 +330,8 @@ function amplifyMedia(mediaElement, initialMultiplier = 1) {
     limiterNode: context.createDynamicsCompressor()
   };
   props.setLimiterOptions({
-    threshold: -2,
-    knee: 40,
+    threshold: -12,
+    knee: 30,
     ratio: 12,
     attack: 3e-3,
     release: 0.25

package/dist/lib/dom.d.ts

@@ -80,7 +80,7 @@ export declare function amplifyMedia<TElem extends HTMLMediaElement>(mediaElemen
     disable(): void;
     /**
      * Set the options of the [limiter / DynamicsCompressorNode](https://developer.mozilla.org/en-US/docs/Web/API/DynamicsCompressorNode/DynamicsCompressorNode#options)
-     * The default is `{ threshold: -2, knee: 40, ratio: 12, attack: 0.003, release: 0.25 }`
+     * The default is `{ threshold: -12, knee: 30, ratio: 12, attack: 0.003, release: 0.25 }`
      */
     setLimiterOptions(options: Partial<Record<"threshold" | "knee" | "ratio" | "attack" | "release", number>>): void;
     context: AudioContext;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sv443-network/userutils",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "Library with various utilities for userscripts - register listeners for when CSS selectors exist, intercept events, manage persistent user configurations, modify the DOM more easily and more",
   "main": "dist/index.js",
   "module": "dist/index.mjs",