Android APIs
public final class

VoiceInteractor

extends Object
java.lang.Object
   ↳ android.app.VoiceInteractor

Class Overview

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.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public VoiceInteractor.Request getActiveRequest (String name)

Added in API level 23

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

Parameters
name The name used to submit the request, as per submitRequest(android.app.VoiceInteractor.Request, String).
Returns
  • Returns the active request with that name, or null if there was none.

public Request[] getActiveRequests ()

Added in API level 23

Return all currently active requests.

public boolean submitRequest (VoiceInteractor.Request request)

Added in API level 23

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

Added in API level 23
Parameters
request The desired request to submit.
name An optional name for this request, or null. This can be used later with getActiveRequests() and getActiveRequest(String) to find the request.
Returns
  • Returns true of the request was successfully submitted, else false.

public boolean[] supportsCommands (String[] commands)

Added in API level 23

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 The array of commands to query for support.
Returns
  • Array of booleans indicating whether each command is supported or not.