PowerShell/Docs/set-volume.md
2023-09-13 09:49:05 +02:00

1.8 KiB

set-volume.ps1

This PowerShell script sets the audio volume in percent.

Parameters

PS> ./set-volume.ps1 [-Volume] <Int32> [<CommonParameters>]

-Volume <Int32>
    Specifies the percent number
    
    Required?                    true
    Position?                    1
    Default value                0
    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

PS> ./set-volume 50

Notes

Author: Markus Fleschutz | License: CC0

https://github.com/fleschutz/PowerShell

Script Content

<#
.SYNOPSIS
	Sets the volume 
.DESCRIPTION
	This PowerShell script sets the audio volume in percent.
.PARAMETER volume
	Specifies the percent number
.EXAMPLE
	PS> ./set-volume 50
.LINK
	https://github.com/fleschutz/PowerShell
.NOTES
	Author: Markus Fleschutz | License: CC0
#>

Param([Parameter(Mandatory=$true)] [ValidateRange(0,100)] [Int] $Volume)

try {
	# Create the Windows Shell object. 
	$obj = New-Object -ComObject WScript.Shell
    
	# First, set volume to zero. 
	1..50 | ForEach-Object {  $obj.SendKeys( [char] 174 )  }
    
	# Calculate number of (volume up) key presses 
	$keyPresses = [Math]::Ceiling( $Volume / 2 )
    
	# Raise volume to specified level. 
	for( $i = 0; $i -lt $keyPresses; $i++ ) {
		$obj.SendKeys( [char] 175 )
	}
	& "$PSScriptRoot/speak-english.ps1" "$($Volume)% volume."
	exit 0 # success
} catch {
	"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
	exit 1
}

(generated by convert-ps2md.ps1 using the comment-based help of set-volume.ps1 as of 09/13/2023 09:48:44)