rework media interfaces

libnymea/interfaces/extendedmediacontroller.json

@@ -0,0 +1,12 @@
+{
+    "description": "A more advanced media controller interface, supporting fast forward and rewind",
+    "extends": "mediacontroller",
+    "actions": [
+        {
+            "name": "fastRewind"
+        },
+        {
+            "name": "fastForward"
+        }
+    ]
+}

libnymea/interfaces/interfaces.qrc

@@ -1,7 +1,5 @@
 <RCC>
     <qresource prefix="/interfaces">
-        <file>media.json</file>
-        <file>mediacontroller.json</file>
         <file>light.json</file>
         <file>dimmablelight.json</file>
         <file>colortemperaturelight.json</file>
@@ -12,8 +10,12 @@
         <file>weather.json</file>
         <file>volumecontroller.json</file>
         <file>extendedvolumecontroller.json</file>
+        <file>media.json</file>
+        <file>mediacontroller.json</file>
+        <file>extendedmediacontroller.json</file>
         <file>mediametadataprovider.json</file>
         <file>mediaplayer.json</file>
+        <file>shufflerepeat.json</file>
         <file>battery.json</file>
         <file>batterylevel.json</file>
         <file>button.json</file>

libnymea/interfaces/media.json

@@ -1,3 +1,3 @@
 {
-
+    "description": "The base for all media interfaces. Client applications might use this to group/filter things supporting media playback/control. When implementing a plugin use mediaplayer or mediacontroller for actual devices."
 }

libnymea/interfaces/mediacontroller.json

@@ -1,34 +1,10 @@
 {
+    "description": "The mediacontroller interface contains basic actions to control media streams. If a device supports fast forward and rewind, use extendedmediacontroller instead.",
     "extends": "media",
-    "states": [
-        {
-            "name": "mute",
-            "type": "bool",
-            "writable": true
-        },
-        {
-            "name": "volume",
-            "type": "int",
-            "minValue": 0,
-            "maxValue": 100,
-            "writable": true
-        },
-        {
-            "name": "playbackStatus",
-            "type": "QString",
-            "allowedValues": ["Playing", "Paused", "Stopped"],
-            "writable": true
-        }
-
-    ],
     "actions": [
         {
             "name": "skipBack"
         },
-        {
-            "name": "rewind"
-        },
-        {
             "name": "stop"
         },
         {
@@ -37,9 +13,6 @@
         {
             "name": "pause"
         },
-        {
-            "name": "fastForward"
-        },
         {
             "name": "skipNext"
         }

libnymea/interfaces/mediametadataprovider.json

@@ -1,16 +1,17 @@
 {
+    "description": "Provide media information, meant to be used in combination with mediaplayer. For music players, use collection to provide the album/compilation, for video players fill in the series name or a movie collection name there. Artwork can be a URL to a artwork image.",
     "extends": "media",
     "states": [
+        {
+            "name": "title",
+            "type": "string"
+        },
         {
             "name": "artist",
             "type": "string"
         },
         {
-            "name": "album",
-            "type": "string"
-        },
-        {
-            "name": "title",
+            "name": "collection",
             "type": "string"
         },
         {

libnymea/interfaces/mediaplayer.json

@@ -1,11 +1,11 @@
 {
+    "description": "Media player interface. Used by devices/services which can play back media.",
     "extends": "media",
     "states": [
         {
             "name": "playbackStatus",
             "type": "string",
-            "allowedValues": ["Playing", "Paused", "Stopped"],
-            "writable": true
+            "allowedValues": ["Playing", "Paused", "Stopped"]
         },
         {
             "name": "playerType",

libnymea/interfaces/shufflerepeat.json

@@ -0,0 +1,14 @@
+{
+    "description": "Devices/services supporting this interface can control reproduction flow. E.g. a media controller, but could also be used by light scenes or other workflows",
+    "states": [
+        {
+            "name": "shuffle",
+            "type": "bool"
+        },
+        {
+            "name": "repeat",
+            "type": "string",
+            "allowedValues": ["None", "One", "All"]
+        }
+    ]
+}