PowerShell/docs/speak-countdown.md
2024-11-20 11:52:20 +01:00

76 lines
1.8 KiB
Markdown

The *speak-countdown.ps1* Script
===========================
This PowerShell script speaks a countdown by text-to-speech (TTS) starting from a given number.
Parameters
----------
```powershell
/home/markus/Repos/PowerShell/scripts/speak-countdown.ps1 [[-startNumber] <Int32>] [<CommonParameters>]
-startNumber <Int32>
Specifies the number to start from (10 by default)
Required? false
Position? 1
Default value 10
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-countdown.ps1 60
(listen and enjoy)
```
Notes
-----
Author: Markus Fleschutz | License: CC0
Related Links
-------------
https://github.com/fleschutz/PowerShell
Script Content
--------------
```powershell
<#
.SYNOPSIS
Speaks a countdown by text-to-speech
.DESCRIPTION
This PowerShell script speaks a countdown by text-to-speech (TTS) starting from a given number.
.PARAMETER startNumber
Specifies the number to start from (10 by default)
.EXAMPLE
PS> ./speak-countdown.ps1 60
(listen and enjoy)
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
param([int]$startNumber = 10)
try {
for ([int]$i = $startNumber; $i -gt 0; $i--) {
& "$PSScriptRoot/speak-english.ps1" $i
Start-Sleep -milliseconds 200
}
& "$PSScriptRoot/speak-english.ps1" "Zero and lift-off!"
exit 0 # success
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
exit 1
}
```
*(generated by convert-ps2md.ps1 as of 11/20/2024 11:52:00)*