Stax.GetImageColor 1.0.0

dotnet add package Stax.GetImageColor --version 1.0.0
NuGet\Install-Package Stax.GetImageColor -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Stax.GetImageColor" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Stax.GetImageColor --version 1.0.0
#r "nuget: Stax.GetImageColor, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Stax.GetImageColor as a Cake Addin
#addin nuget:?package=Stax.GetImageColor&version=1.0.0

// Install Stax.GetImageColor as a Cake Tool
#tool nuget:?package=Stax.GetImageColor&version=1.0.0

Get Average Image Color

Summary

This NuGet package contains methods allowing you to get the average color of an image by either passing through the bytes of the image, or passing through the URL of an image.

The rgba hex value is then returned (eg: #ff000088).

This is a work in progress and I'm open to ideas on how to increase the speed of this and also how well it calculates the average color.

Why I have written this

I needed to get the average color of images for Musicstax.

How to use

Once installing this package, there are two methods you can use:

GetImageColor.AverageFromUrl(string url, string defaultColor = DefaultColor)

GetImageColor.AverageFromBytes(byte[] imageBytes, string defaultColor = DefaultColor)

An example might be:

var averageColor = await GetImageColor.AverageFromUrl(url);

which will return a string, eg: #ffffffff

Exception handling

As you could pass through an invalid URL (or perhaps you don't have permission to view it), there is the possibility that an average color can not be calculated. In this case, by default #000000FF will be returned if the FromUrl method can not fetch the image. This is the color black.

You can override this default color by:

var averageColor = await GetImageColor.AverageFromUrl(url, "#FFFFFFFF);

Expanding

I am keen to expand this to get the most dominant color from an image, which will come soon.

Product Compatible and additional computed target framework versions.
.NET net5.0 is compatible.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.0 780 1/17/2023
0.0.2-beta 145 1/16/2023
0.0.1-beta 130 1/16/2023