Skip to content

Commit 6a95a11

Browse files
Merge pull request #4064 from syncfusion-content/EJ2-943869-STT
documentation(943869): Need to add API links for all the properties in SpeechToText.
2 parents 6a43d09 + 0c9a1cf commit 6a95a11

File tree

12 files changed

+62
-56
lines changed

12 files changed

+62
-56
lines changed

ej2-asp-core-mvc/speech-to-text/EJ2_ASP.MVC/appearance.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,31 +12,31 @@ documentation: ug
1212

1313
## Customizing the button
1414

15-
You can use the `ButtonSettings` property to customize the appearance of the start and stop buttons in the speech to text conversion.
15+
You can use the [ButtonSettings](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Inputs.SpeechToText.html#Syncfusion_EJ2_Inputs_SpeechToText_ButtonSettings) property to customize the appearance of the start and stop buttons in the speech to text conversion.
1616

1717
### Setting start content
1818

19-
You can use the `Content` property to define text content for the listening start state in the SpeechToText button.
19+
You can use the [Content](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Inputs.SpeechToTextButtonSettings.html#Syncfusion_EJ2_Inputs_SpeechToTextButtonSettings_Content) property to define text content for the listening start state in the SpeechToText button.
2020

2121
### Setting stop content
2222

23-
You can use the `StopContent` property to define text content for the listening stop state in the SpeechToText button.
23+
You can use the [StopContent](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Inputs.SpeechToTextButtonSettings.html#Syncfusion_EJ2_Inputs_SpeechToTextButtonSettings_StopContent) property to define text content for the listening stop state in the SpeechToText button.
2424

2525
### Setting iconcss
2626

27-
You can use the `IconCss` property to apply a CSS class to customize the icon appearance for the listening start state.
27+
You can use the [IconCss](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Inputs.SpeechToTextButtonSettings.html#Syncfusion_EJ2_Inputs_SpeechToTextButtonSettings_IconCss) property to apply a CSS class to customize the icon appearance for the listening start state.
2828

2929
### Setting stop iconcss
3030

31-
You can use the `StopIconCss` property to apply a CSS class to customize the icon appearance for the listening stop state.
31+
You can use the [StopIconCss](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Inputs.SpeechToTextButtonSettings.html#Syncfusion_EJ2_Inputs_SpeechToTextButtonSettings_StopIconCss) property to apply a CSS class to customize the icon appearance for the listening stop state.
3232

3333
### Setting icon position
3434

35-
You can display the icon on the top, bottom, left, or right side of the button text content using the `iconPosition` property.
35+
You can display the icon on the top, bottom, left, or right side of the button text content using the [IconPosition](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Inputs.SpeechToTextButtonSettings.html#Syncfusion_EJ2_Inputs_SpeechToTextButtonSettings_IconPosition) property.
3636

3737
### Setting primary
3838

39-
You can use the `IsPrimary` property to configure the button as a primary action button.
39+
You can use the [IsPrimary](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Inputs.SpeechToTextButtonSettings.html#Syncfusion_EJ2_Inputs_SpeechToTextButtonSettings_IsPrimary) property to configure the button as a primary action button.
4040

4141
Below code sample demonstrates how to configure the button with above mentioned properties.
4242

@@ -53,19 +53,19 @@ Below code sample demonstrates how to configure the button with above mentioned
5353

5454
## Customizing the tooltips
5555

56-
You can use the `TooltipSettings` property to customize the content and positions of the tooltip.
56+
You can use the [TooltipSettings](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Inputs.SpeechToTextTooltipSettings.html) property to customize the content and positions of the tooltip.
5757

5858
### Setting start content
5959

60-
You can use the `Content` property to customize the content to be displayed in the tooltip when the speech recognition begins.
60+
You can use the [Content](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Inputs.SpeechToTextTooltipSettings.html#Syncfusion_EJ2_Inputs_SpeechToTextTooltipSettings_Content) property to customize the content to be displayed in the tooltip when the speech recognition begins.
6161

6262
### Setting stop content
6363

64-
You can use the `StopContent` property to customize the stop button tooltip text which is displayed on-hover.
64+
You can use the [StopContent](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Inputs.SpeechToTextTooltipSettings.html#Syncfusion_EJ2_Inputs_SpeechToTextTooltipSettings_StopContent) property to customize the stop button tooltip text which is displayed on-hover.
6565

6666
### Setting tooltip position
6767

68-
You can use the `Position` property to determine the placement of tooltips relative to the button.
68+
You can use the [Position](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Inputs.SpeechToTextTooltipSettings.html#Syncfusion_EJ2_Inputs_SpeechToTextTooltipSettings_Position) property to determine the placement of tooltips relative to the button.
6969

7070
Below code sample demonstrates how to configure the tooltip with above mentioned properties.
7171

@@ -82,7 +82,7 @@ Below code sample demonstrates how to configure the tooltip with above mentioned
8282

8383
## Setting button styles
8484

85-
The SpeechToText control supports the following predefined styles that can be defined using the `CssClass` property. You can customize by adding the cssClass property with the below defined class.
85+
The SpeechToText control supports the following predefined styles that can be defined using the [CssClass](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Inputs.SpeechToText.html#Syncfusion_EJ2_Inputs_SpeechToText_CssClass) property. You can customize by adding the cssClass property with the below defined class.
8686

8787
| cssClass | Description |
8888
| -------- | -------- |
@@ -95,7 +95,7 @@ The SpeechToText control supports the following predefined styles that can be de
9595

9696
## Setting cssclass
9797

98-
You can use the `cssClass` property to customize the appearance of the SpeechToText control.
98+
You can use the [CssClass](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Inputs.SpeechToText.html#Syncfusion_EJ2_Inputs_SpeechToText_CssClass) property to customize the appearance of the SpeechToText control.
9999

100100
{% tabs %}
101101
{% highlight razor tabtitle="CSHTML" %}

ej2-asp-core-mvc/speech-to-text/EJ2_ASP.MVC/events.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ This section describes the SpeechToText events that will be triggered when appro
1414

1515
|Name|Args|Description|
1616
|---|---|---|
17-
|Created|-|Triggers when the SpeechToText control's rendering is fully completed|
18-
|OnStart|StartListeningEventArgs|Triggers when the speech recognition begins|
19-
|OnStop|StopListeningEventArgs|Triggers when the speech recognition stops|
20-
|OnError|ErrorEventArgs|Triggers when an error occurs during speech recognition or while listening. For list of possible errors, refer to the [Error handling](./speech-recognition#error-handling) section|
21-
|TranscriptChanged|TranscriptChangedEventArgs|Triggers when an transcription change occurs during the speech recognition|
17+
|[Created](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Inputs.SpeechToText.html#Syncfusion_EJ2_Inputs_SpeechToText_Created)|-|Triggers when the SpeechToText control's rendering is fully completed|
18+
|[OnStart](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Inputs.SpeechToText.html#Syncfusion_EJ2_Inputs_SpeechToText_OnStart)|StartListeningEventArgs|Triggers when the speech recognition begins|
19+
|[OnStop](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Inputs.SpeechToText.html#Syncfusion_EJ2_Inputs_SpeechToText_OnStop)|StopListeningEventArgs|Triggers when the speech recognition stops|
20+
|[OnError](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Inputs.SpeechToText.html#Syncfusion_EJ2_Inputs_SpeechToText_OnError)|ErrorEventArgs|Triggers when an error occurs during speech recognition or while listening. For list of possible errors, refer to the [Error handling](./speech-recognition#error-handling) section|
21+
|[TranscriptChanged](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Inputs.SpeechToText.html#Syncfusion_EJ2_Inputs_SpeechToText_TranscriptChanged)|TranscriptChangedEventArgs|Triggers when an transcription change occurs during the speech recognition|
2222

2323
The following example demonstrates how to configure the SpeechToText events.
2424

ej2-asp-core-mvc/speech-to-text/EJ2_ASP.MVC/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ Press <kbd>Ctrl</kbd>+<kbd>F5</kbd> (Windows) or <kbd>⌘</kbd>+<kbd>F5</kbd> (m
9999

100100
## Adding button content
101101

102-
You can use the `Content` property to display the start listening text and `StopContent` to display the stop listening text by using the `ButtonSettings` property.
102+
You can use the [Content](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Inputs.SpeechToTextButtonSettings.html#Syncfusion_EJ2_Inputs_SpeechToTextButtonSettings_Content) property to display the start listening text and [StopContent](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Inputs.SpeechToTextButtonSettings.html#Syncfusion_EJ2_Inputs_SpeechToTextButtonSettings_StopContent) to display the stop listening text by using the [ButtonSettings](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Inputs.SpeechToText.html#Syncfusion_EJ2_Inputs_SpeechToText_ButtonSettings) property.
103103

104104
{% tabs %}
105105
{% highlight cshtml tabtitle="CSHTML" %}

ej2-asp-core-mvc/speech-to-text/EJ2_ASP.MVC/globalization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ The SpeechToText can be localized to any culture by defining the text in the cor
4242

4343
## RTL
4444

45-
RTL provides an option to switch the text direction and layout of the SpeechToText control from right to left by setting the `EnableRtl` property to true.
45+
RTL provides an option to switch the text direction and layout of the SpeechToText control from right to left by setting the [EnableRtl](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Inputs.SpeechToText.html#Syncfusion_EJ2_Inputs_SpeechToText_EnableRtl) property to true.
4646

4747
{% tabs %}
4848
{% highlight razor tabtitle="CSHTML" %}

ej2-asp-core-mvc/speech-to-text/EJ2_ASP.MVC/speech-recognition.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ documentation: ug
1212

1313
## Retrieving transcripts
1414

15-
You can use the `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.
15+
You can use the [Transcript](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Inputs.SpeechToText.html#Syncfusion_EJ2_Inputs_SpeechToText_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.
1616

1717
{% tabs %}
1818
{% highlight razor tabtitle="CSHTML" %}
@@ -27,7 +27,7 @@ You can use the `Transcript` property to retrieve the transcribed text from the
2727

2828
## Setting language
2929

30-
You can use the `Lang` 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.
30+
You can use the [Lang](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Inputs.SpeechToText.html#Syncfusion_EJ2_Inputs_SpeechToText_Lang) 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.
3131

3232
{% tabs %}
3333
{% highlight razor tabtitle="CSHTML" %}
@@ -42,7 +42,7 @@ You can use the `Lang` property to specify the language for speech recognition.
4242

4343
## Allowing interim results
4444

45-
You can use the `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`.
45+
You can use the [AllowInterimResults](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Inputs.SpeechToText.html#Syncfusion_EJ2_Inputs_SpeechToText_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`.
4646

4747
{% tabs %}
4848
{% highlight razor tabtitle="CSHTML" %}
@@ -57,7 +57,7 @@ You can use the `AllowInterimResults` property to enable or disable interim resu
5757

5858
## Managing listening state
5959

60-
You can use the `ListeningState` property to manage the listening state of the control. The possible values are `Inactive`, `Listening` and `Stopped`. By default, the value is `Inactive`.
60+
You can use the [ListeningState](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Inputs.SpeechToText.html#Syncfusion_EJ2_Inputs_SpeechToText_ListeningState) property to manage the listening state of the control. The possible values are [Inactive](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Inputs.SpeechToTextState.html#Syncfusion_EJ2_Inputs_SpeechToTextState_Inactive), [Listening](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Inputs.SpeechToTextState.html#Syncfusion_EJ2_Inputs_SpeechToTextState_Listening) and [Stopped](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Inputs.SpeechToTextState.html#Syncfusion_EJ2_Inputs_SpeechToTextState_Stopped). By default, the value is `Inactive`.
6161

6262
### Inactive
6363

@@ -71,7 +71,7 @@ It is actively listening which captures and transcribes speech with a stop icon
7171

7272
Denotes the speech recognition has ended, and no further speech is being processed.
7373

74-
Below sample demonstrates the usage of `ListeningState` property.
74+
Below sample demonstrates the usage of [ListeningState](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Inputs.SpeechToText.html#Syncfusion_EJ2_Inputs_SpeechToText_ListeningState) property.
7575

7676
{% tabs %}
7777
{% highlight razor tabtitle="CSHTML" %}
@@ -86,7 +86,7 @@ Below sample demonstrates the usage of `ListeningState` property.
8686

8787
## Show or hide tooltip
8888

89-
You can use the `ShowTooltip` property to specify the tooltip text to be displayed on hovering the SpeechToText button. By default, the value is `true`.
89+
You can use the [ShowTooltip](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Inputs.SpeechToText.html#Syncfusion_EJ2_Inputs_SpeechToText_ShowTooltip) property to specify the tooltip text to be displayed on hovering the SpeechToText button. By default, the value is `true`.
9090

9191
{% tabs %}
9292
{% highlight razor tabtitle="CSHTML" %}
@@ -101,7 +101,7 @@ You can use the `ShowTooltip` property to specify the tooltip text to be display
101101

102102
## Setting disabled
103103

104-
You can use the `Disabled` property to disable the SpeechToText, preventing user interaction when set to `true`. By default, the value is `false`.
104+
You can use the [Disabled](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Inputs.SpeechToText.html#Syncfusion_EJ2_Inputs_SpeechToText_Disabled) property to disable the SpeechToText, preventing user interaction when set to `true`. By default, the value is `false`.
105105

106106
{% tabs %}
107107
{% highlight razor tabtitle="CSHTML" %}
@@ -116,7 +116,7 @@ You can use the `Disabled` property to disable the SpeechToText, preventing user
116116

117117
## Setting html attributes
118118

119-
You can use the `HtmlAttributes` property to assign custom attributes to the SpeechToText control for the button element.
119+
You can use the [HtmlAttributes](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Inputs.SpeechToText.html#Syncfusion_EJ2_Inputs_SpeechToText_HtmlAttributes) property to assign custom attributes to the SpeechToText control for the button element.
120120

121121
## Error handling
122122

0 commit comments

Comments
 (0)