Skip to content

Most visited

Recently visited

navigation

VoiceInteractor

public final class VoiceInteractor
extends Object

java.lang.Object
   ↳ android.app.VoiceInteractor


Interface for an Activity to interact with the user through voice. Use Activity.getVoiceInteractor to retrieve the interface, if the activity is currently involved in a voice interaction.

The voice interactor revolves around submitting voice interaction requests to the back-end voice interaction service that is working with the user. These requests are submitted with submitRequest(VoiceInteractor.Request), providing a new instance of a VoiceInteractor.Request subclass describing the type of operation to perform -- currently the possible requests are VoiceInteractor.ConfirmationRequest and VoiceInteractor.CommandRequest.

Once a request is submitted, the voice system will process it and eventually deliver the result to the request object. The application can cancel a pending request at any time.

The VoiceInteractor is integrated with Activity's state saving mechanism, so that if an activity is being restarted with retained state, it will retain the current VoiceInteractor and any outstanding requests. Because of this, you should always use Request.getActivity to get back to the activity of a request, rather than holding on to the activity instance yourself, either explicitly or implicitly through a non-static inner class.

Summary

Nested classes

class VoiceInteractor.AbortVoiceRequest

Reports that the current interaction can not be complete with voice, so the application will need to switch to a traditional input UI. 

class VoiceInteractor.CommandRequest

Execute a vendor-specific command using the trusted system VoiceInteractionService. 

class VoiceInteractor.CompleteVoiceRequest

Reports that the current interaction was successfully completed with voice, so the application can report the final status to the user. 

class VoiceInteractor.ConfirmationRequest

Confirms an operation with the user via the trusted system VoiceInteractionService. 

class VoiceInteractor.PickOptionRequest

Select a single option from multiple potential options with the user via the trusted system VoiceInteractionService. 

class VoiceInteractor.Prompt

A set of voice prompts to use with the voice interaction system to confirm an action, select an option, or do similar operations. 

class VoiceInteractor.Request

Base class for voice interaction requests that can be submitted to the interactor. 

Public methods

VoiceInteractor.Request getActiveRequest(String name)

Return any currently active request that was submitted with the given name.

Request[] getActiveRequests()

Return all currently active requests.

boolean submitRequest(VoiceInteractor.Request request)
boolean submitRequest(VoiceInteractor.Request request, String name)

Submit a new VoiceInteractor.Request to the voice interaction service.

boolean[] supportsCommands(String[] commands)

Queries the supported commands available from the VoiceInteractionService.

Inherited methods

From class java.lang.Object

Public methods

getActiveRequest

added in API level 23
VoiceInteractor.Request getActiveRequest (String name)

Return any currently active request that was submitted with the given name.

Parameters
name String: The name used to submit the request, as per submitRequest(android.app.VoiceInteractor.Request, String).

Returns
VoiceInteractor.Request Returns the active request with that name, or null if there was none.

getActiveRequests

added in API level 23
Request[] getActiveRequests ()

Return all currently active requests.

Returns
Request[]

submitRequest

added in API level 23
boolean submitRequest (VoiceInteractor.Request request)

Parameters
request VoiceInteractor.Request

Returns
boolean

submitRequest

added in API level 23
boolean submitRequest (VoiceInteractor.Request request, 
                String name)

Submit a new VoiceInteractor.Request to the voice interaction service. The request must be one of the available subclasses -- VoiceInteractor.ConfirmationRequest, VoiceInteractor.PickOptionRequest, VoiceInteractor.CompleteVoiceRequest, VoiceInteractor.AbortVoiceRequest, or VoiceInteractor.CommandRequest.

Parameters
request VoiceInteractor.Request: The desired request to submit.

name String: An optional name for this request, or null. This can be used later with getActiveRequests() and getActiveRequest(String) to find the request.

Returns
boolean Returns true of the request was successfully submitted, else false.

supportsCommands

added in API level 23
boolean[] supportsCommands (String[] commands)

Queries the supported commands available from the VoiceInteractionService. The command is a string that describes the generic operation to be performed. An example might be "org.example.commands.PICK_DATE" to ask the user to pick a date. (Note: This is not an actual working example.)

Parameters
commands String: The array of commands to query for support.

Returns
boolean[] Array of booleans indicating whether each command is supported or not.

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.