React Audio Visualizers Core

The core library for react-audio-visualizers. React-audio-visualizers-core has functionality to deal with audio as well as the main UI, helpful hooks, utilities and types. This library is useful when you want to create your own visualizers, if you just want to use existing visualizers go to react-audio-visualizers.

Installation

React-audio-visualizers-core is available as an npm package.

npm install react-audio-visualizers-core
#or
yarn add react-audio-visualizers-core

Usage

Here is an example of how to use react-audio-visualizers-core:

import { AudioVisualizer, AudioVisualizerCommonProps } from 'react-audio-visualizers-core';

export const YourVisualizer = (commonProps: AudioVisualizerCommonProps) => (
    <AudioVisualizer {...commonProps}>
        <YourVisualizerRenderComponent />
    </AudioVisualizer>
);

Documentation

Check out the documentation website. Specially take a look at the architecture section to understand how react-audio-visualizers-core package interacts with the main react-audio-visualizers project.

License

This project is licensed under the terms of the MIT license.