VoiceInteractionSession

Kotlin |Java

open class VoiceInteractionSession : KeyEvent.Callback, ComponentCallbacks2

kotlin.Any
↳	android.service.voice.VoiceInteractionSession

An active voice interaction session, providing a facility for the implementation to interact with the user in the voice interaction layer. The user interface is initially shown by default, and can be created by overriding onCreateContentView() in which the UI can be built.

A voice interaction session can be self-contained, ultimately calling finish when done. It can also initiate voice interactions with applications by calling startVoiceActivity

Summary

Nested classes
	`AbortVoiceRequest` A request to report that the current user interaction can not be completed with voice, as per `VoiceInteractor.AbortVoiceRequest`.
open	`ActivityId` Represents the id of an assist source activity.
	`AssistState` Represents assist state captured when this session was started.
	`CommandRequest` A generic vendor-specific request, as per `VoiceInteractor.CommandRequest`.
	`CompleteVoiceRequest` A request to simply inform the user that the voice operation has completed, as per `VoiceInteractor.CompleteVoiceRequest`.
	`ConfirmationRequest` A request for confirmation from the user of an operation, as per `VoiceInteractor.ConfirmationRequest`.
	`Insets` Information about where interesting parts of the input method UI appear.
	`PickOptionRequest` A request for the user to pick from a set of option, as per `VoiceInteractor.PickOptionRequest`.
open	`Request` Base class representing a request from a voice-driver app to perform a particular voice operation with the user.
abstract	`VisibleActivityCallback` Callback interface for receiving visible activity changes used for assistant usage.

Constants
static String	`KEY_SHOW_SESSION_ID` Bundle key used to specify the id when the system prepares to show session.
static Int	`SHOW_SOURCE_ACTIVITY` Flag for use with `onShow`: indicates that an Activity has invoked the voice interaction service for a local interaction using `Activity#startLocalVoiceInteraction(Bundle)`.
static Int	`SHOW_SOURCE_APPLICATION` Flag for use with `onShow`: indicates that the application itself has invoked the assistant.
static Int	`SHOW_SOURCE_ASSIST_GESTURE` Flag for use with `onShow`: indicates that the session has been started from the system assist gesture.
static Int	`SHOW_SOURCE_AUTOMOTIVE_SYSTEM_UI` Flag for use with `onShow`: indicates that the voice interaction service was invoked from an Android automotive system UI.
static Int	`SHOW_SOURCE_NOTIFICATION` Flag for use with `onShow`: indicates that the voice interaction service was invoked from a notification.
static Int	`SHOW_SOURCE_PUSH_TO_TALK` Flag for use with `onShow`: indicates that the voice interaction service was invoked from a physical button.
static Int	`SHOW_WITH_ASSIST` Flag received in `onShow`: originator requested that the session be started with assist data from the currently focused activity.
static Int	`SHOW_WITH_SCREENSHOT` Flag received in `onShow`: originator requested that the session be started with a screen shot of the currently focused activity.

Inherited constants

From class ComponentCallbacks2

`Int`	`TRIM_MEMORY_BACKGROUND` Level for `onTrimMemory(int)`: the process has gone on to the LRU list. This is a good opportunity to clean up resources that can efficiently and quickly be re-built if the user returns to the app.
`Int`	`TRIM_MEMORY_COMPLETE` Level for `onTrimMemory(int)`: the process is nearing the end of the background LRU list, and if more memory isn't found soon it will be killed.
`Int`	`TRIM_MEMORY_MODERATE` Level for `onTrimMemory(int)`: the process is around the middle of the background LRU list; freeing memory can help the system keep other processes running later in the list for better overall performance.
`Int`	`TRIM_MEMORY_RUNNING_CRITICAL` Level for `onTrimMemory(int)`: the process is not an expendable background process, but the device is running extremely low on memory and is about to not be able to keep any background processes running. Your running process should free up as many non-critical resources as it can to allow that memory to be used elsewhere. The next thing that will happen after this is `onLowMemory()` called to report that nothing at all can be kept in the background, a situation that can start to notably impact the user.
`Int`	`TRIM_MEMORY_RUNNING_LOW` Level for `onTrimMemory(int)`: the process is not an expendable background process, but the device is running low on memory. Your running process should free up unneeded resources to allow that memory to be used elsewhere.
`Int`	`TRIM_MEMORY_RUNNING_MODERATE` Level for `onTrimMemory(int)`: the process is not an expendable background process, but the device is running moderately low on memory. Your running process may want to release some unneeded resources for use elsewhere.
`Int`	`TRIM_MEMORY_UI_HIDDEN` Level for `onTrimMemory(int)`: the process had been showing a user interface, and is no longer doing so. Large allocations with the UI should be released at this point to allow memory to be better managed.

