Class
AIPromptSpeechToTextButtonSettings

Definition

Constructors

AIPromptSpeechToTextButtonSettings()

Declaration

cs-api-definition
public AIPromptSpeechToTextButtonSettings()

Properties

Continuous

Whether continuous results are returned for each recognition, or only a single result. Defaults value is false.

Declaration

cs-api-definition
[Parameter]
public bool Continuous { get; set; }

Property Value

bool

FillMode

Specifies the fill mode of the button. Default value is Clear.

Declaration

cs-api-definition
[Parameter]
public string FillMode { get; set; }

Property Value

string

IntegrationMode

The speech recognition engine or integration the component should use. This allows the component to operate in different environments or use alternative implementations. If unset, WebSpeech will be used.

Declaration

cs-api-definition
[Parameter]
public SpeechToTextButtonIntegrationMode IntegrationMode { get; set; }

Property Value

SpeechToTextButtonIntegrationMode

InterimResults

Whether interim results should be returned. Interim results are results that are not yet final. Defaults value is false.

Declaration

cs-api-definition
[Parameter]
public bool InterimResults { get; set; }

Property Value

bool

Lang

BCP 47 language tag (e.g., 'en-US', 'bg-BG'). Defaults to browser/system language.

Declaration

cs-api-definition
[Parameter]
public string Lang { get; set; }

Property Value

string

MaxAlternatives

The maximum returned alternatives for each result. Defaults value is 1.

Declaration

cs-api-definition
[Parameter]
public int MaxAlternatives { get; set; }

Property Value

int

OnClick

The Click handler of the button.

Declaration

cs-api-definition
[Parameter]
public EventCallback<MouseEventArgs> OnClick { get; set; }

Property Value

EventCallback<MouseEventArgs>

OnEnd

Event that fires when the speech recognition service has disconnected.

Declaration

cs-api-definition
[Parameter]
public EventCallback OnEnd { get; set; }

Property Value

EventCallback

OnError

Event that fires when a speech recognition error occurs, providing error details.

Declaration

cs-api-definition
[Parameter]
public EventCallback<string> OnError { get; set; }

Property Value

EventCallback<string>

OnResult

Event that fires when the speech recognition service returns a result - a word or phrase has been positively recognized.

Declaration

cs-api-definition
[Parameter]
public EventCallback<SpeechToTextButtonResultEventArgs> OnResult { get; set; }

Property Value

EventCallback<SpeechToTextButtonResultEventArgs>

OnStart

Event that fires when the speech recognition service has begun listening to incoming audio.

Declaration

cs-api-definition
[Parameter]
public EventCallback OnStart { get; set; }

Property Value

EventCallback

Rounded

Specifies the roundness of the button. Default value is Medium.

Declaration

cs-api-definition
[Parameter]
public virtual string Rounded { get; set; }

Property Value

string

Size

Specifies the size of the button. Default value is Medium.

Declaration

cs-api-definition
[Parameter]
public string Size { get; set; }

Property Value

string

ThemeColor

Specifies the theme color of the button. Default value is Base.

Declaration

cs-api-definition
[Parameter]
public virtual string ThemeColor { get; set; }

Property Value

string

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

cs-api-definition
protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder

RenderTreeBuilder

Overrides ComponentBase.BuildRenderTree(RenderTreeBuilder)

Dispose(bool)

Declaration

cs-api-definition
protected virtual void Dispose(bool disposing)

Parameters

disposing

bool

OnInitialized()

Declaration

cs-api-definition
protected override void OnInitialized()

Overrides ComponentBase.OnInitialized()