Skip to content

Latest commit

 

History

History
417 lines (262 loc) · 19.2 KB

File metadata and controls

417 lines (262 loc) · 19.2 KB

User's Manual

screenshot2

Top panel buttons

ui-buttons

  • Settings - open / close the Settings panel

  • Config - open the Config panel

  • Console - open / close the message Console

  • PIP - display the spectrum analyzer in a Picture-In-Picture window (disabled on unsupported browsers)

  • Fullscreen - display the spectrum analyzer in fullscreen

  • Help - show audioMotion version, documentation links and the keyboard shortcuts

Source and Speakers

ui-source

Move the Source switch to the MIC position to visualize audio from your microphone instead of the music player. When MIC is selected, the Speakers are automatically turned off to prevent feedback loops from the speakers. If you're using headphones you can safely turn the Speakers on to listen to the microphone audio.

Please note that microphone access is only allowed in a secure context, i.e., if you're accessing audioMotion on localhost, via local file (open index.html file) or HTTPS protocol.

If your sound card supports Stereo mix mode, this option may be listed as an input device when you set the Source to MIC. The Stereo mix input allows audioMotion to read audio generated by any program running in your PC.

Player controls

button action
ui-player-play-pause Play / pause
ui-player-previous Previous track - Hold to rewind
ui-player-stop Stop playback and reset the queue pointer to the first song
ui-player-next Next track - Hold to fast forward
ui-player-shuffle Shuffle queue and start playback
ui-player-repeat Play queue on repeat

Balance and Volume

ui-volume

Hover the mouse over the Balance and Volume knobs and use the mouse wheel to adjust them.

Double-click the Balance knob to center it.

Balance can also be adjusted with Shift + Left and Right arrow keys, and Volume with the Up and Down arrow keys.

Your volume and balance settings will be automatically restored next time you open audioMotion.

File explorer and play queue

files-panel

The file explorer allows you to navigate through the music folder shared by the server.

Supported file extensions are flac, m4a, mp3, ogg and wav for music files, and m3u or m3u8 for playlists. Codec support may vary, depending on your web browser and operating system.

Any image file found in the current folder will be shown in the background of the file explorer, giving preference to filenames containing the words cover, folder or front (in this order).

Double-click a music or playlist file to quickly add it to the queue. Hold Ctrl to select multiple files, or Shift to select a range of files.

You can drag and drop selected files into the play queue, or use the buttons:

button action
Upload file Play any music file from your computer, even if it's not in the shared folder. Uploaded files can't be added to queue or saved to playlists.
Add from URL Load a remote audio file or stream from an URL
Add selected Add currently selected files in the file explorer to the play queue
Add all files Add all files in the current folder to the play queue

Using the play queue and playlists

Double-click a queued song to play it.

Drag and drop songs to reorder them inside the queue. Hold Ctrl to select multiple files, or Shift to select a range. Press Delete (Backspace on Mac) to remove selected songs from the queue.

You can save the current play queue by clicking the Save as... button. Use the Clear button to clear the queue.

Saved playlists are stored locally in your browser and appear in the playlist selection box.

Select a playlist and click one of the buttons:

Button Action
folder-button Load the selected playlist. Please note that the playlist contents will be added to the current queue.
disk-button Update the selected playlist with the current queue contents
trash-button Permanently delete the selected playlist

Settings Panel

Mode

Selects the visualization mode.

Mode Description
Discrete frequencies Displays amplitudes of individual frequencies, as provided by the FFT computation
Area graph Uses the discrete frequency data points to create a filled area graph
Line graph Connects all the discrete data points in a continuous line graph - line width and fill opacity can be customized
Octave bands Frequencies are grouped in bands, each one representing the nth part of an octave

You can also select the visualization mode using the M and Shift + M keyboard shortcuts.

Random Mode

The visualization mode and several other settings may be randomized on track change or time interval.

If the AUTO Gradient switch is active, a random gradient will be selected on every mode change.

You can choose which settings may be changed by random mode in the Config panel.

Bar spacing

This setting is effective only when an octave bands mode is selected. Avaliable options are:

Bar Spacing Description
Legacy ~1px spacing between analyzer bars
Narrow 10% spacing, 90% bar width (default)
Regular 25% spacing, 75% bar width
Wide 50% spacing, 50% bar width
Extra wide 75% spacing, 25% bar width

Line Width and Fill Opacity

