AccessibilityManager

FLAG_CONTENT_CONTROLS

static val FLAG_CONTENT_CONTROLS: Int

Use this flag to indicate the content of a UI that times out contains interactive controls.

Value: 4

FLAG_CONTENT_ICONS

static val FLAG_CONTENT_ICONS: Int

Use this flag to indicate the content of a UI that times out contains icons.

Value: 1

FLAG_CONTENT_TEXT

static val FLAG_CONTENT_TEXT: Int

Use this flag to indicate the content of a UI that times out contains text.

Value: 2

addAccessibilityRequestPreparer

fun addAccessibilityRequestPreparer(preparer: AccessibilityRequestPreparer!): Unit

Registers a AccessibilityRequestPreparer.

addAccessibilityServicesStateChangeListener

fun addAccessibilityServicesStateChangeListener(listener: AccessibilityManager.AccessibilityServicesStateChangeListener): Unit

Registers a AccessibilityServicesStateChangeListener. This will execute a callback on the process's main handler.

addAccessibilityServicesStateChangeListener

fun addAccessibilityServicesStateChangeListener(
    executor: Executor, 
    listener: AccessibilityManager.AccessibilityServicesStateChangeListener
): Unit

Registers a AccessibilityServicesStateChangeListener.

addAccessibilityStateChangeListener

fun addAccessibilityStateChangeListener(listener: AccessibilityManager.AccessibilityStateChangeListener): Boolean

Registers an AccessibilityStateChangeListener for changes in the global accessibility state of the system. Equivalent to calling addAccessibilityStateChangeListener(android.view.accessibility.AccessibilityManager.AccessibilityStateChangeListener,android.os.Handler) with a null handler.

addAccessibilityStateChangeListener

fun addAccessibilityStateChangeListener(
    listener: AccessibilityManager.AccessibilityStateChangeListener, 
    handler: Handler?
): Unit

Registers an AccessibilityStateChangeListener for changes in the global accessibility state of the system. If the listener has already been registered, the handler used to call it back is updated.

addAudioDescriptionRequestedChangeListener

fun addAudioDescriptionRequestedChangeListener(
    executor: Executor, 
    listener: AccessibilityManager.AudioDescriptionRequestedChangeListener
): Unit

Registers a AudioDescriptionRequestedChangeListener for changes in the audio description by default state of the system. The value could be read via isAudioDescriptionRequested.

addTouchExplorationStateChangeListener

fun addTouchExplorationStateChangeListener(listener: AccessibilityManager.TouchExplorationStateChangeListener): Boolean

Registers a TouchExplorationStateChangeListener for changes in the global touch exploration state of the system. Equivalent to calling addTouchExplorationStateChangeListener(android.view.accessibility.AccessibilityManager.TouchExplorationStateChangeListener,android.os.Handler) with a null handler.

addTouchExplorationStateChangeListener

fun addTouchExplorationStateChangeListener(
    listener: AccessibilityManager.TouchExplorationStateChangeListener, 
    handler: Handler?
): Unit

Registers an TouchExplorationStateChangeListener for changes in the global touch exploration state of the system. If the listener has already been registered, the handler used to call it back is updated.

getAccessibilityFocusColor

fun getAccessibilityFocusColor(): Int

Gets the color of the focus rectangle. This value can be set by AccessibilityService.

getAccessibilityFocusStrokeWidth

fun getAccessibilityFocusStrokeWidth(): Int

Gets the strokeWidth of the focus rectangle. This value can be set by AccessibilityService.

getAccessibilityServiceList

fun getAccessibilityServiceList(): MutableList<ServiceInfo!>!

Deprecated: Use getInstalledAccessibilityServiceList()

Returns the ServiceInfos of the installed accessibility services.

getEnabledAccessibilityServiceList

fun getEnabledAccessibilityServiceList(feedbackTypeFlags: Int): MutableList<AccessibilityServiceInfo!>!

Returns the AccessibilityServiceInfos of the enabled accessibility services for a given feedback type.

getInstalledAccessibilityServiceList

fun getInstalledAccessibilityServiceList(): MutableList<AccessibilityServiceInfo!>!

Returns the AccessibilityServiceInfos of the installed accessibility services.

