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 matches play, open, media_stop, next, prev, pause, resume, save_game, and load_game intents at high, medium, or low confidence.
ovos-ocp-pipeline-plugin-legacy (MycroftCPSLegacyPipeline), a bridge for older Mycroft CommonPlay skills, using the play:query / play:query.response / play:start handshake.

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 ConfidenceMatcherPipeline base class and the opm.pipeline entry-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

Release files for ovos-ocp-pipeline-plugin 1.3.0a1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ovos-ocp-pipeline-plugin 1.3.0a1
File	Size	Uploaded
ovos_ocp_pipeline_plugin-1.3.0a1.tar.gz	185.1 kB	Sep 2, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for ovos-ocp-pipeline-plugin 1.3.0a1
File	Interpreter	ABI	Platform	Reset
ovos_ocp_pipeline_plugin-1.3.0a1-py3-none-any.whl 210.3 kB Sep 2, 2026	Python 3	none	any	Details

Total release size: 395.5 kB

Release files / ovos_ocp_pipeline_plugin-1.3.0a1.tar.gz

Download URL	ovos_ocp_pipeline_plugin-1.3.0a1.tar.gz
Size	185.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`432aa378a02ded7dcac5598a88ecd3bf49373c71f3e7d8d80785609fbc4e81e9`
BLAKE2b-256 checksum How to use checksums	`54af26b02a767150e3fe2ae68a646681e57d75d78d49b0e3d90ad8c75e182165`
Upload date	Sep 2, 2026
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.3.0a1-py3-none-any.whl

Download URL	ovos_ocp_pipeline_plugin-1.3.0a1-py3-none-any.whl
Size	210.3 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`02329226952a34de885a08b943dc253b11bb4026cf34b43991fa4d4f3f084612`
BLAKE2b-256 checksum How to use checksums	`a195fc8b75d568a6a375ced11da1dec1aabb75b6627e033a2fc97cb9ed82ab7e`
Upload date	Sep 2, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.13.14`