Public constructors
`VoiceInteractionSession(context: Context!)`
`VoiceInteractionSession(context: Context!, handler: Handler!)`

Public methods
open Unit	`closeSystemDialogs()` Request that all system dialogs (and status bar shade etc) be closed, allowing access to the session's UI.
open Unit	`dump(prefix: String!, fd: FileDescriptor!, writer: PrintWriter!, args: Array<String!>!)` Print the Service's state into the given stream.
open Unit	`finish()` Finish the session.
open Context!	`getContext()`
open Int	`getDisabledShowContext()` Equivalent to `VoiceInteractionService.getDisabledShowContext`.
open LayoutInflater!	`getLayoutInflater()` Convenience for inflating views.
open Int	`getUserDisabledShowContext()` Return which show context flags have been disabled by the user through the system settings UI, so the session will never get this data.
open Dialog!	`getWindow()` Retrieve the window being used to show the session's UI.
open Unit	`hide()` Hide the session's UI, if currently shown.
open Unit	`onAssistStructureFailure(failure: Throwable!)` Called when there has been a failure transferring the `AssistStructure` to the assistant.
open Unit	`onBackPressed()` Called when the user presses the back button while focus is in the session UI.
open Unit	`onCancelRequest(request: VoiceInteractionSession.Request!)` Called when the `android.app.VoiceInteractor` has asked to cancel a `Request` that was previously delivered to `onRequestConfirmation`, `onRequestPickOption`, `onRequestCompleteVoice`, `onRequestAbortVoice`, or `onRequestCommand`.
open Unit	`onCloseSystemDialogs()` Sessions automatically watch for requests that all system UI be closed (such as when the user presses HOME), which will appear here.
open Unit	`onComputeInsets(outInsets: VoiceInteractionSession.Insets!)` Compute the interesting insets into your UI.
open Unit	`onConfigurationChanged(newConfig: Configuration)`
open Unit	`onCreate()` Initiatize a new session.
open View!	`onCreateContentView()` Hook in which to create the session's UI.
open Unit	`onDestroy()` Last callback to the session as it is being finished.
open Unit	`onDirectActionsInvalidated(activityId: VoiceInteractionSession.ActivityId)` Called when the direct actions are invalidated.
open BooleanArray!	`onGetSupportedCommands(commands: Array<String!>!)` Request to query for what extended commands the session supports.
open Unit	`onHandleAssist(data: Bundle?, structure: AssistStructure?, content: AssistContent?)` Called to receive data from the application that the user was currently viewing when - * an assist session is started.
open Unit	`onHandleAssist(state: VoiceInteractionSession.AssistState)` Called to receive data from the application that the user was currently viewing when an assist session is started.
open Unit	`onHandleAssistSecondary(data: Bundle?, structure: AssistStructure?, content: AssistContent?, index: Int, count: Int)` Called to receive data from other applications that the user was or is interacting with, that are currently on the screen in a multi-window display environment, not including the currently focused activity.
open Unit	`onHandleScreenshot(screenshot: Bitmap?)` Called to receive a screenshot of what the user was currently viewing when an assist session is started.
open Unit	`onHide()` Called immediately after stopping to show the session UI.
open Boolean	`onKeyDown(keyCode: Int, event: KeyEvent!)`
open Boolean	`onKeyLongPress(keyCode: Int, event: KeyEvent!)`
open Boolean	`onKeyMultiple(keyCode: Int, count: Int, event: KeyEvent!)`
open Boolean	`onKeyUp(keyCode: Int, event: KeyEvent!)`
open Unit	`onLockscreenShown()` Called when the lockscreen was shown.
open Unit	`onLowMemory()`
open Unit	`onPrepareShow(args: Bundle!, showFlags: Int)` Called prior to `onShow` before any UI setup has occurred.
open Unit	`onRequestAbortVoice(request: VoiceInteractionSession.AbortVoiceRequest!)` Request to abort the voice interaction session because the voice activity can not complete its interaction using voice.
open Unit	`onRequestCommand(request: VoiceInteractionSession.CommandRequest!)` Process an arbitrary extended command from the caller, corresponding to a `VoiceInteractor.CommandRequest`.
open Unit	`onRequestCompleteVoice(request: VoiceInteractionSession.CompleteVoiceRequest!)` Request to complete the voice interaction session because the voice activity successfully completed its interaction using voice.
open Unit	`onRequestConfirmation(request: VoiceInteractionSession.ConfirmationRequest!)` Request to confirm with the user before proceeding with an unrecoverable operation, corresponding to a `VoiceInteractor.ConfirmationRequest`.
open Unit	`onRequestPickOption(request: VoiceInteractionSession.PickOptionRequest!)` Request for the user to pick one of N options, corresponding to a `VoiceInteractor.PickOptionRequest`.
open Unit	`onShow(args: Bundle?, showFlags: Int)` Called when the session UI is going to be shown.
open Unit	`onTaskFinished(intent: Intent!, taskId: Int)` Called when the last activity of a task initiated by `startVoiceActivity(android.content.Intent)` has finished.
open Unit	`onTaskStarted(intent: Intent!, taskId: Int)` Called when a task initiated by `startVoiceActivity(android.content.Intent)` has actually started.
open Unit	`onTrimMemory(level: Int)`
Unit	`performDirectAction(action: DirectAction, extras: Bundle?, cancellationSignal: CancellationSignal?, resultExecutor: Executor, resultListener: Consumer<Bundle!>)` Asks that an action be performed by the app.
Unit	`registerVisibleActivityCallback(executor: Executor, callback: VoiceInteractionSession.VisibleActivityCallback)` Registers a callback that will be notified when visible activities have been changed.
Unit	`requestDirectActions(activityId: VoiceInteractionSession.ActivityId, cancellationSignal: CancellationSignal?, resultExecutor: Executor, callback: Consumer<MutableList<DirectAction!>!>)` Requests a list of supported actions from an app.
open Unit	`setContentView(view: View!)`
open Unit	`setDisabledShowContext(flags: Int)` Equivalent to `VoiceInteractionService.setDisabledShowContext(int)`.
open Unit	`setKeepAwake(keepAwake: Boolean)` Set whether this session will keep the device awake while it is running a voice activity.
open Unit	`setTheme(theme: Int)` You can call this to customize the theme used by your IME's window.
open Unit	`setUiEnabled(enabled: Boolean)` Control whether the UI layer for this session is enabled.
open Unit	`show(args: Bundle!, flags: Int)` Show the UI for this session.
open Unit	`startAssistantActivity(intent: Intent!)` Ask that a new assistant activity be started.
open Unit	`startAssistantActivity(intent: Intent, bundle: Bundle)` Ask that a new assistant activity be started.
open Unit	`startVoiceActivity(intent: Intent!)` Ask that a new activity be started for voice interaction.
Unit	`unregisterVisibleActivityCallback(callback: VoiceInteractionSession.VisibleActivityCallback)` Unregisters the callback.

