PowerShell/Docs/speak-english.md
2023-05-26 12:20:18 +02:00

73 lines
1.7 KiB
Markdown

## The *speak-english.ps1* Script
This PowerShell scripts speaks the given text with an English text-to-speech (TTS) voice.
## Parameters
```powershell
/home/mf/Repos/PowerShell/Scripts/speak-english.ps1 [[-text] <String>] [<CommonParameters>]
-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
PS> ./speak-english Hi
```
## Notes
Author: Markus Fleschutz | License: CC0
## Related Links
https://github.com/fleschutz/PowerShell
## Source Code
```powershell
<#
.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 Hi
.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
}
```
*Generated by convert-ps2md.ps1 using the comment-based help of speak-english.ps1*