@progress/kendo-angular-conversational-ui
Version:
Kendo UI for Angular Conversational UI components
88 lines (87 loc) • 3.62 kB
TypeScript
/**-----------------------------------------------------------------------------------------
* Copyright © 2026 Progress Software Corporation. All rights reserved.
* Licensed under commercial license. See LICENSE.md in the project root for more information
*-------------------------------------------------------------------------------------------*/
import { EventEmitter } from '@angular/core';
import { PromptBoxBaseTool } from './base-tool';
import { IntegrationMode } from '@progress/kendo-angular-buttons';
import { LocalizationService } from '@progress/kendo-angular-l10n';
import { SpeechToTextErrorEvent, SpeechToTextResultEvent } from '@progress/kendo-angular-buttons';
import * as i0 from "@angular/core";
/**
* Defines the **Speech to Text** button component for the PromptBox. Enables voice input through speech recognition.
*
* @example
* ```html
* <kendo-promptbox>
* <kendo-promptbox-end-affix>
* <kendo-promptbox-speech-to-text-button></kendo-promptbox-speech-to-text-button>
* </kendo-promptbox-end-affix>
* </kendo-promptbox>
* ```
*/
export declare class PromptBoxSpeechToTextButtonComponent extends PromptBoxBaseTool {
private localization;
/**
* Specifies whether continuous results are returned for each recognition, or only a single result once recognition stops.
*
* @default false
*/
continuous: boolean;
/**
* Specifies which speech recognition engine or integration the component should use. Allows the component to operate in different environments or use alternative implementations.
*
* @default 'webSpeech'
*/
integrationMode: IntegrationMode;
/**
* Sets whether interim results should be returned.
*
* @default false
*/
interimResults: boolean;
/**
* Sets a `BCP 47` language for speech recognition.
*
* @default 'en-US'
*/
lang: string;
/**
* Represents the maximum number of alternative transcriptions to return for each result.
*
* @default 1
*/
maxAlternatives: number;
/**
* Fires when the user clicks the **Speech to Text** button.
* @hidden
*/
stbClick: EventEmitter<any>;
/**
* Fires when the speech recognition service has begun listening to incoming audio.
* @hidden
*/
stbStart: EventEmitter<any>;
/**
* Fires when the speech recognition service has disconnected.
* @hidden
*/
stbEnd: EventEmitter<any>;
/**
* Fires when a speech recognition error occurs.
* @hidden
*/
stbError: EventEmitter<SpeechToTextErrorEvent>;
/**
* Fires when the speech recognition service returns a result.
* @hidden
*/
stbResult: EventEmitter<SpeechToTextResultEvent>;
constructor(localization: LocalizationService);
/**
* @hidden
*/
textFor(key: string): string;
static ɵfac: i0.ɵɵFactoryDeclaration<PromptBoxSpeechToTextButtonComponent, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<PromptBoxSpeechToTextButtonComponent, "kendo-promptbox-speech-to-text-button", ["kendoPromptBoxSpeechToTextButton"], { "continuous": { "alias": "continuous"; "required": false; }; "integrationMode": { "alias": "integrationMode"; "required": false; }; "interimResults": { "alias": "interimResults"; "required": false; }; "lang": { "alias": "lang"; "required": false; }; "maxAlternatives": { "alias": "maxAlternatives"; "required": false; }; }, { "stbClick": "stbClick"; "stbStart": "stbStart"; "stbEnd": "stbEnd"; "stbError": "stbError"; "stbResult": "stbResult"; }, never, never, true, never>;
}