Skip to content

Document SpeechRecognizer errors #639

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

Merged
jonathanpeppers merged 1 commit into from
Aug 18, 2026
Merged

Document SpeechRecognizer errors #639

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
90 changes: 74 additions & 16 deletions docs/xml/Android.Speech/SpeechRecognizerError.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary ToolPath="TrimmedButTooLong" tool="FirstSentenceInLongSummaries">To be added.</summary>
<summary>The reason speech recognition failed.</summary>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand All @@ -38,7 +38,7 @@
</ReturnValue>
<MemberValue>3</MemberValue>
<Docs>
<summary ToolPath="Trimmed" tool="FirstSentenceInJavadocToMdoc">Audio recording error.</summary>
<summary>Audio recording error.</summary>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -69,7 +69,15 @@
</ReturnValue>
<MemberValue>14</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The service does not allow support to be checked.</summary>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/speech/SpeechRecognizer#ERROR_CANNOT_CHECK_SUPPORT" title="Reference documentation">Java documentation for <code>android.speech.SpeechRecognizer.ERROR_CANNOT_CHECK_SUPPORT</code>.</a>
</format>
</para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="CannotListenToDownloadEvents">
Expand Down Expand Up @@ -97,7 +105,15 @@
</ReturnValue>
<MemberValue>15</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The service does not support listening for model download events.</summary>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/speech/SpeechRecognizer#ERROR_CANNOT_LISTEN_TO_DOWNLOAD_EVENTS" title="Reference documentation">Java documentation for <code>android.speech.SpeechRecognizer.ERROR_CANNOT_LISTEN_TO_DOWNLOAD_EVENTS</code>.</a>
</format>
</para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="Client">
Expand All @@ -121,7 +137,7 @@
</ReturnValue>
<MemberValue>5</MemberValue>
<Docs>
<summary ToolPath="Trimmed" tool="FirstSentenceInJavadocToMdoc">Other client side errors.</summary>
<summary>Other client side errors.</summary>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand All @@ -148,8 +164,13 @@
</ReturnValue>
<MemberValue>9</MemberValue>
<Docs>
<summary ToolPath="Untrimmed" tool="FirstSentenceInJavadocToMdoc">To be added.</summary>
<summary>Insufficient permissions.</summary>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/speech/SpeechRecognizer#ERROR_INSUFFICIENT_PERMISSIONS" title="Reference documentation">Java documentation for <code>android.speech.SpeechRecognizer.ERROR_INSUFFICIENT_PERMISSIONS</code>.</a>
</format>
</para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
Expand Down Expand Up @@ -179,7 +200,15 @@
</ReturnValue>
<MemberValue>12</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The requested language cannot be used with the current recognizer.</summary>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/speech/SpeechRecognizer#ERROR_LANGUAGE_NOT_SUPPORTED" title="Reference documentation">Java documentation for <code>android.speech.SpeechRecognizer.ERROR_LANGUAGE_NOT_SUPPORTED</code>.</a>
</format>
</para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="LanguageUnavailable">
Expand Down Expand Up @@ -207,7 +236,15 @@
</ReturnValue>
<MemberValue>13</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The requested language is supported but not currently available, such as when its model has not been downloaded.</summary>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/speech/SpeechRecognizer#ERROR_LANGUAGE_UNAVAILABLE" title="Reference documentation">Java documentation for <code>android.speech.SpeechRecognizer.ERROR_LANGUAGE_UNAVAILABLE</code>.</a>
</format>
</para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="Network">
Expand All @@ -231,7 +268,7 @@
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary ToolPath="Trimmed" tool="FirstSentenceInJavadocToMdoc">Other network related errors.</summary>
<summary>Other network related errors.</summary>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand All @@ -258,7 +295,7 @@
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary ToolPath="Trimmed" tool="FirstSentenceInJavadocToMdoc">Network operation timed out.</summary>
<summary>Network operation timed out.</summary>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand All @@ -285,7 +322,7 @@
</ReturnValue>
<MemberValue>7</MemberValue>
<Docs>
<summary ToolPath="Trimmed" tool="FirstSentenceInJavadocToMdoc">No recognition result matched.</summary>
<summary>No recognition result matched.</summary>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand All @@ -312,7 +349,7 @@
</ReturnValue>
<MemberValue>8</MemberValue>
<Docs>
<summary ToolPath="Trimmed" tool="FirstSentenceInJavadocToMdoc">RecognitionService busy.</summary>
<summary>RecognitionService busy.</summary>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand All @@ -339,7 +376,7 @@
</ReturnValue>
<MemberValue>4</MemberValue>
<Docs>
<summary ToolPath="Trimmed" tool="FirstSentenceInJavadocToMdoc">Server sends error status.</summary>
<summary>Server sends error status.</summary>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -370,7 +407,15 @@
</ReturnValue>
<MemberValue>11</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The server has disconnected, for example because the app crashed.</summary>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/speech/SpeechRecognizer#ERROR_SERVER_DISCONNECTED" title="Reference documentation">Java documentation for <code>android.speech.SpeechRecognizer.ERROR_SERVER_DISCONNECTED</code>.</a>
</format>
</para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="SpeechTimeout">
Expand All @@ -394,8 +439,13 @@
</ReturnValue>
<MemberValue>6</MemberValue>
<Docs>
<summary ToolPath="Untrimmed" tool="FirstSentenceInJavadocToMdoc">To be added.</summary>
<summary>No speech input was received.</summary>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/speech/SpeechRecognizer#ERROR_SPEECH_TIMEOUT" title="Reference documentation">Java documentation for <code>android.speech.SpeechRecognizer.ERROR_SPEECH_TIMEOUT</code>.</a>
</format>
</para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
Expand Down Expand Up @@ -425,7 +475,15 @@
</ReturnValue>
<MemberValue>10</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Too many requests were made by the same client.</summary>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/speech/SpeechRecognizer#ERROR_TOO_MANY_REQUESTS" title="Reference documentation">Java documentation for <code>android.speech.SpeechRecognizer.ERROR_TOO_MANY_REQUESTS</code>.</a>
</format>
</para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
</Members>
Expand Down
Loading