# NeonAI Audio Files TTS Plugin
[Mycroft](https://mycroft-ai.gitbook.io/docs/mycroft-technologies/mycroft-core/plugins) compatible
TTS Plugin for playing back static audio files. Plugin will look for a file whose name matches the requested
TTS string and play it back.
## Configuration:
```yaml
tts:
module: neon-tts-plugin-audiofiles
neon-tts-plugin-audiofiles:
audio_file_path: ~/tts_audio_files
```
## Usage
The path to audio files should be specified in configuration as [noted above](#configuration).
If using this with the default [Neon Docker Implementation](https://github.com/NeonGeckoCom/NeonCore/tree/dev/docker),
audio files will be read from `xdg/data/neon/AudioFileTTS` by default.
Audio filenames should generally match the text used to generate them,
with any special characters (i.e. `/`) replaced with `_`. If
unsure about capitalization, files may be lowercased, though a properly cased
file will take priority over a lowercased one.
For example, the tts request `What time is it?` would resolve
the file `what time is it_.wav`
Some default audio files are provided with this plugin, but it is expected that
any potential TTS requests have supporting `wav` audio files at `audio_file_path`.
Audio files may be organized in any directory structure within that directory.
### Examples
| text | filename |
|------------------|----------------------|
| What time is it? | What time is it_.wav |
| It is 11:30 AM | it is 11_30 am.wav |
Raw data
{
"_id": null,
"home_page": "https://github.com/NeonGeckoCom/neon-tts-plugin-audiofiles",
"name": "neon-tts-plugin-audiofiles",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "mycroft plugin tts",
"author": "Neongecko",
"author_email": "developers@neon.ai",
"download_url": "https://files.pythonhosted.org/packages/f1/68/ec81b05761fcd5dd79d3c738bfb3f38fc21c364a15b3ee3163e57a3f1dff/neon-tts-plugin-audiofiles-0.0.3.tar.gz",
"platform": null,
"description": "# NeonAI Audio Files TTS Plugin\n[Mycroft](https://mycroft-ai.gitbook.io/docs/mycroft-technologies/mycroft-core/plugins) compatible\nTTS Plugin for playing back static audio files. Plugin will look for a file whose name matches the requested\nTTS string and play it back.\n\n## Configuration:\n```yaml\ntts:\n module: neon-tts-plugin-audiofiles\n neon-tts-plugin-audiofiles:\n audio_file_path: ~/tts_audio_files\n```\n\n## Usage\nThe path to audio files should be specified in configuration as [noted above](#configuration). \nIf using this with the default [Neon Docker Implementation](https://github.com/NeonGeckoCom/NeonCore/tree/dev/docker),\naudio files will be read from `xdg/data/neon/AudioFileTTS` by default. \n\nAudio filenames should generally match the text used to generate them, \nwith any special characters (i.e. `/`) replaced with `_`. If\nunsure about capitalization, files may be lowercased, though a properly cased\nfile will take priority over a lowercased one.\nFor example, the tts request `What time is it?` would resolve\nthe file `what time is it_.wav`\n\nSome default audio files are provided with this plugin, but it is expected that\nany potential TTS requests have supporting `wav` audio files at `audio_file_path`.\nAudio files may be organized in any directory structure within that directory.\n\n### Examples\n| text | filename |\n|------------------|----------------------|\n| What time is it? | What time is it_.wav |\n| It is 11:30 AM | it is 11_30 am.wav |\n\n",
"bugtrack_url": null,
"license": "BSD-3.0",
"summary": "A \"TTS\" plugin for Neon",
"version": "0.0.3",
"project_urls": {
"Homepage": "https://github.com/NeonGeckoCom/neon-tts-plugin-audiofiles"
},
"split_keywords": [
"mycroft",
"plugin",
"tts"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "f664f23cfd9d14680ddac00c21d8b224ee23010fa98f4c834320a3cc43e6bbc3",
"md5": "72b66617cb0eb7de82372d788b02b814",
"sha256": "9b24c354db276a3caa2cb44404159b5c7ec47c06550a11c1a7f38f07e13b5d7c"
},
"downloads": -1,
"filename": "neon_tts_plugin_audiofiles-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "72b66617cb0eb7de82372d788b02b814",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 552560,
"upload_time": "2025-03-11T23:33:40",
"upload_time_iso_8601": "2025-03-11T23:33:40.762201Z",
"url": "https://files.pythonhosted.org/packages/f6/64/f23cfd9d14680ddac00c21d8b224ee23010fa98f4c834320a3cc43e6bbc3/neon_tts_plugin_audiofiles-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "f168ec81b05761fcd5dd79d3c738bfb3f38fc21c364a15b3ee3163e57a3f1dff",
"md5": "d024e5d9561e6e71b292304fac977766",
"sha256": "4470544438c00e7b0d8aa94c80f01d1d88b19052cd263d3eedfb6d9823f3dd8b"
},
"downloads": -1,
"filename": "neon-tts-plugin-audiofiles-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "d024e5d9561e6e71b292304fac977766",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 554384,
"upload_time": "2025-03-11T23:33:42",
"upload_time_iso_8601": "2025-03-11T23:33:42.435626Z",
"url": "https://files.pythonhosted.org/packages/f1/68/ec81b05761fcd5dd79d3c738bfb3f38fc21c364a15b3ee3163e57a3f1dff/neon-tts-plugin-audiofiles-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-03-11 23:33:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NeonGeckoCom",
"github_project": "neon-tts-plugin-audiofiles",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "neon-tts-plugin-audiofiles"
}
JSON