These settings are effective only for Line graph mode or when OUTLINE effect is on.

Line Width controls the thickness of the graph line or outline stroke.

Fill Opacity adjusts the transparency of the graph area or bar fill. The ALPHA effect, when active, has precedence over the Fill Opacity (for octave bands modes only).

!> On Firefox, Fill Opacity may not work properly with Radial analyzer, due to this bug.

Gradient

Several options of color gradients for the analyzer graphs. You can also change gradients using the G and Shift + G keyboard shortcuts.

You can disable specific gradients and create your own gradients in the Config panel.

Switch Description
AUTO Select the next gradient on each track change, or a random gradient on each mode change when Random mode is active
SPLIT When Stereo is active, splits the gradient between both channels, so each channel will have different colors

Effects

Select additional visualization effects for octave bands modes.

Effect Description Example
LEDS Toggle the vintage LED effect for the analyzer bars
LUMI Toggle the luminance bars effect - all analyzer bars are displayed at full-height, varying their luminance instead
ALPHA Toggle varying bar transparency - the higher the bar amplitude the more opaque it is (also works on Discrete frequencies mode)
OUTLINE Toggle bar outline mode - see Line width and Fill opacity settings

Radial

If the RADIAL switch is on, the spectrum analyzer is displayed as a circle with radial frequencies. This mode disables both LEDS and LUMI effects.

You can also toggle the radial analyzer with the C keyboard shortcut.

The SPIN slider allows you to configure the analyzer spinning speed, when in radial mode.

Radial Radial + Stereo
screenshot7 radial-stereo

Background

Selects the analyzer background.

Background Description
Gradient default Uses the background color defined by the currently selected gradient - when the LED effect is on, this shows the "unlit" LEDs instead
Black Uses a black background
Album cover Displays the album cover for the current song (1)
Random image Selects a random image from the backgrounds folder (2)
Random video Selects a random video from the backgrounds folder (2)

( 1 ) Album covers will be preferably retrieved from song metadata. When a picture is not found in the metadata, audioMotion will look for image files (jpg, png, gif, webp, avif or bmp) in the song's folder, and will pick any image which filename contains the words cover, folder or front (in this order), or the first image found otherwise.

( 2 ) If you use the -b option when starting audioMotion, image and video files in the provided folder can also be used as background. All media files found in the first level folder (no subfolders) can be selected by the Random image or Random video options, and the first 20 files will also be directly available in the selection box.

See also BG Image Fit and Background Dim settings for additional options for background images and videos.

You can cycle through the available options using the B keyboard shortcut.

Background Image Fit

When Background is set to Album cover or an image, this option selects the size and positioning of the background image.

BG Image Fit Effect
Adjust Resizes the image so it fills the entire canvas
Center Displays the image horizontally centered on the canvas (default)
Pulse Makes the image pulsate to the beat of the song
Repeat Repeats the image horizontally to fill the canvas
Warp Applies a 3D "warp" effect to the background image
Warp Drive Animated Warp effect
Wormhole Warp Drive effect with additional rotation
Zoom In Image is initially centered on the canvas and slowly zooms in as the song plays
Zoom Out Image is initially enlarged at 200% and slowly zooms out as the song plays

You can cycle through the available options using the Shift + B keyboard shortcut.

Effects can be selectively disabled in the Config panel.

!> The Warp Drive and Wormhole effects may degrade performance on some browsers or graphics cards.

Background Dim

When Background is set to an image (including the Album cover) or video, this option adjusts the brightness of the background.

Reflex

Selects a vertical reflection effect. On octave bands modes, this setting has no effect when the LUMI switch is active.

Reflex: On Reflex: Mirrored
reflex-on reflex-mirrored

Mirror

Selects a horizontal mirroring effect to the left (low frequencies at the center) or to the right (high frequencies at the center).

Mirror: Left Mirror: Right
mirror-left mirror-right

Sensitivity

Adjusts the analyzer sensitivity to improve the visualization of songs too quiet or too loud. You can also use the N and Shift + N keyboard shortcuts.

Presets for low, normal and high sensitivity can be customized in the Config panel.

Frequency Range

The lowest and highest frequencies represented in the spectrum analyzer. You can use this feature to "zoom in" a specific frequency range.

Smoothing

Averaging factor used to smooth values between analysis frames.

