VoiceInteractionService

public class VoiceInteractionService
extends Service

java.lang.Object
   ↳ android.content.Context
     ↳ android.content.ContextWrapper
       ↳ android.app.Service
         ↳ android.service.voice.VoiceInteractionService


Top-level service of the current global voice interactor, which is providing support for hotwording, the back-end of a VoiceInteractor, etc. The current VoiceInteractionService that has been selected by the user is kept always running by the system, to allow it to do things like listen for hotwords in the background to instigate voice interactions.

Because this service is always running, it should be kept as lightweight as possible. Heavy-weight operations (including showing UI) should be implemented in the associated VoiceInteractionSessionService when an actual voice interaction is taking place, and that service should run in a separate process from this one.

Summary

Constants

String SERVICE_INTERFACE

The Intent that must be declared as handled by the service.

String SERVICE_META_DATA

Name under which a VoiceInteractionService component publishes information about itself.

Inherited constants

Public constructors

VoiceInteractionService()

Public methods

int getDisabledShowContext()

Return the value set by setDisabledShowContext(int).

static boolean isActiveService(Context context, ComponentName service)

Check whether the given service component is the currently active VoiceInteractionService.

IBinder onBind(Intent intent)

Return the communication channel to the service.

Set<String> onGetSupportedVoiceActions(Set<String> voiceActions)

Request to query for what extended voice actions this service supports.

void onLaunchVoiceAssistFromKeyguard()

Called when a user has activated an affordance to launch voice assist from the Keyguard.

void onPrepareToShowSession(Bundle args, int flags)

Notify the interactor when the system prepares to show session.

void onReady()

Called during service initialization to tell you when the system is ready to receive interaction from it.

void onShowSessionFailed(Bundle args)

Called when the show session failed.

void onShutdown()

Called during service de-initialization to tell you when the system is shutting the service down.

void setDisabledShowContext(int flags)

Set contextual options you would always like to have disabled when a session is shown.

final void setUiHints(Bundle hints)

Provide hints to be reflected in the system UI.

void showSession(Bundle args, int flags)

Request that the associated VoiceInteractionSession be shown to the user, starting it if necessary.

Protected methods

void dump(FileDescriptor fd, PrintWriter pw, String[] args)

Print the Service's state into the given stream.

Inherited methods

Constants

SERVICE_INTERFACE

Added in API level 21
public static final String SERVICE_INTERFACE

The Intent that must be declared as handled by the service. To be supported, the service must also require the Manifest.permission.BIND_VOICE_INTERACTION permission so that other applications can not abuse it.

Constant Value: "android.service.voice.VoiceInteractionService"

SERVICE_META_DATA

Added in API level 21
public static final String SERVICE_META_DATA

Name under which a VoiceInteractionService component publishes information about itself. This meta-data should reference an XML resource containing a <voice-interaction-service> tag.

Constant Value: "android.voice_interaction"

Public constructors

VoiceInteractionService

public VoiceInteractionService ()

Public methods

getDisabledShowContext

Added in API level 23
public int getDisabledShowContext ()

Return the value set by setDisabledShowContext(int).

Returns
int

isActiveService

Added in API level 21
public static boolean isActiveService (Context context, 
                ComponentName service)

Check whether the given service component is the currently active VoiceInteractionService.

Parameters
context Context

service ComponentName

Returns
boolean

onBind

Added in API level 21
public IBinder onBind (Intent intent)

Return the communication channel to the service. May return null if clients can not bind to the service. The returned IBinder is usually for a complex interface that has been described using aidl.

Note that unlike other application components, calls on to the IBinder interface returned here may not happen on the main thread of the process. More information about the main thread can be found in Processes and Threads.

Parameters
intent Intent: The Intent that was used to bind to this service, as given to Context.bindService. Note that any extras that were included with the Intent at that point will not be seen here.

Returns
IBinder Return an IBinder through which clients can call on to the service.

onGetSupportedVoiceActions

Added in API level 29
public Set<String> onGetSupportedVoiceActions (Set<String> voiceActions)

