Configuration
You can configure the following options for the [chime_tts.say
]((/chime_tts/docs/documentation/actions/say-action) and [chime_tts.say_url
]((/chime_tts/docs/documentation/actions/say_url-action) actions through the integration's configuration page:
Timeout
The duration (in seconds) to wait before terminating action calls.
Default Value: | 60 |
Required: | Yes |
Increase the timeout duration intend to generate audio longer than 60 seconds in length.
Default TTS Platform
The default [tts_platform
]((/chime_tts/docs/documentation/actions/say-action/parameters#tts_platform) value to use when not specified.
Default Value: | None |
Required: | No |
Default Language
The default [language
]((/chime_tts/docs/documentation/actions/say-action/parameters#language) value to use if the [tts_platform
]((/chime_tts/docs/documentation/actions/say-action/parameters#tts_platform) is set to the default TTS platform.
Default Value: | None |
Required: | No |
Default Voice
The default [voice
]((/chime_tts/docs/documentation/actions/say-action/parameters#voice) value to use if the [tts_platform
]((/chime_tts/docs/documentation/actions/say-action/parameters#tts_platform) is set to the default TTS platform.
Default Value: | None |
Required: | No |
Default Dialect
The default dialect domain (tld
) value if the [tts_platform
]((/chime_tts/docs/documentation/actions/say-action/parameters#tts_platform) is set to Google Translate.
Default Value: | None |
Required: | No |
Fallback TTS Platform
The TTS platform to use if an error occured when using the specified or default platform.
Default Value: | None |
Required: | No |
Default Offset
The default [offset]((/chime_tts/docs/documentation/actions/say-action/parameters#offset) duration (in milliseconds) between chimes and TTS audio.
Positive values introduce a delay, while negative values overlap the audio segments.
Default Value: | 450 |
Required: | No |
Fade Transition
The fade out duration (in milliseconds) of the now playing audio before an announcement and fading it duration of the now playing music afterwards.
This applies to [chime_tts.say
]((/chime_tts/docs/documentation/actions/say-action) action calls when the [announce
]((/chime_tts/docs/documentation/actions/say-action/parameters#announce) or [fade_audio
]((/chime_tts/docs/documentation/actions/say-action/parameters#fade_audio) parameters are used.
Default Value: | 500 |
Required: | No |
Delay Before Removing Temporary Files
The delay duaration after [chime_tts.say
]((/chime_tts/docs/documentation/actions/say-action) playback is completed (in milliseconds), before removing the generated temporary audio file.
Default Value: | None |
Required: | No |
Custom Chimes Folder
The local folder path containing custom audio files.
Any changes to the folder path or its contents will require a restart to take effect. [More info]((/chime_tts/docs/documentation/actions/say-action/#custom-chimes-folder)
Default Value: | None |
Required: | No |
Downloaded Chimes Folder
The local folder path where downloaded chime MP3 files will be stored.
Default Value: | {root}/media/sounds/temp/chime_tts/chimes/ |
Required: | Yes |
Temporary MP3 Folder
The local folder path where generated MP3 files will be stored.
Default Value: | {root}/media/sounds/temp/chime_tts/ |
Required: | Yes |
Make sure the temporary folder path is inside a media folder of your Home Assistant, otherwise the [chime_tts.say
]((/chime_tts/docs/documentation/actions/say-action) action will not be able to play the generated MP3 on your media_players.
chime_tts.say_url
Folder
The publicly facing folder path where MP3 files generated by the [chime_tts.say_url
]((/chime_tts/docs/documentation/actions/say_url-action) action will be stored.
Default Value: | {root}/config/www/chime_tts/ |
Required: | Yes |
MP3 Cover Art
When enabled, adds the Chime TTS logo as the cover art in generated MP3 files.
Default Value: | false |
Required: | No |