[WIP] Add a new feature media to simplify handling of media in Openhab #4709

lo92fr · 2025-04-08T16:38:18Z

Add a new feature media to simplify handling of media in Openhab

Description

See this issue for description :
#4710

lo92fr · 2025-04-12T15:01:31Z

Hello @ALL,

I would apreciate if someone with more experience in core that me can give comments on this first version.
Especially, about the PlayerItem modifications.

I finally decide to drop my new BrowerMediaItem implementation, and modify the existing PlayerItem.
I introduce a new MediaType accepted command on it.
The idea is that this MediaType command would be use to play / queue an album / track / artist to play on the PlayerItem.

The MediaType is a complex type compose of:

The type of command : PLAY/QUEUE (for now).
A parameter (that id the id/path of entry to play).

This command would be relay from core to addons, and addons would have to implement if to handle the play/queue request.
I've currently test this approach with spotify and upnp addons, and it seems to work (minor some obvious bugs to handle).

Laurent

lsiepel · 2025-05-16T14:10:38Z

Not sure if i can be of much help here. If i have more tim ei could look into it, but i think others have more knowledge about these parts.

JFTR please don't use force-push as this makes it harder to review / keep track of changes.

lo92fr · 2025-06-18T17:56:15Z

Hello,

Make some progress on this today.
Of course, it will be not ready for 5.0, perharps for 5.1.
I fix some issues on popup navigations in UI part make things a littles more stables.
Also start to see how I can add a media Renderer popup to select the output device directly from the oh-player-control.

Still a lot of work to be done on it.
I like to have something simple to use for end user, where you have only one way to implement this whatever device you have in your configurations.

Laurent.

Copilot

Pull Request Overview

This PR introduces a new media feature to simplify handling of media in OpenHAB, addressing issue #4710. The implementation adds comprehensive media management capabilities including new state and command types, a media service architecture, and REST endpoints for media browsing.

Key changes include:

Addition of new media-related type classes (MediaCommandType, MediaStateType, MediaCommandEnumType) for enhanced player item functionality
Implementation of a complete media service framework with model classes for organizing media content hierarchically
Introduction of REST endpoints and HTTP servlet for media browsing and device management

Reviewed Changes

Copilot reviewed 42 out of 43 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
PlayerItem.java	Extended to support new media command and state types
MediaCommandType.java	New complex type for media commands with device/binding context
MediaStateType.java	New complex type for media state with playback information
MediaCommandEnumType.java	Enum defining available media commands (PLAY, PAUSE, etc.)
MediaService.java	Core service interface for media registry and device management
MediaServlet.java	HTTP servlet providing web interface for media browsing
MediaResource.java	REST endpoints for media sources and sinks
Various model classes	Hierarchical media content organization (sources, albums, tracks, etc.)

Copilot · 2025-07-26T15:49:05Z

bundles/org.openhab.core.media/src/main/java/org/openhab/core/media/model/MediaAllocator.java

@@ -0,0 +1,7 @@
+package org.openhab.core.media.model;


Missing copyright header and author documentation. All other files in the media bundle include proper copyright headers and Javadoc comments.

Copilot · 2025-07-26T15:49:06Z

bundles/org.openhab.core.media/src/main/java/org/openhab/core/media/Test.java

@@ -0,0 +1,67 @@
+package org.openhab.core.media;


Missing copyright header. Additionally, this appears to be test/debug code that should not be included in production.

Copilot · 2025-07-26T15:49:06Z

....io.rest.media/src/main/java/org/openhab/core/io/rest/media/internal/MediaDTOCollection.java

@@ -0,0 +1,21 @@
+package org.openhab.core.io.rest.media.internal;


Missing copyright header and class documentation.

Copilot · 2025-07-26T15:49:06Z

...rest.media/src/main/java/org/openhab/core/io/rest/media/internal/MediaSinkDTOCollection.java

@@ -0,0 +1,21 @@
+package org.openhab.core.io.rest.media.internal;


Missing copyright header and class documentation.

Copilot · 2025-07-26T15:49:07Z

...b.core.io.rest.media/src/main/java/org/openhab/core/io/rest/media/internal/MediaSinkDTO.java

+    }
+
+    public String getPlayerItemName() {
+        return this.getPlayerItemName();


Recursive call to getPlayerItemName() will cause a StackOverflowError. Should return this.playerItemName instead.

Suggested change

return this.getPlayerItemName();

return this.playerItemName;

Copilot · 2025-07-26T15:49:07Z

bundles/org.openhab.core.media/src/main/java/org/openhab/core/media/model/MediaCollection.java

+        return artUri;
+    }
+
+    public String getExternalArtUri() {


Potential NullPointerException if getMediaRegistry() returns null. The method should include null checking before calling getMediaService().

Suggested change

public String getExternalArtUri() {

public String getExternalArtUri() {

if (this.getMediaRegistry() == null) {

throw new IllegalStateException("MediaRegistry is not available.");

}

wborn · 2025-07-26T15:50:18Z

bundles/org.openhab.core.io.rest.media/pom.xml

+  <parent>
+    <groupId>org.openhab.core.bundles</groupId>
+    <artifactId>org.openhab.core.reactor.bundles</artifactId>
+    <version>5.0.0-SNAPSHOT</version>


Suggested change

<version>5.0.0-SNAPSHOT</version>

<version>5.1.0-SNAPSHOT</version>

wborn · 2025-07-26T15:50:40Z

bundles/org.openhab.core.media/pom.xml

+  <parent>
+    <groupId>org.openhab.core.bundles</groupId>
+    <artifactId>org.openhab.core.reactor.bundles</artifactId>
+    <version>5.0.0-SNAPSHOT</version>


Suggested change

<version>5.0.0-SNAPSHOT</version>

<version>5.1.0-SNAPSHOT</version>