Skip to content

Add preferWebSpeechApi prop to SpeechInput component #319

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rovo89 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add preferWebSpeechApi prop to SpeechInput component #319

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions packages/elements/src/speech-input.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ type SpeechInputMode = "speech-recognition" | "media-recorder" | "none";

export type SpeechInputProps = ComponentProps<typeof Button> & {
onTranscriptionChange?: (text: string) => void;
preferWebSpeechApi?: boolean;
/**
* Callback for when audio is recorded using MediaRecorder fallback.
* This is called in browsers that don't support the Web Speech API (Firefox, Safari).
Expand All @@ -80,12 +81,12 @@ export type SpeechInputProps = ComponentProps<typeof Button> & {
lang?: string;
};

const detectSpeechInputMode = (): SpeechInputMode => {
const detectSpeechInputMode = (preferWebSpeechApi: boolean): SpeechInputMode => {
if (typeof window === "undefined") {
return "none";
}

if ("SpeechRecognition" in window || "webkitSpeechRecognition" in window) {
if (preferWebSpeechApi && ("SpeechRecognition" in window || "webkitSpeechRecognition" in window)) {
return "speech-recognition";
}

Expand All @@ -100,6 +101,7 @@ export const SpeechInput = ({
className,
onTranscriptionChange,
onAudioRecorded,
preferWebSpeechApi = true,
lang = "en-US",
...props
}: SpeechInputProps) => {
Expand All @@ -115,8 +117,8 @@ export const SpeechInput = ({

// Detect mode on mount
useEffect(() => {
setMode(detectSpeechInputMode());
}, []);
setMode(detectSpeechInputMode(preferWebSpeechApi));
}, [preferWebSpeechApi]);

// Initialize Speech Recognition when mode is speech-recognition
useEffect(() => {
Expand Down