rutvik110/flutter_audio_waveforms

https://github.com/rutvik110/flutter_audio_waveforms/blob/master/example/assets/images/logo/logo.png?raw=true

A UI library for easily adding audio waveforms to your apps, with several customization options.

Web Demo - Flutter Audio Waveforms Web Demo

Features

You can use the following available waveform types.

Polygon
Rectangle
Squiggly
Curved Polygon

https://github.com/rutvik110/flutter_audio_waveforms/blob/master/example/assets/images/inactive/polygon.png?raw=true https://github.com/rutvik110/flutter_audio_waveforms/blob/master/example/assets/images/inactive/rectangle.png?raw=true https://github.com/rutvik110/flutter_audio_waveforms/blob/master/example/assets/images/inactive/squiggly.png?raw=true https://github.com/rutvik110/flutter_audio_waveforms/blob/master/example/assets/images/inactive/curved_polygon.png?raw=true

Need to add some gradient to your waveform? Say no more! You get it along with other customization options.

https://github.com/rutvik110/flutter_audio_waveforms/blob/master/example/assets/images/customizations/pg.png?raw=true https://github.com/rutvik110/flutter_audio_waveforms/blob/master/example/assets/images/customizations/rg.png?raw=true https://github.com/rutvik110/flutter_audio_waveforms/blob/master/example/assets/images/customizations/pa.png?raw=true https://github.com/rutvik110/flutter_audio_waveforms/blob/master/example/assets/images/customizations/ra.png?raw=true https://github.com/rutvik110/flutter_audio_waveforms/blob/master/example/assets/images/customizations/sa.png?raw=true https://github.com/rutvik110/flutter_audio_waveforms/blob/master/example/assets/images/customizations/pai.png?raw=true https://github.com/rutvik110/flutter_audio_waveforms/blob/master/example/assets/images/customizations/rai.png?raw=true https://github.com/rutvik110/flutter_audio_waveforms/blob/master/example/assets/images/customizations/sai.png?raw=true https://github.com/rutvik110/flutter_audio_waveforms/blob/master/example/assets/images/customizations/pf.png?raw=true https://github.com/rutvik110/flutter_audio_waveforms/blob/master/example/assets/images/customizations/paf2.png?raw=true https://github.com/rutvik110/flutter_audio_waveforms/blob/master/example/assets/images/customizations/pgf.png?raw=true https://github.com/rutvik110/flutter_audio_waveforms/blob/master/example/assets/images/customizations/paf.png?raw=true https://github.com/rutvik110/flutter_audio_waveforms/blob/master/example/assets/images/customizations/cpaf.png?raw=true

Want an active track for your audio out of the box? You get that too!

https://github.com/rutvik110/flutter_audio_waveforms/blob/master/example/assets/images/gifs/pa_gif.gif?raw=true https://github.com/rutvik110/flutter_audio_waveforms/blob/master/example/assets/images/gifs/ra_gif.gif?raw=true https://github.com/rutvik110/flutter_audio_waveforms/blob/master/example/assets/images/gifs/sa_gif.gif?raw=true https://github.com/rutvik110/flutter_audio_waveforms/blob/master/example/assets/images/gifs/cpa_gif.gif?raw=true

Check out the short demo of what package offers here

Getting started

The package gives you the ability to add waveforms and customize them. It's mostly like a UI library for waveforms with an additional ability to show active track for playing audio.

So it relies on you to provide the necessary audio data which it needs to draw the waveform. The data we need is basically a list of points/samples that represents that audio.

You can use this audiowaveform program to get the audio json file which will provide us the samples. After installing this program on your machine, generate the json file for an audio by using this command in your terminal.

audiowaveform -i test.mp3 -o test.json

The generated data needs to be processed following some rules which are necessary to get the waveforms drawn properly. To process the data use this processor.

Once you have the processed data points list then you can just pass it down to any of the waveforms available and get started using them.

Check out this article for detailed introduction on this section.

Usage

Usage of all waveforms available is the same with only exception of having more/less customization options for different waveforms.

 // For a regular waveform
 PolygonWaveform( 
   samples: [],
   height: height,
   width: width, 
 )

 // If you want active track for playing audio, pass [maxDuration] and [elapsedDuration]
 PolygonWaveform( 
   samples: [],
   height: height,
   width: width,
   maxDuration: maxDuration,
   elapsedDuration: elapsedDuration, 
 )

Find detailed example here.

Properties

maxDuration:

Maximum duration of the audio.

elapsedDuration:

Elapsed Duration of the audio.

samples:

List of the audio data samples.

Check the Getting Started section on how to generate this.

height :

Waveform height.

width :

Waveform width.

Customization Options

inactiveColor :

Color of the inactive waveform.

activeColor :

Color of the active waveform.

inactiveGradient :

Gradient of the inactive waveform.

activeGradient :

Gradient of the active waveform.

absolute :

Waveform drawn is one sided either above x-axis or below it depending on what invert is set to.

Defaults to false.

invert :

Flips/inverts the waveform upside down.

Defaults to false.

borderWidth :

Width of the border around waveform.