Inherited functions

From class ComponentCallbacks

Unit

onConfigurationChanged(newConfig: Configuration)

Called by the system when the device configuration changes while your component is running. Note that, unlike activities, other components are never restarted when a configuration changes: they must always deal with the results of the change, such as by re-retrieving resources.

At the time that this function has been called, your Resources object will have been updated to return resource values matching the new configuration.

For more information, read Handling Runtime Changes.

Unit

onLowMemory()

This is called when the overall system is running low on memory, and actively running processes should trim their memory usage. While the exact point at which this will be called is not defined, generally it will happen when all background process have been killed. That is, before reaching the point of killing processes hosting service and foreground UI that we would like to avoid killing.

You should implement this method to release any caches or other unnecessary resources you may be holding on to. The system will perform a garbage collection for you after returning from this method.

Preferably, you should implement ComponentCallbacks2#onTrimMemory from ComponentCallbacks2 to incrementally unload your resources based on various levels of memory demands. That API is available for API level 14 and higher, so you should only use this onLowMemory method as a fallback for older versions, which can be treated the same as ComponentCallbacks2#onTrimMemory with the android.content.ComponentCallbacks2#TRIM_MEMORY_COMPLETE level.

Constants

KEY_SHOW_SESSION_ID

Added in API level 34

static val KEY_SHOW_SESSION_ID: String

Bundle key used to specify the id when the system prepares to show session. It increases for each request.

Type: int

Value: "android.service.voice.SHOW_SESSION_ID"

See Also

SHOW_SOURCE_ACTIVITY

Added in API level 24

static val SHOW_SOURCE_ACTIVITY: Int

Flag for use with onShow: indicates that an Activity has invoked the voice interaction service for a local interaction using Activity#startLocalVoiceInteraction(Bundle).

Value: 16

Parameters
`prefix`	String!: Text to print at the front of each line.
`fd`	FileDescriptor!: The raw file descriptor that the dump is being sent to.
`writer`	PrintWriter!: The PrintWriter to which you should dump your state. This will be closed for you after you return.
`args`	Array<String!>!: additional arguments to the dump request.

