Class: Ansible::Ruby::Modules::Win_say

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/windows/win_say.rb

Overview

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.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#end_sound_path ⇒ String?

Returns 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.

Returns:

  • (String, nil) —

    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.



32
 
# File 'lib/ansible/ruby/modules/generated/windows/win_say.rb', line 32

attribute :end_sound_path

#msg ⇒ Array<String>, ...

Returns 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.

Returns:

  • (Array<String>, String, nil) —

    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.



12
 
# File 'lib/ansible/ruby/modules/generated/windows/win_say.rb', line 12

attribute :msg

#msg_file ⇒ String?

Returns Full path to a windows format text file containing the text to be spokend.,Use either C(msg) or C(msg_file).,Optional so that you can use this module just to play sounds.

Returns:

  • (String, nil) —

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



16
 
# File 'lib/ansible/ruby/modules/generated/windows/win_say.rb', line 16

attribute :msg_file

#speech_speed ⇒ Integer?

Returns 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.

Returns:

  • (Integer, nil) —

    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.



24
 
# File 'lib/ansible/ruby/modules/generated/windows/win_say.rb', line 24

attribute :speech_speed

#start_sound_path ⇒ String?

Returns 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.

Returns:

  • (String, nil) —

    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.



28
 
# File 'lib/ansible/ruby/modules/generated/windows/win_say.rb', line 28

attribute :start_sound_path

#voice ⇒ String?

Returns 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).

Returns:

  • (String, nil) —

    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).



20
 
# File 'lib/ansible/ruby/modules/generated/windows/win_say.rb', line 20

attribute :voice