Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat/improve_legacy_support #63

Merged
merged 8 commits into from
May 9, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
legacy plugins config
JarbasAl committed May 9, 2024
commit 368e01c84fcb31bb951139ad62e6328dc367b79b
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -58,7 +58,21 @@ by default OCP acts as a translation layer for this api and no action is needed,
```javascript
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion(non-blocking): use ```json for better formatting, potentially?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

markdown rendering in github doesnt like comments, thats why i use javascript usually, avoids the red highlights as it would be invalid json but is a valid javascript comment

{
"enable_old_audioservice": true,
"disable_ocp": true
"disable_ocp": true,
"Audio": {
"default-backend": "vlc",
"backends": {
"simple": {
"type": "ovos_audio_simple",
"active": true
},
"vlc": {
"type": "ovos_vlc",
"active": true
}
}
}
},
}
```

@@ -70,8 +84,8 @@ legacy plugins:
**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
- OCP is the default audio plugin, unless disabled in config
- 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 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