Skip to main content

Getting started 🔊

warning

Currently this project is on 0.5.6. version

Overview​

Soundy-js is a powerful library that enables real-time visualization and access to audio data in React applications. With its seamless integration, you can easily access frequency, beat details, and other audio features for any audio source within your project.

Key features​

  • Real-Time Audio Data Access: Retrieve detailed information on frequency and beat patterns in real-time.
  • Blazingly Fast Performance: Optimized for speed, ensuring smooth feature retrieval with minimal latency.
  • React Integration: Convenient usage via a React hook or a React Provider, offering flexibility in managing and accessing audio data across your components.

Installation​

Run npm install soundy-js

warning

You need to use React v18.0.0 or higher to be able to use Soundy-js

Usage​

You can use Soundy-js via React hook or React Provider

Here you can read more about hove to use it via React hook

Here you can read more about hove to use it via React Provider

Motivation 🤔​

We incredibly enjoy making audio visualizers using javascript only. This projects goal is to provide a library that can make this more approachable for others, by supplying the data from the audio via a React hook or Provider. We mostly experimented creating visualizations using Three.js, SVGs and basic HTML elements.