colorExtractor

Extracts colors from a playlist, track, album, artist, show, etc.

function colorExtractor(uri: string): Promise<{
    DARK_VIBRANT: string;
    DESATURATED: string;
    LIGHT_VIBRANT: string;
    PROMINENT: string;
    VIBRANT: string;
    VIBRANT_NON_ALARMING: string;
}>;

Parameters

Parameter	Type	Description
uri	string	URI of anything that has artwork (playlist, track, album, artist, show, etc.)

Returns

Name	Type	Description
DARK_VIBRANT	string	Dark vibrant color in hex format.
DESATURATED	string	Desaturated color in hex format.
LIGHT_VIBRANT	string	Light vibrant color in hex format.
PROMINENT	string	Prominent color in hex format.
VIBRANT	string	Vibrant color in hex format.
VIBRANT_NON_ALARMING	string	Vibrant non alarming color in hex format.

Example

// Get color from current track
const currentTrack = Spicetify.Player.data.item;
const colors = await Spicetify.colorExtractor(currentTrack.uri);