Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 2a5d9f9b authored by Jean-Michel Trivi's avatar Jean-Michel Trivi
Browse files

Fix bug 2553592 API REVIEW: android.speech 

Change 1 of 4
Notes from API Council review:
Rename RecognitionManager to SpeechRecognizer

Change-Id: I892c0d714d928d5e31575c72b6a36281fc4c7a8a
parent d4610977

api/current.xml

+219 −219
Original line number Diff line number Diff line
@@ -138081,225 +138081,6 @@ 
</parameter>

</method>

</interface>

<class name="RecognitionManager"

 extends="java.lang.Object"

 abstract="false"

 static="false"

 final="false"

 deprecated="not deprecated"

 visibility="public"

>

<method name="cancel"

 return="void"

 abstract="false"

 native="false"

 synchronized="false"

 static="false"

 final="false"

 deprecated="not deprecated"

 visibility="public"

>

</method>

<method name="createRecognitionManager"

 return="android.speech.RecognitionManager"

 abstract="false"

 native="false"

 synchronized="false"

 static="true"

 final="false"

 deprecated="not deprecated"

 visibility="public"

>

<parameter name="context" type="android.content.Context">

</parameter>

</method>

<method name="createRecognitionManager"

 return="android.speech.RecognitionManager"

 abstract="false"

 native="false"

 synchronized="false"

 static="true"

 final="false"

 deprecated="not deprecated"

 visibility="public"

>

<parameter name="context" type="android.content.Context">

</parameter>

<parameter name="serviceComponent" type="android.content.ComponentName">

</parameter>

</method>

<method name="destroy"

 return="void"

 abstract="false"

 native="false"

 synchronized="false"

 static="false"

 final="false"

 deprecated="not deprecated"

 visibility="public"

>

</method>

<method name="isRecognitionAvailable"

 return="boolean"

 abstract="false"

 native="false"

 synchronized="false"

 static="true"

 final="false"

 deprecated="not deprecated"

 visibility="public"

>

<parameter name="context" type="android.content.Context">

</parameter>

</method>

<method name="setRecognitionListener"

 return="void"

 abstract="false"

 native="false"

 synchronized="false"

 static="false"

 final="false"

 deprecated="not deprecated"

 visibility="public"

>

<parameter name="listener" type="android.speech.RecognitionListener">

</parameter>

</method>

<method name="startListening"

 return="void"

 abstract="false"

 native="false"

 synchronized="false"

 static="false"

 final="false"

 deprecated="not deprecated"

 visibility="public"

>

<parameter name="recognizerIntent" type="android.content.Intent">

</parameter>

</method>

<method name="stopListening"

 return="void"

 abstract="false"

 native="false"

 synchronized="false"

 static="false"

 final="false"

 deprecated="not deprecated"

 visibility="public"

>

</method>

<field name="ERROR_AUDIO"

 type="int"

 transient="false"

 volatile="false"

 value="3"

 static="true"

 final="true"

 deprecated="not deprecated"

 visibility="public"

>

</field>

<field name="ERROR_CLIENT"

 type="int"

 transient="false"

 volatile="false"

 value="5"

 static="true"

 final="true"

 deprecated="not deprecated"

 visibility="public"

>

</field>

<field name="ERROR_INSUFFICIENT_PERMISSIONS"

 type="int"

 transient="false"

 volatile="false"

 value="9"

 static="true"

 final="true"

 deprecated="not deprecated"

 visibility="public"

>

</field>

<field name="ERROR_NETWORK"

 type="int"

 transient="false"

 volatile="false"

 value="2"

 static="true"

 final="true"

 deprecated="not deprecated"

 visibility="public"

>

</field>

<field name="ERROR_NETWORK_TIMEOUT"

 type="int"

 transient="false"

 volatile="false"

 value="1"

 static="true"

 final="true"

 deprecated="not deprecated"

 visibility="public"

>

</field>

<field name="ERROR_NO_MATCH"

 type="int"

 transient="false"

 volatile="false"

 value="7"

 static="true"

 final="true"

 deprecated="not deprecated"

 visibility="public"

>

</field>

