0.1.2 • Published 2 years ago

get-audio-gain v0.1.2

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

GetAudioGain

GetAudioGain is a tool that will help you obtain the gain values ​​of an audio file, separating it into segments based on a specified time lapse, as well as knowing which parts of the audio can be considered silence.

Instalation

You can install this tool in your projects this way

npm install get-audio-gain

OR

yarn add get-audio-gain

Usage

To use this tool, first of all, we need to import it into our project

const getAudioGain = require("get-audio-gain");

Now we will be able to use the function

You must pass as a parameter the path of your audio file

Example:

getAudioGain("audio-example.wav").then(console.log).catch(console.error);

You will get a result like this:

[
    {
        "segment":0,
        "gainAvg":99.21582456458636,
        "silence":false
    },
    {
        "segment":1,
        "gainAvg":124.71142507256894,
        "silence":false
    },
    {
        "segment":2,
        "gainAvg":65.4035286647315,
        "silence":true
    },
    {
        "segment":3,
        "gainAvg":117.08377177068215,
        "silence":false
    }
    ...

Response description

segment:

Single segment of the current reading, determined by the lapse parameter. For example, if the specified time is 250 milliseconds, segment 0 represents reading from 0 to 250 milliseconds, and segment 1 from 250 to 500, etc.

gainAvg

Represent the gain average for each segment

silence

Define if the segment can be considered silence, according to the parameter threshold If the specified threshold is 74 and average gain is less than 74, silence will be true

Parameters definition

ParameterDescriptionTypeOptionalDefault
filePathAudio file pathstringfalseN/A
lapseTime lapse for each segment in millisecondsnumbertrue250
thresholdthreshold to define what is a silence or a considerable soundnumbertrue110

Usage example with optional parameters

getAudioGain("audio-file.wav", 200, 80);

Contributors

Christian De La Cruz