getRecommendedTimeoutMillis

fun getRecommendedTimeoutMillis(
    originalTimeout: Int, 
    uiContentFlags: Int
): Int

Get the recommended timeout for changes to the UI needed by this user. Controls should remain on the screen for at least this long to give users time to react. Some users may need extra time to review the controls, or to reach them, or to activate assistive technology to activate the controls automatically.

Use the combination of content flags to indicate contents of UI. For example, use FLAG_CONTENT_ICONS | FLAG_CONTENT_TEXT for message notification which contains icons and text, or use FLAG_CONTENT_TEXT | FLAG_CONTENT_CONTROLS for button dialog which contains text and button controls.

interrupt

fun interrupt(): Unit

Requests feedback interruption from all accessibility services.

isAccessibilityButtonSupported

static fun isAccessibilityButtonSupported(): Boolean

Determines if the accessibility button within the system navigation area is supported.

isAudioDescriptionRequested

fun isAudioDescriptionRequested(): Boolean

Determines if users want to select sound track with audio description by default.

Audio description, also referred to as a video description, described video, or more precisely called a visual description, is a form of narration used to provide information surrounding key visual elements in a media work for the benefit of blind and visually impaired consumers.

The method provides the preference value to content provider apps to select the default sound track during playing a video or movie.

Add listener to detect the state change via addAudioDescriptionRequestedChangeListener

isEnabled

fun isEnabled(): Boolean

Returns if the accessibility in the system is enabled.

Note: This query is used for sending AccessibilityEvents, since events are only needed if accessibility is on. Avoid changing UI or app behavior based on the state of accessibility. While well-intentioned, doing this creates brittle, less well-maintained code that works for some users but not others. Shared code leads to more equitable experiences and less technical debt.

For example, if you want to expose a unique interaction with your app, use ViewCompat#addAccessibilityAction in AndroidX to make this interaction - ideally with the same code path used for non-accessibility users - available to accessibility services. Services can then expose this action in the way best fit for their users.

isRequestFromAccessibilityTool

fun isRequestFromAccessibilityTool(): Boolean

Whether the current accessibility request comes from an AccessibilityService with the AccessibilityServiceInfo.isAccessibilityTool property set to true.

You can use this method inside AccessibilityNodeProvider to decide how to populate your nodes.

Note: The return value is valid only when an AccessibilityNodeInfo request is in progress, can change from one request to another, and has no meaning when a request is not in progress.

isTouchExplorationEnabled

fun isTouchExplorationEnabled(): Boolean

Returns if the touch exploration in the system is enabled.

Note: This query is used for dispatching hover events, such as android.view.MotionEvent#ACTION_HOVER_ENTER, to accessibility services to manage touch exploration. Avoid changing UI or app behavior based on the state of accessibility. While well-intentioned, doing this creates brittle, less well-maintained code that works for som users but not others. Shared code leads to more equitable experiences and less technical debt.

removeAccessibilityRequestPreparer

fun removeAccessibilityRequestPreparer(preparer: AccessibilityRequestPreparer!): Unit

Unregisters a AccessibilityRequestPreparer.

removeAccessibilityServicesStateChangeListener

fun removeAccessibilityServicesStateChangeListener(listener: AccessibilityManager.AccessibilityServicesStateChangeListener): Boolean

Unregisters a AccessibilityServicesStateChangeListener.

removeAccessibilityStateChangeListener

fun removeAccessibilityStateChangeListener(listener: AccessibilityManager.AccessibilityStateChangeListener): Boolean

Unregisters an AccessibilityStateChangeListener.

removeAudioDescriptionRequestedChangeListener

fun removeAudioDescriptionRequestedChangeListener(listener: AccessibilityManager.AudioDescriptionRequestedChangeListener): Boolean

Unregisters a AudioDescriptionRequestedChangeListener.

removeTouchExplorationStateChangeListener

fun removeTouchExplorationStateChangeListener(listener: AccessibilityManager.TouchExplorationStateChangeListener): Boolean

Unregisters a TouchExplorationStateChangeListener.

sendAccessibilityEvent

fun sendAccessibilityEvent(event: AccessibilityEvent!): Unit

Sends an AccessibilityEvent.