<field name="ERROR_RECOGNIZER_BUSY"

 type="int"

 transient="false"

 volatile="false"

 value="8"

 static="true"

 final="true"

 deprecated="not deprecated"

 visibility="public"

>

</field>

<field name="ERROR_SERVER"

 type="int"

 transient="false"

 volatile="false"

 value="4"

 static="true"

 final="true"

 deprecated="not deprecated"

 visibility="public"

>

</field>

<field name="ERROR_SPEECH_TIMEOUT"

 type="int"

 transient="false"

 volatile="false"

 value="6"

 static="true"

 final="true"

 deprecated="not deprecated"

 visibility="public"

>

</field>

<field name="RESULTS_RECOGNITION"

 type="java.lang.String"

 transient="false"

 volatile="false"

 value="&quot;results_recognition&quot;"

 static="true"

 final="true"

 deprecated="not deprecated"

 visibility="public"

>

</field>

</class>

<class name="RecognitionService"

 extends="android.app.Service"

 abstract="true"
@@ -138826,6 +138607,225 @@ 
>

</field>

</class>

<class name="SpeechRecognizer"

 extends="java.lang.Object"

 abstract="false"

 static="false"

 final="false"

 deprecated="not deprecated"

 visibility="public"

>

<method name="cancel"

 return="void"

 abstract="false"

 native="false"

 synchronized="false"

 static="false"

 final="false"

 deprecated="not deprecated"

 visibility="public"

>

</method>

<method name="createSpeechRecognizer"

 return="android.speech.SpeechRecognizer"

 abstract="false"

 native="false"

 synchronized="false"

 static="true"

 final="false"

 deprecated="not deprecated"

 visibility="public"

>

<parameter name="context" type="android.content.Context">

</parameter>

</method>

<method name="createSpeechRecognizer"

 return="android.speech.SpeechRecognizer"

 abstract="false"

 native="false"

 synchronized="false"

 static="true"

 final="false"

 deprecated="not deprecated"

 visibility="public"

>

<parameter name="context" type="android.content.Context">

</parameter>

<parameter name="serviceComponent" type="android.content.ComponentName">

</parameter>

</method>

<method name="destroy"

 return="void"

 abstract="false"

 native="false"

 synchronized="false"

 static="false"

 final="false"

 deprecated="not deprecated"

 visibility="public"

>

</method>

<method name="isRecognitionAvailable"

 return="boolean"

 abstract="false"

 native="false"

 synchronized="false"

 static="true"

 final="false"

 deprecated="not deprecated"

 visibility="public"

>

<parameter name="context" type="android.content.Context">

</parameter>

</method>

<method name="setRecognitionListener"

 return="void"

 abstract="false"

 native="false"

 synchronized="false"

 static="false"

 final="false"

 deprecated="not deprecated"

 visibility="public"

>

<parameter name="listener" type="android.speech.RecognitionListener">

</parameter>

</method>

<method name="startListening"

 return="void"

 abstract="false"

 native="false"

 synchronized="false"

 static="false"

 final="false"

 deprecated="not deprecated"

 visibility="public"

>

<parameter name="recognizerIntent" type="android.content.Intent">

</parameter>

</method>

<method name="stopListening"

 return="void"

 abstract="false"

 native="false"

 synchronized="false"

 static="false"

 final="false"

 deprecated="not deprecated"

 visibility="public"

>

</method>

<field name="ERROR_AUDIO"

 type="int"

 transient="false"

 volatile="false"

 value="3"

 static="true"

 final="true"

 deprecated="not deprecated"

 visibility="public"

>

</field>

<field name="ERROR_CLIENT"

 type="int"

 transient="false"

 volatile="false"

 value="5"

 static="true"

 final="true"

 deprecated="not deprecated"

 visibility="public"

>

</field>

<field name="ERROR_INSUFFICIENT_PERMISSIONS"

 type="int"

 transient="false"

 volatile="false"

 value="9"

 static="true"

 final="true"

 deprecated="not deprecated"

 visibility="public"

>

</field>

<field name="ERROR_NETWORK"

 type="int"

 transient="false"

 volatile="false"

 value="2"

 static="true"

 final="true"

 deprecated="not deprecated"

 visibility="public"

