PowerShell/Docs/speak-english.md

73 lines
1.7 KiB
Markdown
Raw Normal View History

2022-12-04 10:40:18 +01:00
## The *speak-english.ps1* Script
2021-11-08 21:36:42 +01:00
2022-02-10 09:01:07 +01:00
This PowerShell scripts speaks the given text with an English text-to-speech (TTS) voice.
2021-11-08 21:36:42 +01:00
## Parameters
```powershell
2021-12-09 16:19:09 +01:00
speak-english.ps1 [[-text] <String>] [<CommonParameters>]
2021-11-08 21:36:42 +01:00
-text <String>
Specifies the text to speak
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
[<CommonParameters>]
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
```
## Example
```powershell
2022-11-17 19:46:02 +01:00
PS> ./speak-english Hello
2021-11-08 21:36:42 +01:00
```
## Notes
2022-11-17 19:46:02 +01:00
Author: Markus Fleschutz | License: CC0
2021-11-08 21:36:42 +01:00
## Related Links
https://github.com/fleschutz/PowerShell
2022-11-17 20:02:26 +01:00
## Source Code
2022-11-17 20:05:34 +01:00
```powershell
2022-11-17 20:02:26 +01:00
<#
.SYNOPSIS
Speaks text in English
.DESCRIPTION
This PowerShell scripts speaks the given text with an English text-to-speech (TTS) voice.
.PARAMETER text
Specifies the text to speak
.EXAMPLE
PS> ./speak-english Hello
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
param([string]$text = "")
try {
if ("$text" -eq "") { $text = read-host "Enter the English text to speak" }
$TTS = New-Object -ComObject SAPI.SPVoice
foreach ($Voice in $TTS.GetVoices()) {
if ($Voice.GetDescription() -like "*- English*") {
$TTS.Voice = $Voice
[void]$TTS.Speak($text)
exit 0 # success
}
}
throw "No English voice for text-to-speech (TTS) found - please install one."
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
exit 1
}
2022-11-17 20:05:34 +01:00
```
2022-11-17 20:02:26 +01:00
2021-11-08 21:36:42 +01:00
*Generated by convert-ps2md.ps1 using the comment-based help of speak-english.ps1*