This release is a pre-release and may not be stable for production use.
OCP Pipeline
The OCP (Open Common Play) pipeline plugin turns media utterances into playback actions in OVOS. Utterances such as "play metallica", "put on some movie", "pause", or "next" pass through this plugin as an intent pipeline stage. On a match, the plugin searches registered media skills over the message bus and drives playback through the OCP API.
The plugin exposes two entry points under the opm.pipeline group:
ovos-ocp-pipeline-plugin(OCPPipelineMatcher), the main pipeline. It matchesplay,open,media_stop,next,prev,pause,resume,save_game, andload_gameintents at high, medium, or low confidence.ovos-ocp-pipeline-plugin-legacy(MycroftCPSLegacyPipeline), a bridge for older Mycroft CommonPlay skills, using theplay:query/play:query.response/play:starthandshake.
OCPPipelineMatcher also classifies media type, such as music, movie, or podcast. It extracts named entities with ahocorasick-ner, using per-language vocabulary files and optional user-supplied entity CSVs (the entity_csvs config option). It tracks player state per session through an OCPPlayerProxy, kept in sync with ovos.common_play.status and track.state bus events.
Architecture
Install
pip install ovos-ocp-pipeline-plugin
Usage
OVOS core loads this plugin automatically once installed, through the opm.pipeline entry-point group. Enable it in mycroft.conf under the intents section:
{
"intents": {
"ovos-ocp-pipeline-plugin": {
"entity_csvs": []
}
}
}
The plugin reads the pipeline's intents config block, then falls back to a legacy OCP config block for backward compatibility.
Related projects
- OpenVoiceOS/ovos-plugin-manager defines the
ConfidenceMatcherPipelinebase class and theopm.pipelineentry-point group this plugin implements. - OpenVoiceOS/ovos-workshop provides
OVOSAbstractApplication, the bus-app base class this plugin also subclasses. - OpenVoiceOS/ovos-bus-client provides the OCP message-bus API (
OCPInterface) used to search and control playback.
License
Apache-2.0
1 maintainer
Release files for ovos-ocp-pipeline-plugin 1.2.0a1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ovos_ocp_pipeline_plugin-1.2.0a1.tar.gz | 169.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ovos_ocp_pipeline_plugin-1.2.0a1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 371.2 kB
Release files / ovos_ocp_pipeline_plugin-1.2.0a1.tar.gz
| Download URL | ovos_ocp_pipeline_plugin-1.2.0a1.tar.gz |
|---|---|
| Size | 169.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
46daad3b1117031218b84c101ed632f471d2706a4744331e6020e0b7098e0c93
|
|
BLAKE2b-256 checksum How to use checksums |
723cf22967052a08158b516b65a6fd19dbe467a15ee30c3833dd8686b5a9487c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / ovos_ocp_pipeline_plugin-1.2.0a1-py3-none-any.whl
| Download URL | ovos_ocp_pipeline_plugin-1.2.0a1-py3-none-any.whl |
|---|---|
| Size | 201.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7ddbaf1dc84003d61e29a53337281d7a42c11e9ed947660dae73be3fdc85c844
|
|
BLAKE2b-256 checksum How to use checksums |
837b34a0c4deb1bdb8c23f8a41849cfe0d581073f4f794c4e4f9afee4aa4db1c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
