鸿蒙5.0开发进阶：ArkTS API-@ohos.accessibility (辅助功能)

往期鸿蒙全套实战文章必看：（文中附带全栈鸿蒙学习资料）

• 鸿蒙开发核心知识点，看这篇文章就够了

• 最新版！鸿蒙HarmonyOS Next应用开发实战学习路线

• 鸿蒙HarmonyOS NEXT开发技术最全学习路线指南

• 鸿蒙应用开发实战项目，看这一篇文章就够了（部分项目附源码）

---

@ohos.accessibility (辅助功能)

本模块提供辅助功能查询能力，包括获取辅助应用列表、辅助应用启用状态、无障碍字幕配置等。

说明

本模块首批接口从 API version 7 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import { accessibility } from '@kit.AccessibilityKit';

AbilityState

type AbilityState = 'enable' | 'disable' | 'install'

辅助应用状态类型。

系统能力：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core

类型	说明
'enable'	表示辅助应用已启用。
'disable'	表示辅助应用已禁用。
'install'	表示辅助应用已安装。

AbilityType

无障碍辅助应用类型。

系统能力：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core

名称	描述
audible	表示具有听觉反馈。
generic	表示具有通用反馈。
haptic	表示具有触觉反馈。
spoken	表示具有语音反馈。
visual	表示具有视觉反馈。
all9+	表示以上所有类别。

AccessibilityAbilityInfo

辅助应用信息。

系统能力：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core

属性

名称	类型	可读	可写	说明
id	string	是	否	ability id。
name	string	是	否	ability 名。
bundleName	string	是	否	Bundle名称。
targetBundleNames9+	Array<string>	是	否	关注的目标Bundle名称。
abilityTypes	Array<AbilityType>	是	否	辅助应用类型。
capabilities	Array<Capability>	是	否	辅助应用能力列表。
description	string	是	否	辅助应用描述。
eventTypes	Array<EventType>	是	否	辅助应用关注的无障碍事件列表。
needHide12+	boolean	是	否	辅助应用是否在已安装的扩展服务列表中被隐藏，true表示隐藏服务，false表示显示服务。
label12+	string	是	否	扩展应用在扩展服务列表中的名称。

Action

type Action = 'accessibilityFocus' | 'clearAccessibilityFocus' | 'focus' | 'clearFocus' | 'clearSelection' |'click' | 'longClick' | 'cut' | 'copy' | 'paste' | 'select' | 'setText' | 'delete' |'scrollForward' | 'scrollBackward' | 'setSelection' | 'setCursorPosition' | 'home' |

'back' | 'recentTask' | 'notificationCenter' | 'controlCenter' | 'common'

应用所支持的目标动作，需要配置参数的目标动作已在描述中标明。

系统能力：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core

类型	说明
'click'	表示点击操作。
'longClick'	表示长按操作。
'scrollForward'	表示向前滚动操作。
'scrollBackward'	表示向后滚动操作。
'focus'	表示获得焦点操作。
'clearFocus'	表示清除焦点操作。
'clearSelection'	表示清除选择操作。当前版本暂不支持。
'accessibilityFocus'	表示获得无障碍焦点操作。
'clearAccessibilityFocus'	表示清除无障碍焦点操作。
'cut'	表示剪切操作。
'copy'	表示复制操作。
'paste'	表示粘贴操作。
'select'	表示选择操作。
'setText'	表示设置文本操作，需配置参数setText。
'delete'	表示删除操作。当前版本暂不支持。
'setSelection'	'表示选择操作，需配置参数selectTextBegin、selectTextEnd、selectTextInForWard。'
'common'	表示没有特定操作，用于主动聚焦、主动播报等场景。
'home'	表示返回桌面操作。
'back'	表示返回上一级操作。
'recentTask'	表示打开最近任务操作。
'notificationCenter'	表示打开通知栏操作。
'controlCenter'	表示打开控制中心操作。
'setCursorPosition'	表示设置光标位置操作，需配置参数offset。

Capability

type Capability = 'retrieve' | 'touchGuide' | 'keyEventObserver' | 'zoom' | 'gesture'

辅助应用能力类型。

系统能力：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core

类型	说明
'retrieve'	表示具有检索窗口内容的能力。
'touchGuide'	表示具有触摸探索模式的能力。
'keyEventObserver'	表示具有过滤按键事件的能力。
'zoom'	表示具有控制显示放大的能力。当前版本暂不支持。
'gesture'	表示具有执行手势动作的能力。

CaptionsFontEdgeType8+

type CaptionsFontEdgeType = 'none' | 'raised' | 'depressed' | 'uniform' | 'dropShadow'

字幕字体边缘类型。

系统能力：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Hearing

类型	说明
'none'	表示无效果。
'raised'	表示凸起效果。
'depressed'	表示凹陷效果。
'uniform'	表示轮廓效果。
'dropShadow'	表示阴影效果。

CaptionsFontFamily8+

type CaptionsFontFamily = 'default' | 'monospacedSerif' | 'serif' | 'monospacedSansSerif' | 'sansSerif' | 'casual' | 'cursive' | 'smallCapitals'

字幕字体。

系统能力：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Hearing

类型	说明
'default'	表示默认字体。
'monospacedSerif'	表示等宽 Serif 字体。
'serif'	表示Serif 字体。
'monospacedSansSerif'	表示等宽 Sans Serif 字体。
'sansSerif'	表示Sans Serif 字体。
'casual'	表示非正式字体。
'cursive'	表示手写字体。
'smallCapitals'	表示小型大写字母字体。

CaptionsStyle8+

字幕风格。

系统能力：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Hearing

名称	类型	可读	可写	说明
fontFamily	CaptionsFontFamily	是	否	描述字幕字体。
fontScale	number	是	否	描述字幕字体缩放系数，单位%，参数范围1~200。
fontColor	number | string	是	否	描述字幕字体颜色，例如red对应#FF0000。
fontEdgeType	CaptionsFontEdgeType	是	否	描述字幕字体边缘。
backgroundColor	number | string	是	否	描述字幕背景颜色，例如red对应#FF0000。
windowColor	number | string	是	否	描述字幕窗口颜色，例如red对应#FF0000。

CaptionsManager8+

字幕配置管理，在调用CaptionsManager的方法前，需要先通过 accessibility.getCaptionsManager() 获取 CaptionsManager实例。

系统能力：以下各项对应的系统能力均为SystemCapability.BarrierFree.Accessibility.Hearing

属性

名称	类型	可读	可写	说明
enabled	boolean	是	否	表示是否启用字幕配置。 True表示开启，False表示关闭。
style