Skip to content
Related Articles

Related Articles

Improve Article
Save Article
Like Article

p5.js | getPeak() Function

  • Last Updated : 17 Jan, 2020

The getPeak() function is an inbuilt function in p5.js library. This function is used to return the array of amplitude peaks in a p5.soundfile that can be used to draw a static waveform. This function finds the greatest amplitudes.


getPeaks( length )

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

Parameters: This function accepts a single parameter as mentioned above and described below.

  • length: This parameter holds the length that is the size of the returned array. Larger length results in more precision. Defaults to 5*width of the browser window. It is an optional parameter.

Return Values: This function return an array of peaks.

Below examples illustrate the p5.getPeak() function in JavaScript:

var sound; 
var gtpth;
function preload() { 
    // Initialize sound 
    sound = loadSound("pfivesound.mp3"); 
function setup() { 
    // Playing the preloaded sound;
    // will return no of frames
    gtpth = sound.getPeaks();

Online editor:
Environment Setup:

Supported Browsers: The browsers supported by p5.js getPeaks() function are listed below:

  • Google Chrome
  • Internet Explorer
  • Firefox
  • Safari
  • Opera

My Personal Notes arrow_drop_up
Recommended Articles
Page :

Start Your Coding Journey Now!