Skip to main content

ovos-core audio daemon client

Project description

ovos-audio

The "mouth" of the OVOS assistant!

Handles TTS generation and sounds playback

Install

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.

Configuration

under mycroft.conf

{

  // Text to Speech parameters
  "tts": {
    "module": "ovos-tts-plugin-server",
    "fallback_module": "ovos-tts-plugin-mimic",
    "ovos-tts-plugin-mimic": {
        "voice": "ap"
    }
  },

  // File locations of sounds to play for system events
  "sounds": {
    "start_listening": "snd/start_listening.wav",
    "end_listening": "snd/end_listening.wav",
    "acknowledge": "snd/acknowledge.mp3",
    "error": "snd/error.mp3"
  },

  // Mechanism used to play WAV audio files
  "play_wav_cmdline": "paplay %1 --stream-name=mycroft-voice",

  // Mechanism used to play MP3 audio files
  "play_mp3_cmdline": "mpg123 %1",

  // Mechanism used to play OGG audio files
  "play_ogg_cmdline": "ogg123 -q %1"
}

Using Legacy AudioService

The legacy audio service supports audio playback via the old mycroft api (@mycroft @ovos)

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 can be used as the sole media playback provider

NOTE: once ovos-media is released OCP and this api will be disabled by default and deprecated!

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

legacy plugins:

OCP technical details:

  • 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 when configured to do so)
  • does NOT bring support for old Mycroft CommonPlay skills, that is achieved by using the "ocp_legacy" pipeline with ovos-core
  • ovos-media will fully replace OCP in ovos-audio 1.0.0

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ovos-audio-0.3.2a1.tar.gz (138.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ovos_audio-0.3.2a1-py3-none-any.whl (137.4 kB view details)

Uploaded Python 3

File details

Details for the file ovos-audio-0.3.2a1.tar.gz.

File metadata

  • Download URL: ovos-audio-0.3.2a1.tar.gz
  • Upload date:
  • Size: 138.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for ovos-audio-0.3.2a1.tar.gz
Algorithm Hash digest
SHA256 9e3afa20c4310d16c564492bc3e1be22f904ca31776046bfbddbb8356d0e8917
MD5 084f9f324a9b6867d1a9d2b9a48600c1
BLAKE2b-256 4cd73ea4326e60df858d72df1161c1b1eaefbc010324dce6296ab3df1f4ba11d

See more details on using hashes here.

File details

Details for the file ovos_audio-0.3.2a1-py3-none-any.whl.

File metadata

  • Download URL: ovos_audio-0.3.2a1-py3-none-any.whl
  • Upload date:
  • Size: 137.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for ovos_audio-0.3.2a1-py3-none-any.whl
Algorithm Hash digest
SHA256 112af7b2e014e8e3dc96517cc27e0f6103c91655e1a07e6f36158c8e8cb803f6
MD5 ec8bedc1b859a61283bc98bb08ed7931
BLAKE2b-256 cb9f98c55f35b066a23e35407ac8814a99f8d4ae306d0711c183f64f0307a4f0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page