community.windows.win_say (2.2.0) — module

Install collection

Install with ansible-galaxy collection install community.windows:==2.2.0

Add to requirements.yml

  collections:
    - name: community.windows
      version: 2.2.0

Description

Uses .NET libraries to convert text to speech and optionally play .wav sounds. Audio Service needs to be running and some kind of speakers or headphones need to be attached to the windows target(s) for the speech to be audible.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Warn of impending deployment
  community.windows.win_say:
    msg: Warning, deployment commencing in 5 minutes, please log out.

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Using a different voice and a start sound
  community.windows.win_say:
    start_sound_path: C:\Windows\Media\ding.wav
    msg: Warning, deployment commencing in 5 minutes, please log out.
    voice: Microsoft Hazel Desktop

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: With start and end sound
  community.windows.win_say:
    start_sound_path: C:\Windows\Media\Windows Balloon.wav
    msg: New software installed
    end_sound_path: C:\Windows\Media\chimes.wav

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Text from file example
  community.windows.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

Inputs

    
msg:
    description:
    - The text to be spoken.
    - Use either C(msg) or C(msg_file).
    - Optional so that you can use this module just to play sounds.
    type: str

voice:
    description:
    - 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 C(Microsoft Zira Desktop) and C(Microsoft Hazel
      Desktop).
    type: str

msg_file:
    description:
    - Full path to a windows format text file containing the text to be spoken.
    - Use either C(msg) or C(msg_file).
    - Optional so that you can use this module just to play sounds.
    type: path

speech_speed:
    default: 0
    description:
    - 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.
    type: int

end_sound_path:
    description:
    - Full path to a C(.wav) file containing a sound to play after the text has been spoken.
    - Useful on conference calls to alert other speakers that ansible has finished speaking.
    type: path

start_sound_path:
    description:
    - Full path to a C(.wav) file containing a sound to play before the text is spoken.
    - Useful on conference calls to alert other speakers that ansible has something to
      say.
    type: path

Outputs

message_text:
  description: The text that the module attempted to speak.
  returned: success
  sample: Warning, deployment commencing in 5 minutes.
  type: str
voice:
  description: The voice used to speak the text.
  returned: success
  sample: Microsoft Hazel Desktop
  type: str
voice_info:
  description: The voice used to speak the text.
  returned: when requested voice could not be loaded
  sample: Could not load voice TestVoice, using system default voice
  type: str

See also

• community.windows.win_msg
• community.windows.win_toast