New in version 2.3.
Full path to a
The text to be spoken. Use either msg or msg_file. Optional so that you can use this module just to play sounds.
Full path to a windows format text file containing the text to be spokend. Use either msg or msg_file. Optional so that you can use this module just to play sounds.
How fast or slow to speak the text. Must be an integer value in the range -10 to 10. -10 is slowest, 10 is fastest.
Full path to a
||no||system default voice|
Which voice to use. See notes for how to discover installed voices. If the requested voice is not available the default voice will be used. Example voice names from Windows 10 are 'Microsoft Zira Desktop' and 'Microsoft Hazel Desktop'.
# Warn of impending deployment - win_say: msg: Warning, deployment commencing in 5 minutes, please log out. # Using a different voice and a start sound - win_say: start_sound_path: C:\Windows\Media\ding.wav msg: Warning, deployment commencing in 5 minutes, please log out. voice: Microsoft Hazel Desktop # example with start and end sound - win_say: start_sound_path: C:\Windows\Media\Windows Balloon.wav msg: New software installed end_sound_path: C:\Windows\Media\chimes.wav # text from file example - win_say: start_sound_path: C:\Windows\Media\Windows Balloon.wav msg_file: AppData\Local\Temp\morning_report.txt end_sound_path: C:\Windows\Media\chimes.wav
Common return values are documented here Return Values, the following are the fields unique to this module:
|message_text||the text that the module attempted to speak||success||string||Warning, deployment commencing in 5 minutes.|
|voice||the voice used to speak the text.||success||string||Microsoft Hazel Desktop|
|voice_info||the voice used to speak the text.||when requested voice could not be loaded||string||Could not load voice TestVoice, using system default voice|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is community maintained without core committer oversight.
For more information on what this means please read Module Support