Skip to main content

chime_tts.say_url Parameters

The chime_tts.say_url action generates a publicly accessible audio file; it does not play audio. It therefore accepts its own audio-generation parameters and does not accept media-player targets, volume, announcement, fade, or player-group controls.

Refer to the chime_tts.say parameters documentation for detailed behavior and segment examples. Configure the output location in Configuration; the folder must be an allowlisted external directory, /media, or /config/www.

Beta

repeat and repeat_delay are beta parameters for chime_tts.say_url and may change between releases. repeat is the number of additional copies to generate after the initial copy, so 0 means no repeat. repeat_delay inserts silence, in milliseconds, between copies of the complete chime-and-message audio.

pre_script and post_script are also beta parameters and may change between releases.

Repeated output uses a cache key that includes both repeat_delay and the current repeat semantics, so audio generated with the earlier repeat behavior is not reused.

Generated action reference

This table is generated from the current services.yaml schema and lists only parameters available to chime_tts.say_url.

FieldDescriptionDefault / example
chime_path
Chime Path
A preset or custom audio file to be played before TTS audiocustom_components/chime_tts/mp3s/bells.mp3
end_chime_path
End Chime Path
A preset or custom audio file to be played after TTS audiocustom_components/chime_tts/mp3s/tada.mp3
offset
Offset
Adds a delay between audio segments when value > 0, or overlays audio segments when value < 0.450
crossfade
Crossfade
Crossfade (in milliseconds) between audio segments1000
final_delay
Final Delay
Final delay (in milliseconds) added to the end of the audio100
message
Message
Text converted into TTS audioHello world!
tts_platform
TTS Platform
TTS platform used to generate TTS audiogoogle_translate
tts_speed
TTS Speed
Set the speed of the TTS audio to between 1% and 500% of the original125
tts_pitch
TTS Pitch
Change the the TTS pitch in semitones. Negative values for lower, positive for higher3
cache
Cache
Whether or not to save/reuse the generated audio file in a local cacheTrue
audio_conversion
Audio Conversion
Convert the audio to match Alexa speaker requirements, or use your own FFmpeg argumentsAlexa
language
Language
The TTS language (supported by Google Translate, Microsoft Edge TTS, Amazon Polly and Nabu Casa Cloud TTS)en
tld
TLD
The dialect (supported by Google Translate)com.au
voice
Voice
Define the voice for the TTS audio (on supported TTS platforms)en-AU
options
Options
YAML Options to pass to TTS services (will override `tld` and `voice` fields)tld: com.au\voice: en-AU