Metadata-Version: 2.4
Name: ovos_plugin_common_play
Version: 1.3.8a2
Summary: OVOS common play audio service adapter plugin
Author-email: JarbasAi <jarbasai@mailfence.com>
License: Apache-2.0
Project-URL: Homepage, https://github.com/OpenVoiceOS/ovos-ocp-audio-plugin
Keywords: ovos,audio,plugin
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Text Processing :: Linguistic
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: ovos-plugin-manager<3.0.0,>=0.0.26
Requires-Dist: ovos_bus_client<3.0.0,>=2.7.0a1
Requires-Dist: ovos-utils<1.0.0,>=0.1.0
Requires-Dist: ovos-workshop<10.0.0,>=2.4.2
Requires-Dist: padacioso<3.0.0,>=2.2.1a1
Requires-Dist: dbus-next
Provides-Extra: extractors
Requires-Dist: ovos-ocp-youtube-plugin<1.0.0,>=0.0.1; extra == "extractors"
Requires-Dist: ovos-ocp-rss-plugin<1.0.0,>=0.0.2; extra == "extractors"
Requires-Dist: ovos-ocp-m3u-plugin<1.0.0,>=0.0.1; extra == "extractors"
Requires-Dist: ovos-ocp-news-plugin<1.0.0,>=0.1.0; extra == "extractors"
Requires-Dist: ovos_audio_plugin_simple<1.0.0,>=0.0.1; extra == "extractors"
Requires-Dist: ovos-ocp-files-plugin~=0.13; extra == "extractors"
Provides-Extra: test
Requires-Dist: build; extra == "test"
Requires-Dist: wheel; extra == "test"
Requires-Dist: pytest~=7.1; extra == "test"
Requires-Dist: pytest-timeout~=2.1; extra == "test"
Requires-Dist: pytest-cov~=4.1; extra == "test"
Requires-Dist: ovos-audio<2.0.0,>=0.0.0; extra == "test"
Requires-Dist: ovos-config<2.0.0,>=0.0.13; extra == "test"
Requires-Dist: ovos-utils<1.0.0,>=0.1.0a17; extra == "test"
Requires-Dist: ovos-spec-tools>=1.5.0a1; extra == "test"
Requires-Dist: padacioso<3.0.0,>=2.2.1a1; extra == "test"
Requires-Dist: PyYAML~=6.0; extra == "test"
Dynamic: license-file

# OCP - OVOS Common Play

![](./ovos_plugin_common_play/ocp/res/desktop/OCP.png)

OVOS Common Play (OCP) is a voice media player packaged as a mycroft audio plugin. OCP handles voice integration and playback, and it also integrates with external players through MPRIS.

Skills provide the search results for OCP. Think of each skill as a media provider or catalog. You can find OCP skills in the [awesome-ocp-skills](https://github.com/OpenVoiceOS/awesome-ocp-skills) list.

## Configuration

Add this to `mycroft.conf`:

```json
{
  "Audio": {
    "backends": {
      "local": {
        "type": "ovos_common_play",
        "active": true
      },
      "simple": {
        "type": "ovos_audio_simple",
        "active": true
      }
    },
    "default-backend": "local"
  }
}
```

## Standalone Mode

> **DEPRECATED**: valid for ovos-core 0.0.7 only!

[ovos-audio](https://github.com/OpenVoiceOS/ovos-audio) normally starts and initializes OCP.

In some setups you may want to run OCP on its own. For example, if you run Hivemind Core with Hivemind Satellites, run OCP at the Core, not at a Satellite. A satellite cannot register OCP's intents, so run OCP in standalone mode near the Core instead.

The setup you use decides how you start standalone mode. This package provides the console script `ovos-ocp-standalone`, so running in standalone mode can be as simple as:

``` shell
pip install ovos-plugin-common-play
ovos-ocp-standalone
```

It reads its configuration from `~/.config/mycroft/mycroft.conf`, the same as other OVOS applications.
