Java Media Transport Controls (JMTC)

Overview

JMTC is a lightweight Java library that integrates a Java application with the Media Transport Controls and Now Playing elements of the operating System. The properties of the currently playing Media can easily be set and the library defines callbacks for the Media Keys(global) and the UI elements.

Features

• Title, Artist, Album Title, Album Artist, Playtime and Cover Art fields supported
• Seeking, Play/Pause, Stop, Volume, Shuffle, Rate and Looping supported
• simple callback syntax via Lambda Functions
• easily integrable into projects using Compose Multiplatform, JavaFX, Swing, TornadoFX, etc.

Planned Features

• Logging
• graceful Error Handling
• Support for different Media Types (Video, Photo) ???

Supported Platforms

• Windows (via SystemMediaTransportControls)
• Linux (via MPRIS 2 on D-Bus)
• Mac (TODO currently I have no test system)

Getting Started

Prerequisites

• Java 21 or later

Installation

Maven Central

This library is available on the Maven Central repository. To use this library just add the following to your build.gradle.kts:

repositories {
    mavenCentral()
}
dependencies{
    implementation("io.github.selemba1000:JavaMediaTranportControls:0.0.2")
}

Current version is 0.0.3.

Maven Local

Download this repository via git with:

git clone https://github.com/Selemba1000/JavaMediaTransportControls.git

or download as zip and extract it. Then load the project into your IDE of choice and execute Task publishToMavenLocal. Then add the following to your build.gradle:

repositories {
    mavenLocal()
}
dependencies {
    implementation 'io.github.selemba1000:jmtc:1.0.0'
}

Usage

To start with the Library first get an instance of JMTC:

JMTC jmtc = JMTC.getInstance(
        new JMTCSettings("example-player-name","example-player-desktop-file")
);

Then you can set all parameters via this instance, for example:

JMTCCallbacks callbacks = new JMTCCallbacks();
callbacks.onPlay = () -> {
    control.setPlayingState(JMTCPlayingState.PLAYING);
};
callbacks.onPause = () -> control.setPlayingState(JMTCPlayingState.PAUSED);
jmtc.setEnabledButtons(
    new JMTCEnabledButtons(
        true,
        true,
        true,
        true,
        true
    )
);
jmtc.setCallbacks(callbacks);
jmtc.setEnabled(true);
jmtc.setMediaType(JMTCMediaType.Music);
jmtc.setPlayingState(JMTCPlayingState.PAUSED);
control.setMediaProperties(
    new JMTCMusicProperties(
        "TestTitle",
        "TestArtist",
        "test",
        "tset",
        new String[]{},
        0,
        1,
        null
    )
);
jmtc.setTimelineProperties(
    new JMTCTimelineProperties(
        0L,
        100000L,
        0L,
        100000L
    )
);
jmtc.setPlayingState(JMTCPlayingState.PLAYING);
jmtc.updateDisplay();
jmtc.setPosition(100L);

For more information see the JavaDoc in code.

Building Windows native library

The required library's come prebuilt, so this is only needed if you want to change native code.

Requirements

Windows 10 SDK has to be installed, and MSBuild has to be available in PATH.

Building

Just execute the gradle tasks "build native" -> "copy_release" or "copy_debug" to automatically compile and copy the library's to the required folders.

Use the task "clean_native" to clear compilation results and temp files.

License

Distributed under the MIT License. See LICENSE for more information.