PowerShell/docs/play-beep-sound.md

60 lines
1.2 KiB
Markdown
Raw Normal View History

2024-11-08 12:38:20 +01:00
The *play-beep-sound.ps1* Script
===========================
2021-11-08 21:36:42 +01:00
2024-01-25 13:58:49 +01:00
This PowerShell script plays a short beep sound at 500Hz for 300ms.
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
2024-11-08 12:35:11 +01:00
/home/markus/Repos/PowerShell/scripts/play-beep-sound.ps1 [<CommonParameters>]
2021-11-08 21:36:42 +01:00
[<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
2024-01-25 13:58:49 +01:00
PS> ./play-beep-sound.ps1
(listen and enjoy)
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
Plays a short beep sound
.DESCRIPTION
2024-01-25 13:58:49 +01:00
This PowerShell script plays a short beep sound at 500Hz for 300ms.
2022-11-17 20:02:26 +01:00
.EXAMPLE
2024-01-25 13:58:49 +01:00
PS> ./play-beep-sound.ps1
(listen and enjoy)
2022-11-17 20:02:26 +01:00
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
2024-01-25 13:58:49 +01:00
try {
[System.Console]::Beep(500,300)
Start-Sleep -milliseconds 300
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
2024-11-08 12:38:20 +01:00
*(generated by convert-ps2md.ps1 using the comment-based help of play-beep-sound.ps1 as of 11/08/2024 12:37:55)*