p5.js | processPeak() Function

Last Updated : 15 Apr, 2020

The processPeak() function is an inbuilt function in p5.js library. This function is used to track down the audio beats. This function performs the sound file in an offline audio context and sends that data to your callback function.

This process passes the loaded audio in a filter that tracks down the peaks that above the average peak if the peaks are lower than the average peaks it decreases the average threshold value.

Syntax:

processPeaks(callback, initThreshold, minThreshold, minPeaks)

Note: All the sound-related functions only work when the sound library is included in the head section of the index.html file.

Parameter: This function accepts four parameters as mentioned above and described below:

callback: This parameter is the name of the function that will be called when the audio reaches at the end of the buffer.
initThreshold: This parameter holds the initial threshold value. The initial threshold defaults to 0.9, it is optional parameter
minThreshold: This parameter holds the minimum threshold value. The minimum threshold defaults to 0.22, it is optional parameter
minPeaks: This parameter holds the minimum peaks value. The minimum peaks defaults to 200, it is optional parameter

Below example illustrates the p5.processPeaks() function in JavaScript:

Example:

var sound;  
var ppeak; 
      
function preload() {  
      
    // Initialize sound  
    sound = loadSound("pfivesound.mp3");  
}  
      
function setup() {  
      
    // Playing the preloaded sound  
    sound.play(); 
   
    // will return no of frames 
    ppeak = sound.processPeaks(gfg); 
    console.log(ppeak); 
}  
  
function gf(){ 
    alert("processPeaks function running") 
} 