Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

SpeechRecognition.Recognize

Recognizes some text.

Component Version macOS Windows Linux Server iOS SDK
Speech 9.4 ✅ Yes ❌ No ❌ No ❌ No ✅ Yes
MBS( "SpeechRecognition.Recognize"; FilePath { ; Locale; Hint; Flags; contextualStrings } )   More

Parameters

Parameter Description Example Flags
FilePath The file path to the audio file to analyze. "/Users/cs/Desktop/test.m4a"
Locale The locale to use.
Leave empty to use user's current locale.		 "en-US" Optional
Hint The hint on what kind of speech recognition being performed
Can be Search, Dictation, Confirmation or Unspecified.
Default is Unspecified.		 "Dictation" Optional
Flags Various flags to control output:
Add 1 to require on device recognition.
Add 2 to output as JSON.
Add 4 to include all transcriptions variants in JSON, not just the best one.
Add 8 to include voice analysis in JSON.		 1 + 2 Optional

Added in version 16.3.
contextualStrings Phrases which should be recognized even if they are not in the system vocabulary. "Monkeybread Software¶Plugin" Optional

Result

Returns text, JSON or error.

Description

Recognizes some text.
The plugin creates a new speech recognition request based on the given audio file. Then we let the system recognize the text and return it to you.
This may take a while and the plugin returns after a few seconds when work is done.

Requires MacOS 10.15 or iOS 10 or newer.

See also

Release notes

Example Databases

Blog Entries

This function checks for a license.

Created 22nd August 2019, last changed 11st May 2026


SpeechRecognition.IsInitialized - SpeechRecognition.RequestAuthorization


MarkDown version: SpeechRecognitionRecognize.md