Functions/GenXdev.Console/Get-IsSpeaking.cs
|
// ################################################################################
// Part of PowerShell module : GenXdev.Console // Original cmdlet filename : Get-IsSpeaking.cs // Original author : René Vaessen / GenXdev // Version : 1.302.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. // ################################################################################ using System; using System.Management.Automation; namespace GenXdev.Console { /// <summary> /// <para type="synopsis"> /// Returns true if the text-to-speech engine is speaking. /// </para> /// /// <para type="description"> /// Checks the state of both the default and customized speech synthesizers to /// determine if either is currently speaking. Returns true if speech is in progress, /// false otherwise. /// </para> /// /// <example> /// <para>Get-IsSpeaking</para> /// <para>Returns true if the text-to-speech engine is speaking.</para> /// <code> /// Get-IsSpeaking /// </code> /// </example> /// /// <example> /// <para>iss</para> /// <para>Returns true if the text-to-speech engine is speaking (using alias).</para> /// <code> /// iss /// </code> /// </example> /// </summary> [Cmdlet(VerbsCommon.Get, "IsSpeaking")] [Alias("iss")] [OutputType(typeof(System.Boolean))] public class GetIsSpeakingCommand : PSGenXdevCmdlet { /// <summary> /// Begin processing - initialization logic /// </summary> protected override void BeginProcessing() { WriteVerbose("Checking speech synthesizer states..."); } /// <summary> /// Process record - main cmdlet logic /// </summary> protected override void ProcessRecord() { try { // Execute the same PowerShell logic to maintain exact compatibility var results = InvokeCommand.InvokeScript( "([GenXdev.Helpers.Misc]::Speech.State -eq 'Speaking') -or " + "([GenXdev.Helpers.Misc]::SpeechCustomized.State -eq 'Speaking')"); // Return the boolean result WriteObject(results[0].BaseObject); } catch (Exception ex) { // Return false if unable to check speech state, matching original behavior WriteVerbose("Failed to check speech state: " + ex.Message); WriteObject(false); } } /// <summary> /// End processing - cleanup logic /// </summary> protected override void EndProcessing() { } } } |