PowerShell/Docs/speak-text.md

73 lines
1.6 KiB
Markdown
Raw Normal View History

2023-07-29 10:34:04 +02:00
*speak-text.ps1*
================
2021-11-08 21:36:42 +01:00
2022-02-10 09:01:07 +01:00
This PowerShell script speaks the given text by the default text-to-speech (TTS) voice.
2021-11-08 21:36:42 +01:00
2023-07-29 10:04:38 +02:00
Parameters
----------
2021-11-08 21:36:42 +01:00
```powershell
2023-07-29 10:15:44 +02:00
PS> ./speak-text.ps1 [[-text] <String>] [<CommonParameters>]
2021-11-08 21:36:42 +01:00
-text <String>
Specifies the text to read
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.
```
2023-07-29 10:04:38 +02:00
Example
-------
2021-11-08 21:36:42 +01:00
```powershell
2023-08-06 11:42:46 +02:00
PS> ./speak-text.ps1 Hi
2021-11-08 21:36:42 +01:00
```
2023-07-29 10:04:38 +02:00
Notes
-----
2022-11-17 19:46:02 +01:00
Author: Markus Fleschutz | License: CC0
2021-11-08 21:36:42 +01:00
2023-07-29 10:04:38 +02:00
Related Links
-------------
2021-11-08 21:36:42 +01:00
https://github.com/fleschutz/PowerShell
2023-07-29 10:04:38 +02:00
Script Content
--------------
2022-11-17 20:05:34 +01:00
```powershell
2022-11-17 20:02:26 +01:00
<#
.SYNOPSIS
Speaks text by the default text-to-speech voice
.DESCRIPTION
This PowerShell script speaks the given text by the default text-to-speech (TTS) voice.
.PARAMETER text
Specifies the text to read
.EXAMPLE
2023-08-06 11:42:46 +02:00
PS> ./speak-text.ps1 Hi
2022-11-17 20:02:26 +01:00
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
param([string]$text = "")
try {
2023-08-06 11:42:46 +02:00
if ($text -eq "") { $text = Read-Host "Enter the text to speak" }
2022-11-17 20:02:26 +01:00
$Voice = new-object -ComObject SAPI.SPVoice
[void]$Voice.Speak($text)
exit 0 # success
} 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
2023-10-19 08:12:00 +02:00
*(generated by convert-ps2md.ps1 using the comment-based help of speak-text.ps1 as of 10/19/2023 08:11:43)*