LabyStudio / java-spotify-api

Spotify API written in Java to locally access the current song information

A Spotify API written in Java to access the current playing song.
There is no need for an access token, any internet connection or a premium account because the API reads the information directly from the application itself.

Feature Overview

• Track id
• Track title & artist
• Track progress & length
• Playing state (Playing, paused)
• Track cover
• Media keys (Previous song, play/pause & next song)

Supported operating systems:

• Windows
• macOS
• Linux distros that uses systemd

Gradle Setup

repositories {
    maven { url 'https://jitpack.io' }
}

dependencies {
    implementation 'com.github.LabyStudio:java-spotify-api:+:all'
}

Example

Create the API and get the current playing song and position:

// Create a new SpotifyAPI for your operating system
SpotifyAPI api = SpotifyAPIFactory.createInitialized();

// It has no track until the song started playing once
if (api.hasTrack()) {
    System.out.println(api.getTrack());
}

// It has no position until the song is paused, the position changed or the song changed
if (api.hasPosition()) {
    System.out.println(api.getPosition());
}

Register a listener to get notified when the song changes:

SpotifyAPI api = SpotifyAPIFactory.create();
api.registerListener(new SpotifyListener() {
    @Override
    public void onConnect() {
        System.out.println("Connected to Spotify!");
    }
    
    @Override
    public void onTrackChanged(Track track) {
        System.out.printf("Track changed: %s (%s)\n", track, formatDuration(track.getLength()));
    }
    
    @Override
    public void onPositionChanged(int position) {
        if (!api.hasTrack()) {
            return;
        }
        
        int length = api.getTrack().getLength();
        float percentage = 100.0F / length * position;
        
        System.out.printf(
            "Position changed: %s of %s (%d%%)\n",
            formatDuration(position),
            formatDuration(length),
            (int) percentage
        );
    }
    
    @Override
    public void onPlayBackChanged(boolean isPlaying) {
        System.out.println(isPlaying ? "Song started playing" : "Song stopped playing");
    }
    
    @Override
    public void onSync() {
        
    }
    
    @Override
    public void onDisconnect(Exception exception) {
        System.out.println("Disconnected: " + exception.getMessage());
        
        // api.stop();
    }
});

// Initialize the API
api.initialize();

Fetch an image of the current playing track:

// Create an instance of the Open Spotify API (Or use SpotifyAPI#getOpenAPI)
OpenSpotifyAPI openSpotifyAPI = new OpenSpotifyAPI();

// Download the cover art of the current song
BufferedImage imageTrackCover = openSpotifyAPI.requestImage(track);

You can also skip the current song using the Media Key API:

SpotifyAPI api = SpotifyAPIFactory.createInitialized();

// Send media key to the operating system
api.pressMediaKey(MediaKey.NEXT);