feat/OCP_backends

OpenVoiceOS · Jan 8, 2024 · 54bb9fd · 54bb9fd
1 parent ba7f8bc
commit 54bb9fd
Showing 1 changed file with 121 additions and 3 deletions.
diff --git a/ovos_config/mycroft.conf b/ovos_config/mycroft.conf
@@ -343,7 +343,7 @@
       }
   },
 
-  // The mycroft-core messagebus websocket
+  // The ovos-core messagebus websocket
   "websocket": {
     "host": "127.0.0.1",
     "port": 8181,
@@ -354,7 +354,13 @@
     // gets its own websocket connection
     "shared_connection": true,
     // any bus messages over this size in MB will be refused
-    "max_msg_size": 25
+    "max_msg_size": 25,
+
+    // message.context may contains a source and destination
+    // native audio (playback / TTS) will only be played if a
+    // message destination is a native_source or if missing (considered a broadcast)
+    "native_sources": ["debug_cli", "audio", "mycroft-gui"]
+
   },
 
   // The GUI messagebus websocket.  Once port is created per connected GUI
@@ -688,7 +694,119 @@
     "translation_module": "ovos-translate-plugin-server"
   },
 
-  // Media playback
+  // Configure ovos-media service
+  // similarly to wakewords, configure any number of playback handlers
+  // playback handlers might be local applications or even remote devices
+  "media": {
+
+    // PlaybackType.AUDIO handlers
+    "audio_players": {
+        // vlc player uses a headless vlc instance to handle uris
+        "vlc": {
+            // the plugin name
+            "module": "ovos-media-audio-plugin-vlc",
+
+            // friendly names a user may use to refer to this playback handler
+            // those will be parsed by OCP and used to initiate
+            // playback in the request playback handler
+            "aliases": ["VLC"],
+
+            // deactivate a plugin by setting to false
+            "active": true
+        },
+        // command line player uses configurable shell commands with file uris as arguments
+        "cli": {
+            // the plugin name
+            "module": "ovos-media-audio-plugin-cli",
+
+            // friendly names a user may use to refer to this playback handler
+            // those will be parsed by OCP and used to initiate
+            // playback in the request playback handler
+            "aliases": ["Command Line"],
+
+            // deactivate a plugin by setting to false
+            "active": true
+        },
+        // gui uses mycroft-gui natively to handle uris
+        "gui": {
+            // the plugin name
+            "module": "ovos-media-audio-plugin-gui",
+
+            // friendly names a user may use to refer to this playback handler
+            // those will be parsed by OCP and used to initiate
+            // playback in the request playback handler
+            "aliases": ["GUI", "Graphical User Interface"],
+
+            // deactivate a plugin by setting to false
+            "active": true
+        }
+    },
+
+    // PlaybackType.VIDEO handlers
+    "video_players": {
+        // vlc player uses a headless vlc instance to handle uris
+        "vlc": {
+            // the plugin name
+            "module": "ovos-media-video-plugin-vlc",
+
+            // friendly names a user may use to refer to this playback handler
+            // those will be parsed by OCP and used to initiate
+            // playback in the request playback handler
+            "aliases": ["VLC"],
+
+            // deactivate a plugin by setting to false
+            "active": true
+        },
+        // gui uses mycroft-gui natively to handle uris
+        "gui": {
+            // the plugin name
+            "module": "ovos-media-video-plugin-gui",
+
+            // friendly names a user may use to refer to this playback handler
+            // those will be parsed by OCP and used to initiate
+            // playback in the request playback handler
+            "aliases": ["GUI", "Graphical User Interface"],
+
+            // deactivate a plugin by setting to false
+            "active": true
+        }
+    },
+
+    // PlaybackType.WEBVIEW handlers
+    "web_players": {
+        // open url in the native browser
+        "browser": {
+            // the plugin name
+            "module": "ovos-media-web-plugin-browser",
+
+            // friendly names a user may use to refer to this playback handler
+            // those will be parsed by OCP and used to initiate
+            // playback in the request playback handler
+            "aliases": ["Browser", "Local Browser", "Default Browser"],
+
+            // deactivate a plugin by setting to false
+            "active": true
+        },
+        // gui uses mycroft-gui natively to handle uris
+        "gui": {
+            // the plugin name
+            "module": "ovos-media-web-plugin-gui",
+
+            // friendly names a user may use to refer to this playback handler
+            // those will be parsed by OCP and used to initiate
+            // playback in the request playback handler
+            "aliases": ["GUI", "Graphical User Interface"],
+
+            // deactivate a plugin by setting to false
+            "active": true
+        }
+    }
+  },
+
+
+  // this section has been deprecated since ...
+  // Configure "media" section instead
+  // TODO specific ovos-audio version
   "Audio": {
     // message.context may contains a source and destination
     // native audio (playback / TTS) will only be played if a