Modifier and Type | Field and Description |
---|---|
static String |
ACTION_GET_LANGUAGE_DETAILS
A broadcast intent which can be fired to the
BroadcastReceiver component specified
in the meta-data defined in the DETAILS_META_DATA meta-data of an
Activity satisfying ACTION_WEB_SEARCH . |
static String |
ACTION_RECOGNIZE_SPEECH
Starts an activity that will prompt the user for speech and send it through a
speech recognizer.
|
static String |
ACTION_VOICE_SEARCH_HANDS_FREE
Starts an activity that will prompt the user for speech without requiring the user's
visual attention or touch input.
|
static String |
ACTION_WEB_SEARCH
Starts an activity that will prompt the user for speech, send it through a
speech recognizer, and either display a web search result or trigger
another type of action based on the user's speech.
|
static String |
DETAILS_META_DATA
Meta-data name under which an
Activity implementing ACTION_WEB_SEARCH can
use to expose the class name of a BroadcastReceiver which can respond to request for
more information, from any of the broadcast intents specified in this class. |
static String |
EXTRA_CALLING_PACKAGE
The extra key used in an intent to the speech recognizer for voice search.
|
static String |
EXTRA_CONFIDENCE_SCORES
A float array of confidence scores of the recognition results when performing
ACTION_RECOGNIZE_SPEECH . |
static String |
EXTRA_LANGUAGE
Optional IETF language tag (as defined by BCP 47), for example "en-US".
|
static String |
EXTRA_LANGUAGE_MODEL
Informs the recognizer which speech model to prefer when performing
ACTION_RECOGNIZE_SPEECH . |
static String |
EXTRA_LANGUAGE_PREFERENCE
The key to the extra in the
Bundle returned by ACTION_GET_LANGUAGE_DETAILS
which is a String that represents the current language preference this user has
specified - a locale string like "en-US". |
static String |
EXTRA_MAX_RESULTS
Optional limit on the maximum number of results to return.
|
static String |
EXTRA_ONLY_RETURN_LANGUAGE_PREFERENCE
Specify this boolean extra in a broadcast of
ACTION_GET_LANGUAGE_DETAILS to
indicate that only the current language preference is needed in the response. |
static String |
EXTRA_ORIGIN
Optional value which can be used to indicate the referer url of a page in which
speech was requested.
|
static String |
EXTRA_PARTIAL_RESULTS
Optional boolean to indicate whether partial results should be returned by the recognizer
as the user speaks (default is false).
|
static String |
EXTRA_PROMPT
Optional text prompt to show to the user when asking them to speak.
|
static String |
EXTRA_RESULTS
An ArrayList<String> of the recognition results when performing
ACTION_RECOGNIZE_SPEECH . |
static String |
EXTRA_RESULTS_PENDINGINTENT
When the intent is
ACTION_RECOGNIZE_SPEECH , the speech input activity will
return results to you via the activity results mechanism. |
static String |
EXTRA_RESULTS_PENDINGINTENT_BUNDLE
If you use
EXTRA_RESULTS_PENDINGINTENT to supply a forwarding intent, you can
also use this extra to supply additional extras for the final intent. |
static String |
EXTRA_SECURE
Optional boolean to indicate that a "hands free" voice search was performed while the device
was in a secure mode.
|
static String |
EXTRA_SPEECH_INPUT_COMPLETE_SILENCE_LENGTH_MILLIS
The amount of time that it should take after we stop hearing speech to consider the input
complete.
|
static String |
EXTRA_SPEECH_INPUT_MINIMUM_LENGTH_MILLIS
The minimum length of an utterance.
|
static String |
EXTRA_SPEECH_INPUT_POSSIBLY_COMPLETE_SILENCE_LENGTH_MILLIS
The amount of time that it should take after we stop hearing speech to consider the input
possibly complete.
|
static String |
EXTRA_SUPPORTED_LANGUAGES
The key to the extra in the
Bundle returned by ACTION_GET_LANGUAGE_DETAILS
which is an ArrayList of String s that represents the languages supported by
this implementation of voice recognition - a list of strings like "en-US", "cmn-Hans-CN",
etc. |
static String |
EXTRA_WEB_SEARCH_ONLY
Optional boolean, to be used with
ACTION_WEB_SEARCH , to indicate whether to
only fire web searches in response to a user's speech. |
static String |
LANGUAGE_MODEL_FREE_FORM
Use a language model based on free-form speech recognition.
|
static String |
LANGUAGE_MODEL_WEB_SEARCH
Use a language model based on web search terms.
|
static int |
RESULT_AUDIO_ERROR
Result code returned when an audio error was encountered
|
static int |
RESULT_CLIENT_ERROR
Result code returned when there is a generic client error
|
static int |
RESULT_NETWORK_ERROR
Result code returned when a network error was encountered
|
static int |
RESULT_NO_MATCH
Result code returned when no matches are found for the given speech
|
static int |
RESULT_SERVER_ERROR
Result code returned when the recognition server returns an error
|
Modifier and Type | Method and Description |
---|---|
static Intent |
getVoiceDetailsIntent(Context context)
Returns the broadcast intent to fire with
Context.sendOrderedBroadcast(Intent, String, BroadcastReceiver, android.os.Handler, int, String, Bundle)
to receive details from the package that implements voice search. |
public static final String EXTRA_CALLING_PACKAGE
public static final String ACTION_RECOGNIZE_SPEECH
Activity.onActivityResult(int, int, android.content.Intent)
, if you start the intent using
Activity.startActivityForResult(Intent, int)
), or forwarded via a PendingIntent
if one is provided.
Starting this intent with just Activity.startActivity(Intent)
is not supported.
You must either use Activity.startActivityForResult(Intent, int)
, or provide a
PendingIntent, to receive recognition results.
Required extras:
Optional extras:
EXTRA_PROMPT
EXTRA_LANGUAGE
EXTRA_MAX_RESULTS
EXTRA_RESULTS_PENDINGINTENT
EXTRA_RESULTS_PENDINGINTENT_BUNDLE
Result extras (returned in the result, not to be specified in the request):
NOTE: There may not be any applications installed to handle this action, so you should
make sure to catch ActivityNotFoundException
.
public static final String ACTION_WEB_SEARCH
If you want to avoid triggering any type of action besides web search, you can use
the EXTRA_WEB_SEARCH_ONLY
extra.
Required extras:
Optional extras:
EXTRA_PROMPT
EXTRA_LANGUAGE
EXTRA_MAX_RESULTS
EXTRA_PARTIAL_RESULTS
EXTRA_WEB_SEARCH_ONLY
EXTRA_ORIGIN
Result extras (returned in the result, not to be specified in the request):
EXTRA_RESULTS
EXTRA_CONFIDENCE_SCORES
(optional)
NOTE: There may not be any applications installed to handle this action, so you should
make sure to catch ActivityNotFoundException
.
public static final String ACTION_VOICE_SEARCH_HANDS_FREE
EXTRA_SECURE
extra to determine
whether the device has been securely locked. If so, the activity should either restrict
the set of voice actions that are permitted or require some form of secure
authentication before proceeding.
To ensure that the activity's user interface is visible while the lock screen is showing,
the activity should set the
WindowManager.LayoutParams.FLAG_SHOW_WHEN_LOCKED
window flag.
Otherwise the activity's user interface may be hidden by the lock screen. The activity
should take care not to leak private information when the device is securely locked.
Optional extras:
public static final String EXTRA_SECURE
public static final String EXTRA_SPEECH_INPUT_MINIMUM_LENGTH_MILLIS
public static final String EXTRA_SPEECH_INPUT_COMPLETE_SILENCE_LENGTH_MILLIS
public static final String EXTRA_SPEECH_INPUT_POSSIBLY_COMPLETE_SILENCE_LENGTH_MILLIS
public static final String EXTRA_LANGUAGE_MODEL
ACTION_RECOGNIZE_SPEECH
. The recognizer uses this
information to fine tune the results. This extra is required. Activities implementing
ACTION_RECOGNIZE_SPEECH
may interpret the values as they see fit.public static final String LANGUAGE_MODEL_FREE_FORM
EXTRA_LANGUAGE_MODEL
.EXTRA_LANGUAGE_MODEL
,
Constant Field Valuespublic static final String LANGUAGE_MODEL_WEB_SEARCH
EXTRA_LANGUAGE_MODEL
.EXTRA_LANGUAGE_MODEL
,
Constant Field Valuespublic static final String EXTRA_PROMPT
public static final String EXTRA_LANGUAGE
Locale.getDefault()
.public static final String EXTRA_ORIGIN
public static final String EXTRA_MAX_RESULTS
public static final String EXTRA_WEB_SEARCH_ONLY
ACTION_WEB_SEARCH
, to indicate whether to
only fire web searches in response to a user's speech. The default is false, meaning
that other types of actions can be taken based on the user's speech.public static final String EXTRA_PARTIAL_RESULTS
public static final String EXTRA_RESULTS_PENDINGINTENT
ACTION_RECOGNIZE_SPEECH
, the speech input activity will
return results to you via the activity results mechanism. Alternatively, if you use this
extra to supply a PendingIntent, the results will be added to its bundle and the
PendingIntent will be sent to its target.public static final String EXTRA_RESULTS_PENDINGINTENT_BUNDLE
EXTRA_RESULTS_PENDINGINTENT
to supply a forwarding intent, you can
also use this extra to supply additional extras for the final intent. The search results
will be added to this bundle, and the combined bundle will be sent to the target.public static final int RESULT_NO_MATCH
public static final int RESULT_CLIENT_ERROR
public static final int RESULT_SERVER_ERROR
public static final int RESULT_NETWORK_ERROR
public static final int RESULT_AUDIO_ERROR
public static final String EXTRA_RESULTS
ACTION_RECOGNIZE_SPEECH
. Generally this list should be ordered in
descending order of speech recognizer confidence. (See EXTRA_CONFIDENCE_SCORES
).
Returned in the results; not to be specified in the recognition request. Only present
when Activity.RESULT_OK
is returned in an activity result. In a PendingIntent,
the lack of this extra indicates failure.public static final String EXTRA_CONFIDENCE_SCORES
ACTION_RECOGNIZE_SPEECH
. The array should be the same size as the ArrayList
returned in EXTRA_RESULTS
, and should contain values ranging from 0.0 to 1.0,
or -1 to represent an unavailable confidence score.
Confidence values close to 1.0 indicate high confidence (the speech recognizer is confident that the recognition result is correct), while values close to 0.0 indicate low confidence.
Returned in the results; not to be specified in the recognition request. This extra is
optional and might not be provided. Only present when Activity.RESULT_OK
is
returned in an activity result.
public static final String DETAILS_META_DATA
Activity
implementing ACTION_WEB_SEARCH
can
use to expose the class name of a BroadcastReceiver
which can respond to request for
more information, from any of the broadcast intents specified in this class.
Broadcast intents can be directed to the class name specified in the meta-data by creating
an Intent
, setting the component with
Intent.setComponent(android.content.ComponentName)
, and using
Context.sendOrderedBroadcast(Intent, String, BroadcastReceiver, android.os.Handler, int, String, android.os.Bundle)
with another BroadcastReceiver
which can receive the results.
The getVoiceDetailsIntent(Context)
method is provided as a convenience to create
a broadcast intent based on the value of this meta-data, if available.
This is optional and not all Activity
s which implement ACTION_WEB_SEARCH
are required to implement this. Thus retrieving this meta-data may be null.
public static final String ACTION_GET_LANGUAGE_DETAILS
BroadcastReceiver
component specified
in the meta-data defined in the DETAILS_META_DATA
meta-data of an
Activity
satisfying ACTION_WEB_SEARCH
.
When fired with
Context.sendOrderedBroadcast(Intent, String, BroadcastReceiver, android.os.Handler, int, String, android.os.Bundle)
,
a Bundle
of extras will be returned to the provided result receiver, and should
ideally contain values for EXTRA_LANGUAGE_PREFERENCE
and
EXTRA_SUPPORTED_LANGUAGES
.
(Whether these are actually provided is up to the particular implementation. It is
recommended that Activity
s implementing ACTION_WEB_SEARCH
provide this
information, but it is not required.)
public static final String EXTRA_ONLY_RETURN_LANGUAGE_PREFERENCE
ACTION_GET_LANGUAGE_DETAILS
to
indicate that only the current language preference is needed in the response. This
avoids any additional computation if all you need is EXTRA_LANGUAGE_PREFERENCE
in the response.public static final String EXTRA_LANGUAGE_PREFERENCE
Bundle
returned by ACTION_GET_LANGUAGE_DETAILS
which is a String
that represents the current language preference this user has
specified - a locale string like "en-US".public static final String EXTRA_SUPPORTED_LANGUAGES
Bundle
returned by ACTION_GET_LANGUAGE_DETAILS
which is an ArrayList
of String
s that represents the languages supported by
this implementation of voice recognition - a list of strings like "en-US", "cmn-Hans-CN",
etc.public static final Intent getVoiceDetailsIntent(Context context)
Context.sendOrderedBroadcast(Intent, String, BroadcastReceiver, android.os.Handler, int, String, Bundle)
to receive details from the package that implements voice search.
This is based on the value specified by the voice search Activity
in
DETAILS_META_DATA
, and if this is not specified, will return null. Also if there
is no chosen default to resolve for ACTION_WEB_SEARCH
, this will return null.
If an intent is returned and is fired, a Bundle
of extras will be returned to the
provided result receiver, and should ideally contain values for
EXTRA_LANGUAGE_PREFERENCE
and EXTRA_SUPPORTED_LANGUAGES
.
(Whether these are actually provided is up to the particular implementation. It is
recommended that Activity
s implementing ACTION_WEB_SEARCH
provide this
information, but it is not required.)
context
- a context object