>

</field>

<field name="ERROR_NETWORK_TIMEOUT"

 type="int"

 transient="false"

 volatile="false"

 value="1"

 static="true"

 final="true"

 deprecated="not deprecated"

 visibility="public"

>

</field>

<field name="ERROR_NO_MATCH"

 type="int"

 transient="false"

 volatile="false"

 value="7"

 static="true"

 final="true"

 deprecated="not deprecated"

 visibility="public"

>

</field>

<field name="ERROR_RECOGNIZER_BUSY"

 type="int"

 transient="false"

 volatile="false"

 value="8"

 static="true"

 final="true"

 deprecated="not deprecated"

 visibility="public"

>

</field>

<field name="ERROR_SERVER"

 type="int"

 transient="false"

 volatile="false"

 value="4"

 static="true"

 final="true"

 deprecated="not deprecated"

 visibility="public"

>

</field>

<field name="ERROR_SPEECH_TIMEOUT"

 type="int"

 transient="false"

 volatile="false"

 value="6"

 static="true"

 final="true"

 deprecated="not deprecated"

 visibility="public"

>

</field>

<field name="RESULTS_RECOGNITION"

 type="java.lang.String"

 transient="false"

 volatile="false"

 value="&quot;results_recognition&quot;"

 static="true"

 final="true"

 deprecated="not deprecated"

 visibility="public"

>

</field>

</class>

</package>

<package name="android.speech.tts"

>

core/java/android/speech/IRecognitionListener.aidl

