avg-color-gen

Prerequisies

A very simple lightweight package that calculates the average color of any images in browser environment.

• Image must be passed in a base64 format
• It is not meant to process video files directly, but a work around for that would be, print a single frame of video on and then convert it into base64. Then pass the resulting base64 to getAverageColor

Usage

• Installing the package

npm install avg-color-gen --save

• Importing the module

import getAverageColor from "avg-color-gen"

• Calling the function

getAverageColor(IMAGE_IN_BASE64, OPACITY OF THE RESULTING COLOR);


// Example with callbacks
// NOTE: requiring an image in js gets it in base64
getAverageColor(require(`../assets/img/never_gonna_gice_you_up.png`), 0.09).then((rgb) => {
    updateRGB(rgb);
})

Responses

• In case of success, it will return

{
    status: "success",
    color: "rgba(x,x,x,x)"
}

• In case of failure, it will return

{
    status: "failure",
    reason: "SOME_REASON_HERE"
}