Merge pull request #6695 from syncfusion-content/983717-UG-docs-STT-3

983717: Enhanced the blazor documentation for Speech-to-text

Author: IndrajithSrinivasan

blazor/speech-to-text/methods.md

@@ -9,15 +9,17 @@ documentation: ug
 
 # Methods in Blazor SpeechToText component
 
+The Blazor SpeechToText component provides public methods that allow you to programmatically control its listening state.
+
 ## Start listening
 
-You can use the [StartListeningAsync](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SfSpeechToText.html#Syncfusion_Blazor_Inputs_SfSpeechToText_StartListeningAsync) public method to initiate the speech recognition and begins the conversion of the speech to text.
+The [StartListeningAsync](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SfSpeechToText.html#Syncfusion_Blazor_Inputs_SfSpeechToText_StartListeningAsync) public method programmatically initiates speech recognition. When called, the component begins capturing audio and converting it to text.
 
 ## Stop listening
 
-You can use the [StopListeningAsync](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SfSpeechToText.html#Syncfusion_Blazor_Inputs_SfSpeechToText_StopListeningAsync) public method to stop capturing your speech and ends the speech recognition.
+The [StopListeningAsync](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SfSpeechToText.html#Syncfusion_Blazor_Inputs_SfSpeechToText_StopListeningAsync) public method programmatically stops the speech recognition process.
 
-Below sample demonstrates the SpeechToText component configured with above methods.
+The following example demonstrates the SpeechToText component configured with above methods.
 
 {% tabs %}
 {% highlight razor %}

blazor/speech-to-text/security.md

@@ -7,35 +7,35 @@ control: SpeechToText
 documentation: ug
 ---
 
-# Security concerns in Blazor SpeechToText component
+# Security concerns in Blazor SpeechToText Component
 
 ## Online dependency
 
-The SpeechToText component typically relies on browser-based APIs, which may require an active internet connection. If an internet connection is unavailable, an offline fallback should be considered.
+The Syncfusion Blazor SpeechToText component utilizes browser-based Web Speech APIs, which generally require an active internet connection to process speech data. This dependency introduces important security and privacy considerations that developers must address.
 
-## Potential security risks
+## Potential Security Risks
 
-Understanding the risks associated with speech recognition.
+When using speech recognition technology, it is essential to be aware of the following potential security risks:
 
-### Data transmission to external servers
+### Data Transmission to External Servers
 
-The audio data is sent to third-party servers (e.g., Google, Microsoft) for processing. So the sensitive spoken information might be exposed to external entities.
+Since speech-to-text processing is often handled by third-party services (e.g., Google, Microsoft), audio data is transmitted to external servers. This can expose sensitive spoken information to external entities.
 
-### Privacy concerns
+### Privacy Concerns
 
-Some services may store user voice data for analytics or improving AI models. Users should verify browser and service policies.
+Some speech recognition services may retain voice data for analytics or to improve their models. It is crucial to review the privacy policies of both the browser and the specific speech service being used.
 
-### Man-in-the-Middle (MITM) attacks
+### Man-in-the-Middle (MITM) Attacks
 
-Without HTTPS, attackers could intercept audio data during transmission.
+If the application is not served over HTTPS, attackers could intercept the audio data stream during transmission in a Man-in-the-Middle (MITM) attack.
 
-### Browser and permission exploits
+### Browser and Permission Exploits
 
-Malicious websites may misuse permissions to eavesdrop on conversations. Explicit user consent is essential before enabling microphone access.
+A malicious website could misuse microphone permissions to eavesdrop on user conversations. Therefore, obtaining explicit user consent before accessing the microphone is a critical security measure.
 
-## Mitigation strategies
+## Mitigation Strategies
 
-Ensuring security and privacy when using speech recognition and how to mitigate them.
+To ensure security and privacy when implementing speech recognition, adopt the following mitigation strategies:
 
 * Use the component only in trusted environments.
 * Inform users about third-party data processing.

blazor/speech-to-text/speech-recognition.md

@@ -9,9 +9,11 @@ documentation: ug
 
 # Speech recognition in Blazor SpeechToText component
 
+The Syncfusion Blazor SpeechToText component offers a comprehensive set of features for managing the speech recognition process. You can retrieve transcribed text, configure the recognition language, control interim results, monitor the component's state, and handle errors.
+
 ## Retrieving transcripts
 
-You can use the [Transcript](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SfSpeechToText.html#Syncfusion_Blazor_Inputs_SfSpeechToText_Transcript) property to retrieve the transcribed text from the spoken text. This property allows to display the transcribed text once the speech recognition process is started.
+Use the [Transcript](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SfSpeechToText.html#Syncfusion_Blazor_Inputs_SfSpeechToText_Transcript) property to retrieve the transcribed text from spoken input. This property allows to display the transcribed text once the speech recognition process is started.
 
 {% tabs %}
 {% highlight razor %}
@@ -42,7 +44,7 @@ You can use the [Transcript](https://help.syncfusion.com/cr/blazor/Syncfusion.Bl
 
 ## Setting language
 
-You can use the [Language](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SfSpeechToText.html#Syncfusion_Blazor_Inputs_SfSpeechToText_Language) property to specify the language for speech recognition. Setting this property ensures that the recognition engine interprets the spoken words correctly based on the specified locale such as `en-US` for American `English`, `fr-FR` for `French`, and more.
+Specify the recognition language using the [Language](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SfSpeechToText.html#Syncfusion_Blazor_Inputs_SfSpeechToText_Language) property. This ensures the recognition engine correctly interprets speech based on the specified locale. The property accepts standard language codes, such as `en-US` for American English, `fr-FR` for French, or `es-ES` for Spanish.
 
 {% tabs %}
 {% highlight razor %}
@@ -73,7 +75,7 @@ You can use the [Language](https://help.syncfusion.com/cr/blazor/Syncfusion.Blaz
 
 ## Allowing interim results
 
-You can use the [AllowInterimResults](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SfSpeechToText.html#Syncfusion_Blazor_Inputs_SfSpeechToText_AllowInterimResults) property to enable or disable interim results. When set to `true`, the recognized speech will be displayed in real time as words are spoken. When set to `false`, only final results will be displayed after recognition is complete. By default, the value is `true`.
+The [AllowInterimResults](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SfSpeechToText.html#Syncfusion_Blazor_Inputs_SfSpeechToText_AllowInterimResults) property controls whether the component displays transcription results as they are being recognized. When `true` (the default), the `Transcript` is updated continuously. When `false`, the `Transcript` is updated only after the speaker pauses and the engine finalizes the result.
 
 {% tabs %}
 {% highlight razor %}
@@ -104,19 +106,11 @@ You can use the [AllowInterimResults](https://help.syncfusion.com/cr/blazor/Sync
 
 ## Managing listening state
 
-You can use the [ListeningState](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SfSpeechToText.html#Syncfusion_Blazor_Inputs_SfSpeechToText_ListeningState) property to manage the listening state of the component. The possible values are `Inactive`, `Listening` and `Stopped`. By default, the value is `Inactive`.
-
-### Inactive
-
-The component is in idle state with no active speech recognition.
-
-### Listening
-
-It is actively listening which captures and transcribes speech with a stop icon and blinking animation.
-
-### Stopped
+Track the component's status using the [ListeningState](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SfSpeechToText.html#Syncfusion_Blazor_Inputs_SfSpeechToText_ListeningState) property, which returns the current state of the speech recognition process. This is useful for providing visual feedback to the user.
 
-Denotes the speech recognition has ended, and no further speech is being processed.
+*   **Inactive**: The component is idle and not performing any recognition. This is the default state.
+*   **Listening**: The component is actively capturing audio and transcribing speech.
+*   **Stopped**: The speech recognition process has ended, and the component is no longer capturing audio.
 
 Below sample demonstrates the usage of [ListeningState](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SfSpeechToText.html#Syncfusion_Blazor_Inputs_SfSpeechToText_ListeningState) property.
 
@@ -251,7 +245,7 @@ Below sample demonstrates the usage of [ListeningState](https://help.syncfusion.
 
 ## Show or hide tooltip
 
-You can use the [ShowTooltip](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SfSpeechToText.html#Syncfusion_Blazor_Inputs_SfSpeechToText_ShowTooltip) property to specify the tooltip text to be displayed on hovering the SpeechToText button. By default, the value is `true`.
+Control the visibility of the tooltip on the component's microphone button using the [ShowTooltip](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SfSpeechToText.html#Syncfusion_Blazor_Inputs_SfSpeechToText_ShowTooltip) boolean property. When set to `false`, the default tooltip will not be displayed on hover. The default value is `true`.
 
 {% tabs %}
 {% highlight razor %}
@@ -284,7 +278,7 @@ You can use the [ShowTooltip](https://help.syncfusion.com/cr/blazor/Syncfusion.B
 
 ## Setting disabled
 
-You can use the [Disabled](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SfSpeechToText.html#Syncfusion_Blazor_Inputs_SfSpeechToText_Disabled) property to disable the SpeechToText component, preventing user interaction when set to `true`. By default, the value is `false`.
+Disable the SpeechToText component by setting the [Disabled](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SfSpeechToText.html#Syncfusion_Blazor_Inputs_SfSpeechToText_Disabled) property to `true`. This prevents all user interaction with the microphone button. By default, this property is `false`.
 
 {% tabs %}
 {% highlight razor %}
@@ -317,31 +311,31 @@ You can use the [Disabled](https://help.syncfusion.com/cr/blazor/Syncfusion.Blaz
 
 ## Setting html attributes
 
-You can use the [HtmlAttributes](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SfSpeechToText.html#Syncfusion_Blazor_Inputs_SfSpeechToText_HtmlAttributes) property to assign custom attributes to the SpeechToText component for the button element.
+The [HtmlAttributes](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SfSpeechToText.html#Syncfusion_Blazor_Inputs_SfSpeechToText_HtmlAttributes) property allows you to add custom HTML attributes to the component's root element.
 
 ## Error handling
 
-The SpeechToText component handles various errors that may occur during speech recognition. The following table lists the possible errors and their causes:
+The SpeechToText component provides error events to handle various issues during speech recognition. The following table lists common errors and their causes:
 
 | Error                | Cause                                                                                        |
 |----------------------|----------------------------------------------------------------------------------------------|
-| `no-speech`            | The microphone did not detect any speech input.                                              |
-| `aborted`              | The speech recognition process was intentionally terminated.                                 |
-| `audio-capture`        | The system was unable to detect a microphone device.                                         |
-| `not-allowed`          | Access to the microphone was denied by the user or browser settings.                         |
-| `service-not-allowed`  | The current context does not permit the use of the speech recognition service.               |
-| `network`              | A network issue is preventing the speech recognition service from functioning.               |
-| `unsupported-browser`  | The browser being used does not support the SpeechRecognition API.                           |
-| `default`              | An unidentified error occurred during the speech recognition process.                        |
+| `no-speech`            | The microphone did not detect any speech.                                                    |
+| `aborted`              | The recognition process was terminated, either by the user or programmatically.              |
+| `audio-capture`        | No microphone was found, or there was an issue accessing it.                                 |
+| `not-allowed`          | Microphone access was denied by the user or a browser security policy.                       |
+| `service-not-allowed`  | The browser or service denied recognition for security reasons.                              |
+| `network`              | A network connection error prevented communication with the recognition service.             |
+| `unsupported-browser`  | The browser does not support the Web Speech API.                                             |
+| `default`              | An unspecified or unknown error occurred.                                                    |
 
 ## Browser support
 
-The SpeechToText component relies on the [Speech Recognition API](https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition) for processing the speech input. Ensure that the browser supports this API before implementation.
+The SpeechToText component relies on the browser's implementation of the [Speech Recognition API](https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition). Ensure target browsers support this API.
 
-|    Browser    |    Supported versions    |
-|--------------|---------------|
-|    Chrome     |    25+    |
-|    Edge     |    79+    |
-|    Firefox     |    Not Supported    |
-|    Safari     |    12+    |
-|    Opera     |    30+    |
+| Browser      | Supported Versions |
+|--------------|--------------------|
+| Chrome       | 25+                |
+| Edge         | 79+                |
+| Safari       | 12+              |
+| Opera        | 30+                |
+| Firefox      | Not Supported      |