documentation:readme

README.md

@@ -6,11 +6,9 @@ Handles TTS generation and sounds playback
 
 ## Install
 
-`pip install ovos-audio[extras]` to install this package and the default
-plugins.
+`pip install ovos-audio[extras]` to install this package and the default plugins.
 
-Without `extras`, you will also need to manually install,
-and possibly configure TTS modules as described below.
+Without `extras`, you will also need to manually install, and possibly configure TTS modules as described below.
 
 # Configuration
 
@@ -51,7 +49,7 @@ under mycroft.conf
 
 The legacy audio service supports audio playback via the old mycroft api ([@mycroft](https://github.com/MycroftAI/mycroft-core/blob/dev/mycroft/skills/audioservice.py#L43) [@ovos](https://github.com/OpenVoiceOS/ovos-bus-client/blob/dev/ovos_bus_client/apis/ocp.py#L51))
 
-by default OCP acts as a translation layer for this api and no action is needed, but if you want to disable ocp this api remains available
+by default OCP delegates to the legacy audio service when necessary and no action is needed, but if you want to disable ocp this api remains available as the solve media playback provider
 
 > **NOTE:** once ovos-media is released OCP and this api will be disabled by default and deprecated!
 
@@ -77,16 +75,18 @@ by default OCP acts as a translation layer for this api and no action is needed,
 ```
 
 legacy plugins:
-- [ocp](https://github.com/OpenVoiceOS/ovos-ocp-audio-plugin)
 - [vlc](https://github.com/OpenVoiceOS/ovos-vlc-plugin)
 - [simple](https://github.com/OpenVoiceOS/ovos-audio-plugin-simple) (no https support)
+- [mpv](https://github.com/OpenVoiceOS/ovos-audio-plugin-mpv) <- recommended default
+- [chromecast](https://github.com/OpenVoiceOS/ovos-media-plugin-chromecast)
+- [spotify](https://github.com/OpenVoiceOS/ovos-media-plugin-spotify)
 
 **OCP technical details:**
 
-- OCP was developed for mycroft-core under this legacy system
-- OCP will pose as a legacy plugin and translate the received bus events to the [OCP api](https://github.com/OpenVoiceOS/ovos-bus-client/blob/dev/ovos_bus_client/apis/ocp.py#L228)
+- OCP was developed for mycroft-core under the legacy audio service system
 - OCP is **always** the default audio plugin, unless you set `"disable_ocp": true` in config
-- OCP uses the legacy api internally, to delegate playback when GUI is not available (or configured to do so)
-- this does **NOT** bring support for old Mycroft CommonPlay skills, that is related to skills service not ovos-audio
-- this brings support for [OCP skills](https://openvoiceos.github.io/ovos-technical-manual/OCP_skills) to OVOS until [ovos-media](https://github.com/OpenVoiceOS/ovos-media) is finished
-- [ovos-media](https://github.com/OpenVoiceOS/ovos-media) will fully replace OCP in **ovos-audio 0.2.0**
+- OCP uses the legacy api internally, to delegate playback when GUI is not available (or when configured to do so)
+- brings support for [OCP skills](https://openvoiceos.github.io/ovos-technical-manual/OCP_skills) to OVOS until [ovos-media](https://github.com/OpenVoiceOS/ovos-media) is finished
+- does **NOT** bring support for old Mycroft CommonPlay skills, that is achieved by using the `"ocp_legacy"` pipeline with ovos-core
+- [ovos-media](https://github.com/OpenVoiceOS/ovos-media) will fully replace OCP in **ovos-audio 1.0.0**
+- (**DEPRECATED**) in `mycroft-core`/`ovos-core 0.0.7` OCP used to pose as a legacy plugin and translated the received bus events to the [OCP api](https://github.com/OpenVoiceOS/ovos-bus-client/blob/dev/ovos_bus_client/apis/ocp.py#L228)