AccessibilityManager

See also:

• AccessibilityEvent
• AccessibilityNodeInfo
• AccessibilityService
• Context.getSystemService(Class)
• Context.ACCESSIBILITY_SERVICE

FLAG_CONTENT_CONTROLS

public static final int FLAG_CONTENT_CONTROLS

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

Constant Value: 4 (0x00000004)

FLAG_CONTENT_ICONS

public static final int FLAG_CONTENT_ICONS

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

Constant Value: 1 (0x00000001)

FLAG_CONTENT_TEXT

public static final int FLAG_CONTENT_TEXT

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

Constant Value: 2 (0x00000002)

addAccessibilityRequestPreparer

public void addAccessibilityRequestPreparer (AccessibilityRequestPreparer preparer)

Registers a AccessibilityRequestPreparer.

addAccessibilityServicesStateChangeListener

public void addAccessibilityServicesStateChangeListener (Executor executor, 
                AccessibilityManager.AccessibilityServicesStateChangeListener listener)

Registers a AccessibilityServicesStateChangeListener.

addAccessibilityServicesStateChangeListener

public void addAccessibilityServicesStateChangeListener (AccessibilityManager.AccessibilityServicesStateChangeListener listener)

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

addAccessibilityStateChangeListener

public boolean addAccessibilityStateChangeListener (AccessibilityManager.AccessibilityStateChangeListener listener)

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

public void addAccessibilityStateChangeListener (AccessibilityManager.AccessibilityStateChangeListener listener, 
                Handler handler)

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

public void addAudioDescriptionRequestedChangeListener (Executor executor, 
                AccessibilityManager.AudioDescriptionRequestedChangeListener listener)

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

addHighContrastTextStateChangeListener

public void addHighContrastTextStateChangeListener (Executor executor, 
                AccessibilityManager.HighContrastTextStateChangeListener listener)

Registers a HighContrastTextStateChangeListener for changes in the global high contrast text state of the system.

addTouchExplorationStateChangeListener

public boolean addTouchExplorationStateChangeListener (AccessibilityManager.TouchExplorationStateChangeListener listener)

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

public void addTouchExplorationStateChangeListener (AccessibilityManager.TouchExplorationStateChangeListener listener, 
                Handler handler)

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

public int getAccessibilityFocusColor ()

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

getAccessibilityFocusStrokeWidth

public int getAccessibilityFocusStrokeWidth ()

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

getAccessibilityServiceList

public List<ServiceInfo> getAccessibilityServiceList ()

This method was deprecated in API level 15.
Use getInstalledAccessibilityServiceList()

Returns the ServiceInfos of the installed accessibility services.

getEnabledAccessibilityServiceList

public List<AccessibilityServiceInfo> getEnabledAccessibilityServiceList (int feedbackTypeFlags)

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

getInstalledAccessibilityServiceList

public List<AccessibilityServiceInfo> getInstalledAccessibilityServiceList ()

Returns the AccessibilityServiceInfos of the installed accessibility services.

getRecommendedTimeoutMillis

public int getRecommendedTimeoutMillis (int originalTimeout, 
                int uiContentFlags)

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

public void interrupt ()

Requests feedback interruption from all accessibility services.

isAccessibilityButtonSupported

public static boolean isAccessibilityButtonSupported ()

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

isAudioDescriptionRequested

public boolean isAudioDescriptionRequested ()

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(Executor, AudioDescriptionRequestedChangeListener)

isEnabled

public boolean isEnabled ()

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.

isHighContrastTextEnabled

public boolean isHighContrastTextEnabled ()

Returns if high contrast text in the system is enabled.

Note: You need to query this only if you application is doing its own rendering and does not rely on the platform rendering pipeline.

isRequestFromAccessibilityTool

public boolean isRequestFromAccessibilityTool ()

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

public boolean isTouchExplorationEnabled ()

Returns if the touch exploration in the system is enabled.

Note: This query is used for dispatching hover events, such as 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

public void removeAccessibilityRequestPreparer (AccessibilityRequestPreparer preparer)

Unregisters a AccessibilityRequestPreparer.

removeAccessibilityServicesStateChangeListener

public boolean removeAccessibilityServicesStateChangeListener (AccessibilityManager.AccessibilityServicesStateChangeListener listener)

Unregisters a AccessibilityServicesStateChangeListener.

removeAccessibilityStateChangeListener

public boolean removeAccessibilityStateChangeListener (AccessibilityManager.AccessibilityStateChangeListener listener)

Unregisters an AccessibilityStateChangeListener.

removeAudioDescriptionRequestedChangeListener

public boolean removeAudioDescriptionRequestedChangeListener (AccessibilityManager.AudioDescriptionRequestedChangeListener listener)

Unregisters a AudioDescriptionRequestedChangeListener.

removeHighContrastTextStateChangeListener

public void removeHighContrastTextStateChangeListener (AccessibilityManager.HighContrastTextStateChangeListener listener)

Unregisters a HighContrastTextStateChangeListener.

removeTouchExplorationStateChangeListener

public boolean removeTouchExplorationStateChangeListener (AccessibilityManager.TouchExplorationStateChangeListener listener)

Unregisters a TouchExplorationStateChangeListener.

sendAccessibilityEvent

public void sendAccessibilityEvent (AccessibilityEvent event)

Sends an AccessibilityEvent.