Request to query for what extended voice actions this service supports. This method will be called when the system checks the supported actions of this VoiceInteractionService. Supported actions may be delivered to VoiceInteractionSession later to request a session to perform an action.

Voice actions are defined in support libraries and could vary based on platform context. For example, car related voice actions will be defined in car support libraries.

Parameters
voiceActions Set: A set of checked voice actions. This value cannot be null.

Returns
Set<String> Returns a subset of checked voice actions. Additional voice actions in the returned set will be ignored. Returns empty set if no actions are supported. This value cannot be null.

onLaunchVoiceAssistFromKeyguard

Added in API level 23
public void onLaunchVoiceAssistFromKeyguard ()

Called when a user has activated an affordance to launch voice assist from the Keyguard.

This method will only be called if the VoiceInteractionService has set R.attr.supportsLaunchVoiceAssistFromKeyguard and the Keyguard is showing.

A valid implementation must start a new activity that should use WindowManager.LayoutParams.FLAG_SHOW_WHEN_LOCKED to display on top of the lock screen.

onPrepareToShowSession

Added in API level 34
public void onPrepareToShowSession (Bundle args, 
                int flags)

Notify the interactor when the system prepares to show session. The system is going to bind the session service.

Parameters
args Bundle: The arguments that were supplied to showSession(android.os.Bundle, int). It always includes VoiceInteractionSession#KEY_SHOW_SESSION_ID. This value cannot be null.

flags int: The show flags originally provided to showSession(android.os.Bundle, int).

onReady

Added in API level 21
public void onReady ()

Called during service initialization to tell you when the system is ready to receive interaction from it. You should generally do initialization here rather than in Service.onCreate(). Methods such as showSession(Bundle, int) will not be operational until this point.

onShowSessionFailed

Added in API level 34
public void onShowSessionFailed (Bundle args)

Called when the show session failed. E.g. When the system bound the session service failed.

Parameters
args Bundle: Additional info about the show session attempt that failed. For now, includes VoiceInteractionSession#KEY_SHOW_SESSION_ID. This value cannot be null.

onShutdown

Added in API level 21
public void onShutdown ()

Called during service de-initialization to tell you when the system is shutting the service down. At this point this service may no longer be the active VoiceInteractionService.

setDisabledShowContext

Added in API level 23
public void setDisabledShowContext (int flags)

Set contextual options you would always like to have disabled when a session is shown. The flags may be any combination of VoiceInteractionSession.SHOW_WITH_ASSIST and VoiceInteractionSession.SHOW_WITH_SCREENSHOT.

Parameters
flags int

setUiHints

Added in API level 29
public final void setUiHints (Bundle hints)

Provide hints to be reflected in the system UI.

Parameters
hints Bundle: Arguments used to show UI. This value cannot be null.

showSession

Added in API level 23
public void showSession (Bundle args, 
                int flags)

Request that the associated VoiceInteractionSession be shown to the user, starting it if necessary.

Parameters
args Bundle: Arbitrary arguments that will be propagated to the session.

flags int: Indicates additional optional behavior that should be performed. May be any combination of VoiceInteractionSession.SHOW_WITH_ASSIST and VoiceInteractionSession.SHOW_WITH_SCREENSHOT to request that the system generate and deliver assist data on the current foreground app as part of showing the session UI.

Protected methods

dump

Added in API level 21
protected void dump (FileDescriptor fd, 
                PrintWriter pw, 
                String[] args)

Print the Service's state into the given stream. This gets invoked if you run "adb shell dumpsys activity service <yourservicename>" (note that for this command to work, the service must be running, and you must specify a fully-qualified service name). This is distinct from "dumpsys <servicename>", which only works for named system services and which invokes the IBinder#dump method on the IBinder interface registered with ServiceManager.

Parameters
fd FileDescriptor: The raw file descriptor that the dump is being sent to.

pw PrintWriter: The PrintWriter to which you should dump your state. This will be closed for you after you return.

args String: additional arguments to the dump request.