version 5.0.0 (alpha)

[hvianna]

WARNING: code in alpha stage is subject to major, drastic changes! DO NOT USE THIS VERSION IN PRODUCTION!

Source code is in the version5 branch. Demo is available at https://audiomotion.dev/demo/alpha/

What's new in v5.0.0-alpha.2

• connectInput() and the constructor's source property now accept MediaStream objects (#96);
• disconnectInput() now also accepts HTMLMediaElement and MediaStream objects.
• noteLabels property has been removed and its functionality has been consolidated into showScaleX;
• showScaleX value type has changed to string;
• showScaleY value type has changed to string and now allows choosing dB or percentage labels;
• peaks property name changed back to showPeaks;
• setXAxis() renamed to setScaleX() - removed addLabels and height properties, added fontSize;
• setYAxis() renamed to setScaleY() - removed linearInterval and width properties, added percentInterval and fontSize, new default value of 6dB for dbInterval;
• Added getScaleX() and getScaleY() methods;
• Added 3dB/oct and 4.5db/oct tilt filters to weightingFilter - props to @will-hut (#107).
• weightingFilter values are now normalized to lowercase. The value for no-filter has changed from "" (empty string) to "none".
• Changed RADIAL_INNER and RADIAL_OUTER constant names to RADIAL_INWARD and RADIAL_OUTWARD.

The full list of changes for v5 are provided below.

Version 5 overview:

• Expect LOTS of breaking changes 😅 - I'm taking this opportunity to consolidate related properties and make some long-overdue changes;
• Gradients are now called Themes - new peakColor property in registerTheme() and on-the-fly horizontal and reverse gradient generation;
• LED bars look better and are easier to customize - see showLedMask and setLeds();
• X- and Y-axis scales are now customizable - setScaleX() and setScaleY();
• The analyzer canvas is now always transparent, so all background-related properties are gone, including bgColor in the theme definition;
• No more errors thrown for non-critical issues, like invalid option values;
• The onCanvasDraw callback is now passed all color information from the currently active themes (fillStyle and strokeStyle are no longer explicitly set).

🚨 BREAKING CHANGES:

Modified properties	Changes made
alphaBars	type changed from boolean to string
ledBars	type changed from boolean to string
mode	type changed from number to string
peakLine	type changed from boolean to number
radial	type changed from boolean to number
showPeaks	type changed from boolean to string
showScaleX	type changed from boolean to string
showScaleY	type changed from boolean to string
weightingFilter	values are now normalized to lowercase. The value for no-filter has changed from "" (empty string) to "none".

Removed methods and properties	Use this instead
bgAlpha	set desired background color/opacity via CSS on canvas element
fadePeaks	showPeaks = "fade"
gradient	setTheme(name) / getTheme()
gradientLeft	setTheme(name, 0) / getTheme(0)
gradientRight	setTheme(name, 1) / getTheme(1)
gravity	peakDecayTime — use the peak drop analysis tool to compare/migrate previous customizations
isLumiBars	isAlphaBars
lumiBars	alphaBars = "full"
noteLabels	showScaleX = "notes"
peakFadeTime	peakDecayTime
radialInvert	radial = -1
registerGradient()	registerTheme()
setLedParams()	setLeds()
showBgColor	set desired background color via CSS on container element
splitGradient	spreadGradient
stereo	channelLayout
trueLeds	ledBars = "vintage"
overlay	always transparent now (equivalent to overlay: true) — if desired, set an opaque background color via CSS

Added:

• bandResolution property;
• getThemeData() and getThemeList() mehods;
• peakColor property in theme definition - see registerTheme();
• registerTheme() and unregisterTheme() methods;
• setTheme() and getTheme() methods;
• setThemeModifiers() and getThemeModifiers() methods;
• toggleThemeModifier() method;
• setScaleX() / setScaleY() and getScaleX() / getScaleY() methods;
• showLedMask property;
• New 3dB/oct and 4.5db/oct tilt filters added to weightingFilter - props to @will-hut (#107);
• Exported constants.

Changed:

• Minor color offset adjustments in the "classic" theme - the old values can be found in this Discussions post;
• The "fschange" value for reason in the onCanvasResize callback has been changed to "fullscreenchange". You can use the new constants exported by the module for future-proof checks.
• New default values:

Property	New default value	Previous default value
fillAlpha	0.5	1
lineWidth	1	0
maxDecibels	-30	25
minDecibels	-90	-85
radius	0.5	0.3
smoothing	0.7	0.5

Improved:

• connectInput() and the constructor's source property now accept MediaStream objects (#96);
• disconnectInput() now also accepts HTMLMediaElement and MediaStream objects;
• Full-height alphaBars (former lumiBars) have been extended to work with radial and FFT bandResolution (former mode 0);
• Y-axis labels are no longer mirrored when mirror is active.