Parameters
`data`	Bundle?: Arbitrary data supplied by the app through `Activity.onProvideAssistData`. May be null if assist data has been disabled by the user or device policy.
`structure`	AssistStructure?: If available, the structure definition of all windows currently displayed by the app. May be null if assist data has been disabled by the user or device policy; will be an empty stub if the application has disabled assist by marking its window as secure.
`content`	AssistContent?: Additional content data supplied by the app through `Activity.onProvideAssistContent`. May be null if assist data has been disabled by the user or device policy; will not be automatically filled in with data from the app if the app has marked its window as secure.

Parameters
`keyCode`	Int: The value in event.getKeyCode().
`event`	KeyEvent!: Description of the key event.

Parameters
`keyCode`	Int: The value in event.getKeyCode().
`count`	Int: Number of pairs as returned by event.getRepeatCount().
`event`	KeyEvent!: Description of the key event.

Parameters
`args`	Bundle!: The arguments that were supplied to `VoiceInteractionService.showSession`.
`showFlags`	Int: The show flags originally provided to `VoiceInteractionService.showSession`.

Parameters
`intent`	Intent!: The original `Intent` supplied to `startVoiceActivity(android.content.Intent)`.
`taskId`	Int: Unique ID of the finished task.

Parameters
`action`	DirectAction: The action to be performed. This value cannot be `null`.
`extras`	Bundle?: Any optional extras sent to the app as part of the request This value may be `null`.
`cancellationSignal`	CancellationSignal?: A signal to cancel the operation in progress, or `null` if none.
`resultExecutor`	Executor: The handler to receive the callback. This value cannot be `null`. Callback and listener events are dispatched through this `Executor`, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use `Context.getMainExecutor()`. Otherwise, provide an `Executor` that dispatches to an appropriate thread.
`resultListener`	Consumer<Bundle!>: The callback to receive the response. This value cannot be `null`.

Parameters
`executor`	Executor: The executor which will be used to invoke the callback. This value cannot be `null`. Callback and listener events are dispatched through this `Executor`, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use `Context.getMainExecutor()`. Otherwise, provide an `Executor` that dispatches to an appropriate thread.
`callback`	VoiceInteractionSession.VisibleActivityCallback: The callback to receive the response. This value cannot be `null`.

Parameters
`activityId`	VoiceInteractionSession.ActivityId: Ths activity id of the app to get the actions from. This value cannot be `null`.
`cancellationSignal`	CancellationSignal?: A signal to cancel the operation in progress, or `null` if none.
`resultExecutor`	Executor: The handler to receive the callback. This value cannot be `null`. Callback and listener events are dispatched through this `Executor`, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use `Context.getMainExecutor()`. Otherwise, provide an `Executor` that dispatches to an appropriate thread.
`callback`	Consumer<MutableList<DirectAction!>!>: The callback to receive the response. This value cannot be `null`.

Parameters
`args`	Bundle!: Arbitrary arguments that will be propagated `onShow`.
`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.

Parameters
`intent`	Intent: the intent used to start an assistant activity This value cannot be `null`.
`bundle`	Bundle: Additional options for how the Activity should be started. See `ActivityOptions` for how to build the Bundle supplied here. This value cannot be `null`.

VoiceInteractionSession

Summary

Constants

KEY_SHOW_SESSION_ID

SHOW_SOURCE_ACTIVITY

SHOW_SOURCE_APPLICATION

SHOW_SOURCE_ASSIST_GESTURE

SHOW_SOURCE_AUTOMOTIVE_SYSTEM_UI

SHOW_SOURCE_NOTIFICATION

SHOW_SOURCE_PUSH_TO_TALK

SHOW_WITH_ASSIST

SHOW_WITH_SCREENSHOT

Public constructors

VoiceInteractionSession

VoiceInteractionSession

Public methods

closeSystemDialogs

dump

finish

getContext

getDisabledShowContext

getLayoutInflater

getUserDisabledShowContext

getWindow

hide

onAssistStructureFailure

onBackPressed

onCancelRequest

onCloseSystemDialogs

onComputeInsets

onConfigurationChanged

onCreate

onCreateContentView

onDestroy

onDirectActionsInvalidated

onGetSupportedCommands

onHandleAssist

onHandleAssist

onHandleAssistSecondary

onHandleScreenshot

onHide

onKeyDown

onKeyLongPress

onKeyMultiple

onKeyUp

onLockscreenShown

onLowMemory

onPrepareShow

onRequestAbortVoice

onRequestCommand

onRequestCompleteVoice

onRequestConfirmation

onRequestPickOption

onShow

onTaskFinished

onTaskStarted

onTrimMemory

performDirectAction

registerVisibleActivityCallback

requestDirectActions

setContentView

setDisabledShowContext

setKeepAwake

setTheme

setUiEnabled

show

startAssistantActivity

startAssistantActivity

startVoiceActivity

unregisterVisibleActivityCallback