fargo
1a822493ba
963 markdown files reformatted with the repository's pinned prettier so pnpm format:check covers the folded tree like every other repo file. The formatter's embedded-language pass also normalized code fences (TS semicolons, closed HTML tags in examples, lowercased CSS hex colors, one renumbered list that skipped an index). Alphanumeric token deltas vs the fold commit were audited file-by-file; all are formatter-equivalent markup normalizations plus the four sanitized skills.
2.3 KiB
2.3 KiB
category
| category |
|---|
| Sensors |
useSpeechRecognition
Reactive SpeechRecognition.
Usage
import { useSpeechRecognition } from '@vueuse/core';
const { isSupported, isListening, isFinal, result, start, stop } = useSpeechRecognition();
Options
The following shows the default values of the options, they will be directly passed to SpeechRecognition API.
import { useSpeechRecognition } from '@vueuse/core';
// ---cut---
useSpeechRecognition({
lang: 'en-US',
interimResults: true,
continuous: true,
});
Type Declarations
export interface UseSpeechRecognitionOptions extends ConfigurableWindow {
/**
* Controls whether continuous results are returned for each recognition, or only a single result.
*
* @default true
*/
continuous?: boolean;
/**
* Controls whether interim results should be returned (true) or not (false.) Interim results are results that are not yet final
*
* @default true
*/
interimResults?: boolean;
/**
* Language for SpeechRecognition
*
* @default 'en-US'
*/
lang?: MaybeRefOrGetter<string>;
/**
* A number representing the maximum returned alternatives for each result.
*
* @see https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition/maxAlternatives
* @default 1
*/
maxAlternatives?: number;
}
/**
* Reactive SpeechRecognition.
*
* @see https://vueuse.org/useSpeechRecognition
* @see https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition SpeechRecognition
* @param options
*/
export declare function useSpeechRecognition(options?: UseSpeechRecognitionOptions): {
isSupported: ComputedRef<boolean>;
isListening: ShallowRef<boolean, boolean>;
isFinal: ShallowRef<boolean, boolean>;
recognition: SpeechRecognition | undefined;
result: ShallowRef<string, string>;
error: ShallowRef<
Error | SpeechRecognitionErrorEvent | undefined,
Error | SpeechRecognitionErrorEvent | undefined
>;
toggle: (value?: boolean) => void;
start: () => void;
stop: () => void;
};
export type UseSpeechRecognitionReturn = ReturnType<typeof useSpeechRecognition>;