PowerShell/Docs/speak-file.md

75 lines
1.7 KiB
Markdown
Raw Normal View History

2023-07-29 10:15:44 +02:00
PS> *./speak-file.ps1*
2023-07-29 10:04:38 +02:00
====================
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
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-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.
```
2023-07-29 10:04:38 +02:00
Example
-------
2021-11-08 21:36:42 +01:00
```powershell
PS> ./speak-file C:\MyFile.txt
```
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 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
2023-07-29 10:15:44 +02:00
*(generated by convert-ps2md.ps1 using the comment-based help of speak-file.ps1 as of 07/29/2023 10:15:12)*