Functions/GenXdev.Console/Stop-TextToSpeech.ps1
|
<##############################################################################
Part of PowerShell module : GenXdev.Console Original cmdlet filename : Stop-TextToSpeech.ps1 Original author : René Vaessen / GenXdev Version : 1.300.2025 ################################################################################ Copyright (c) René Vaessen / GenXdev Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ################################################################################> ############################################################################### <# .SYNOPSIS Immediately stops any ongoing text-to-speech output. .DESCRIPTION Halts all active and queued speech synthesis by canceling both standard and customized speech operations. This provides an immediate silence for any ongoing text-to-speech activities. .EXAMPLE PS C:\> Stop-TextToSpeech Immediately stops any ongoing speech .EXAMPLE PS C:\> say "Hello world"; sst Starts speaking but gets interrupted immediately .NOTES This cmdlet is commonly used in conjunction with Start-TextToSpeech (alias: say) and Skip-TextToSpeech (alias: sstSkip) for speech control. #> function Stop-TextToSpeech { [CmdletBinding(SupportsShouldProcess = $true)] [Alias('sst')] param() begin { Microsoft.PowerShell.Utility\Write-Verbose 'Initiating speech cancellation request' } process { try { if ($PSCmdlet.ShouldProcess('Text-to-speech output', 'Stop')) { # cancel all pending standard speech operations $null = [GenXdev.Helpers.Misc]::Speech.SpeakAsyncCancelAll() # cancel all pending customized speech operations $null = [GenXdev.Helpers.Misc]::SpeechCustomized.SpeakAsyncCancelAll() Microsoft.PowerShell.Utility\Write-Verbose 'Successfully cancelled all speech operations' } } catch { # silently handle any speech cancellation errors Microsoft.PowerShell.Utility\Write-Verbose 'Error occurred while attempting to cancel speech' } } end { } } |