Lower values make the analyzer react faster to changes, and may look better with faster tempo songs and/or larger FFT sizes. Increase it if the analyzer animation looks too "jumpy".

Fullscreen Height

Adjusts the height of the analyzer when in fullscreen. This can be used to provide a wider look to the analyzer.

You can also use the Shift + Up and Down arrows to adjust the analyzer height during fullscreen.

Switches

switch action
SCALEX show frequency (Hz) scale on the horizontal axis
SCALEY show level (dB) scale on the vertical axis
INFO toggle on-screen display of song information on every track change
PEAKS show amplitude peaks for each frequency
FLAT toggle outline (on) or shadow (off) for text messages displayed on canvas - may improve performance, depending on your graphics card and browser
LO-RES reduce canvas resolution to improve rendering speed (especially useful for 4K+ displays)
STEREO toggle dual channel display, with separate analyzer graphs for left and right channels. This setting does NOT change the audio output of stereo songs.
FPS show current framerate at the top right corner

screenshot6 STEREO Line graph, with frequency (SCALEX) and level (SCALEY) scales turned on.

Preset

The Demo preset will pick new visualization settings when loaded and will set random mode to 15 seconds, so it's a great way to quickly overview all of audioMotion's features!

Full resolution, LED bars and Octave bands presets provide quick configuration recommendations.

Any changes to the settings will be automatically saved to your browser's localStorage and restored the next time you open audioMotion. You can manually load the Last session preset to undo any changes made during the current session.

The Restore defaults preset resets all options to their initial values, as in the first time you run audioMotion.

Save a favorite configuration in the Custom preset, by clicking the Save button.

Console

console

The console records several useful information, like audio and video settings, configuration changes and error messages.

Config Panel

config-panel

Enabled Modes

Uncheck the visualization modes you don't want to appear in the Mode selection box.

Enabled Gradients

Uncheck the gradients you don't want to appear in the Gradient selection box.

Gradient Editor

Click the Add Gradient button to create a new color gradient, or click any custom gradient to edit it.

gradient-editor

At least two colors are required to create a gradient, but you can add as many colors as you like. The offset must be a number between 0 and 1 - use it to adjust the position of each color inside the gradient.

?> Custom gradients are saved to the browser's local storage, so they will only be available in the same browser they were created.

Enabled BG Image Fit options

Uncheck the options you don't want to appear in the BG Image Fit selection box.

Settings affected by Random Mode

Customize which configuration settings may be changed when the visualization mode is randomized (see Random Mode).

Please note that the Gradient will be randomized on each change if the AUTO switch is on.

Disabled modes, gradients and image fit options will also be excluded from the randomization.

General settings

FFT Size is the number of samples used for the Fast Fourier Transform performed by the analyzer.

Higher values provide greater detail in the frequency domain (especially for low frequencies), but less detail in the time domain (slower response to changes). The default value of 8192 usually provides the best cost/benefit ratio for both domains.

PIP window aspect ratio selects the aspect ratio of the Picture-In-Picture window. After entering PIP, the window can be resized and the selected aspect ratio will be preserved.

Sensitivity presets

Customize low, normal and high sensitivity presets (see Sensitivity setting). 0 dB represents the loudest possible sound volume.

On-screen information display options

Customize how long song information is displayed on screen, on different events, and toggle display of albums covers and track count.

Keyboard shortcuts

The following keyboard shortcuts that can be used to control the player and change some visualization settings without leaving fullscreen:

key action
Up / Down arrows volume up / down
Shift = increase / reduce analyzer height on fullscreen
Left / Right arrows previous / next song | hold for rewind / fast forward
Shift = balance left / right
Space play / pause
Shift+A / A cycle through auto gradient and random mode options
B cycle through Background options
Shift+B cycle through background Image Fit options
C toggle Radial analyzer
D display song information; press again for settings info and again to hide
(alternatively, click on analyzer)
E shuffle play queue
F toggle fullscreen mode
Shift+G / G select previous / next gradient
H toggle FPS display
I toggle info display at track start/end
L toggle LED effect on analyzer bars
Shift+M / M select previous / next visualization mode
Shift+N / N reduce / increase analyzer sensitivity
O toggle low-resolution mode
P toggle peaks display
R toggle play queue repeat
Shift+S / S toggle display of frequency and level scales
T toggle flat / shadowed text for on-screen display
U toggle luminance bars effect
Shift+X / X select previous / next reflex style