PowerShell/Docs/speak-file.md

69 lines
1.6 KiB
Markdown
Raw Normal View History

2022-12-04 10:40:18 +01:00
## The *speak-file.ps1* Script
2021-11-08 21:36:42 +01:00
2022-02-10 09:01:07 +01:00
This PowerShell script speaks the content of the given text file by text-to-speech (TTS).
2021-11-08 21:36:42 +01:00
## Parameters
```powershell
2021-12-09 16:19:09 +01:00
speak-file.ps1 [[-File] <String>] [<CommonParameters>]
2021-11-08 21:36:42 +01:00
-File <String>
Specifies the path to the text file
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-file C:\MyFile.txt
```
## 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 file content by text-to-speech
.DESCRIPTION
This PowerShell script speaks the content of the given text file by text-to-speech (TTS).
.PARAMETER File
Specifies the path to the text file
.EXAMPLE
PS> ./speak-file C:\MyFile.txt
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
param([string]$File = "")
try {
if ($File -eq "") { $File = read-host "Enter path to text file" }
$Text = Get-Content $File
$Voice = new-object -ComObject SAPI.SPVoice
$Result = $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
2021-11-08 21:36:42 +01:00
*Generated by convert-ps2md.ps1 using the comment-based help of speak-file.ps1*