+1 −1
Original line number Diff line number Diff line
@@ -59,7 +59,7 @@ oneway interface IRecognitionListener { 
    /**

     * A network or recognition error occurred.

     *

     * @param error code is defined in {@link RecognitionManager}

     * @param error code is defined in {@link SpeechRecognizer}

     */

    void onError(in int error);

core/java/android/speech/IRecognitionService.aidl

+1 −1
Original line number Diff line number Diff line
@@ -25,7 +25,7 @@ import android.speech.IRecognitionListener; 
* you want to begin capturing audio; RecognitionService will automatically

* determine when the user has finished speaking, stream the audio to the

* recognition servers, and notify you when results are ready. In most of the cases, 

* this class should not be used directly, instead use {@link RecognitionManager} for

* this class should not be used directly, instead use {@link SpeechRecognizer} for

* accessing recognition service. 

* {@hide}

*/

core/java/android/speech/RecognitionListener.java

+5 −5
Original line number Diff line number Diff line
@@ -19,7 +19,7 @@ import android.content.Intent; 
import android.os.Bundle;



/**

 * Used for receiving notifications from the RecognitionManager when the

 * Used for receiving notifications from the SpeechRecognizer when the

 * recognition related events occur. All the callbacks are executed on the

 * Application main thread.

 */
@@ -61,7 +61,7 @@ public interface RecognitionListener { 
    /**

     * A network or recognition error occurred.

     * 

     * @param error code is defined in {@link RecognitionManager}

     * @param error code is defined in {@link SpeechRecognizer}

     */

    void onError(int error);
@@ -70,7 +70,7 @@ public interface RecognitionListener { 
     * 

     * @param results the recognition results. To retrieve the results in {@code

     *        ArrayList&lt;String&gt;} format use {@link Bundle#getStringArrayList(String)} with

     *        {@link RecognitionManager#RESULTS_RECOGNITION} as a parameter

     *        {@link SpeechRecognizer#RESULTS_RECOGNITION} as a parameter

     */

    void onResults(Bundle results);
@@ -78,13 +78,13 @@ public interface RecognitionListener { 
     * Called when partial recognition results are available. The callback might be called at any

     * time between {@link #onBeginningOfSpeech()} and {@link #onResults(Bundle)} when partial

     * results are ready. This method may be called zero, one or multiple times for each call to

     * {@link RecognitionManager#startListening(Intent)}, depending on the speech recognition

     * {@link SpeechRecognizer#startListening(Intent)}, depending on the speech recognition

     * service implementation.  To request partial results, use

     * {@link RecognizerIntent#EXTRA_PARTIAL_RESULTS}

     * 

     * @param partialResults the returned results. To retrieve the results in

     *        ArrayList&lt;String&gt; format use {@link Bundle#getStringArrayList(String)} with

     *        {@link RecognitionManager#RESULTS_RECOGNITION} as a parameter

     *        {@link SpeechRecognizer#RESULTS_RECOGNITION} as a parameter

     */

    void onPartialResults(Bundle partialResults);

core/java/android/speech/RecognitionService.java

+8 −8
Original line number Diff line number Diff line
@@ -89,7 +89,7 @@ public abstract class RecognitionService extends Service { 
            RecognitionService.this.onStartListening(intent, mCurrentCallback);

        } else {

            try {

                listener.onError(RecognitionManager.ERROR_RECOGNIZER_BUSY);

                listener.onError(SpeechRecognizer.ERROR_RECOGNIZER_BUSY);

            } catch (RemoteException e) {

                Log.d(TAG, "onError call from startListening failed");

            }
@@ -100,10 +100,10 @@ public abstract class RecognitionService extends Service { 
    private void dispatchStopListening(IRecognitionListener listener) {

        try {

            if (mCurrentCallback == null) {

                listener.onError(RecognitionManager.ERROR_CLIENT);

                listener.onError(SpeechRecognizer.ERROR_CLIENT);

                Log.w(TAG, "stopListening called with no preceding startListening - ignoring");

            } else if (mCurrentCallback.mListener.asBinder() != listener.asBinder()) {

                listener.onError(RecognitionManager.ERROR_RECOGNIZER_BUSY);

                listener.onError(SpeechRecognizer.ERROR_RECOGNIZER_BUSY);

                Log.w(TAG, "stopListening called by other caller than startListening - ignoring");

            } else { // the correct state

                RecognitionService.this.onStopListening(mCurrentCallback);
@@ -175,7 +175,7 @@ public abstract class RecognitionService extends Service { 
        }

        try {

            Log.e(TAG, "call for recognition service without RECORD_AUDIO permissions");

            listener.onError(RecognitionManager.ERROR_INSUFFICIENT_PERMISSIONS);

            listener.onError(SpeechRecognizer.ERROR_INSUFFICIENT_PERMISSIONS);

        } catch (RemoteException re) {

            Log.e(TAG, "sending ERROR_INSUFFICIENT_PERMISSIONS message failed", re);

        }
@@ -252,7 +252,7 @@ public abstract class RecognitionService extends Service { 
        /**

         * The service should call this method when a network or recognition error occurred.

         * 

         * @param error code is defined in {@link RecognitionManager}

         * @param error code is defined in {@link SpeechRecognizer}

         */

        public void error(int error) throws RemoteException {

            mCurrentCallback = null;
@@ -263,12 +263,12 @@ public abstract class RecognitionService extends Service { 
         * The service should call this method when partial recognition results are available. This

         * method can be called at any time between {@link #beginningOfSpeech()} and

         * {@link #results(Bundle)} when partial results are ready. This method may be called zero,

         * one or multiple times for each call to {@link RecognitionManager#startListening(Intent)},

         * one or multiple times for each call to {@link SpeechRecognizer#startListening(Intent)},

         * depending on the speech recognition service implementation.

         * 

         * @param partialResults the returned results. To retrieve the results in

         *        ArrayList&lt;String&gt; format use {@link Bundle#getStringArrayList(String)} with

         *        {@link RecognitionManager#RESULTS_RECOGNITION} as a parameter

         *        {@link SpeechRecognizer#RESULTS_RECOGNITION} as a parameter

         */

        public void partialResults(Bundle partialResults) throws RemoteException {

            mListener.onPartialResults(partialResults);
@@ -289,7 +289,7 @@ public abstract class RecognitionService extends Service { 
         * 

         * @param results the recognition results. To retrieve the results in {@code

         *        ArrayList&lt;String&gt;} format use {@link Bundle#getStringArrayList(String)} with

         *        {@link RecognitionManager#RESULTS_RECOGNITION} as a parameter

         *        {@link SpeechRecognizer#RESULTS_RECOGNITION} as a parameter

         */

        public void results(Bundle results) throws RemoteException {

            mCurrentCallback = null;