鸿蒙开发系统基础能力:【@ohos.accessibility (辅助功能)】

辅助功能

icon-note.gif 说明:  本模块首批接口从 API version 7 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

导入模块

import accessibility from '@ohos.accessibility';

AbilityState

辅助应用状态类型。

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

名称描述
enable辅助应用已启用。
disable辅助应用已禁用。
install辅助应用已安装。

AbilityType

无障碍辅助应用类型。

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

名称描述
audible表示具有听觉反馈。
generic表示具有通用反馈。
haptic表示具有触觉反馈。
spoken表示具有语音反馈。
visual表示具有视觉反馈。

AccessibilityAbilityInfo

辅助应用信息。

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

属性

名称参数类型可读可写说明
idnumberability id。
namestringability 名。
bundleNamestring包名。
abilityTypesArray<[AbilityType]>辅助应用类型。
capabilitiesArray<[Capability]>辅助应用能力列表。
descriptionstring辅助应用描述。
eventTypesArray<[EventType]>辅助应用关注的无障碍事件列表。

Action

应用所支持的目标动作。

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

名称描述
click表示点击操作。
longClick表示长按操作。
scrollForward表示向前滚动操作。
scrollBackward表示向后滚动操作。
focus表示获得焦点操作。
clearFocus表示清除焦点操作。
clearSelection表示清除选择操作。
accessibilityFocus表示获得无障碍焦点操作。
clearAccessibilityFocus表示清除无障碍焦点操作。
cut表示剪切操作。
copy表示复制操作。
paste表示粘贴操作。
select表示选择操作。
setText表示设置文本操作。
delete表示删除操作。
setSelection表示选择操作。

Capability

辅助应用能力类型。

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

名称描述
retrieve具有检索窗口内容的能力。
touchGuide具有触摸探索模式的能力。
keyEventObserver具有过滤按键事件的能力。
zoom具有控制显示放大的能力。
gesture具有执行手势动作的能力。

aptionsFontEdgeType8+

字幕字体边缘类型。

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

名称描述
none无效果。
raised凸起效果。
depressed凹陷效果。
uniform轮廓效果。
dropShadow阴影效果。

CaptionsFontFamily8+

字幕字体。

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

名称描述
default默认字体。
monospacedSerif等宽 Serif 字体。
serifSerif 字体。
monospacedSansSerif等宽 Sans Serif 字体。
sansSerifSans Serif 字体。
casual非正式字体。
cursive手写字体。
smallCapitals小型大写字母字体。

CaptionsStyle8+

字幕风格。

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

名称参数类型可读可写说明
fontFamily[CaptionsFontFamily]描述字幕字体。
fontScalenumber描述字幕字体缩放系数。
fontColornumberstring
fontEdgeType[CaptionsFontEdgeType]描述字幕字体边缘。
backgroundColornumberstring
windowColornumberstring

CaptionsManager8+

字幕配置。

属性

名称参数类型可读可写说明
enabledboolean表示是否启用字幕配置。
style[CaptionsStyle]表示字幕风格。

方法

下列 API 示例中都需要使用 [accessibility.getCaptionsManager()]获取 captionsManager 实例,再通过此实例调用对应的方法。

on(‘enableChange’)

on(type: ‘enableChange’, callback: Callback): void;

注册字幕配置启用的监听函数。

系统能力:SystemCapability.Barrierfree.Accessibility.Hearing

  • 参数:

    参数名参数类型必填说明
    typestring监听字幕配置启用状态。
    callbackCallback回调函数,在启用状态变化时将状态通过此函数进行通知。
  • 示例

    captionsManager.on('enableChange',(data) => {console.info('success data:subscribeStateObserver : ' + JSON.stringify(data))
    })
    
on(‘styleChange’)

on(type: ‘styleChange’, callback: Callback): void;

注册字幕风格变化的监听函数。

系统能力:SystemCapability.Barrierfree.Accessibility.Hearing

  • 参数:

    参数名参数类型必填说明
    typestring监听字幕风格变化。
    callbackCallback<[CaptionsStyle]>回调函数,在字幕风格变化时通过此函数进行通知。
  • 示例

    captionsManager.on('styleChange',(data) => {console.info('success data:subscribeStateObserver : ' + JSON.stringify(data))
    })
    
off(‘enableChange’)

off(type: ‘enableChange’, callback?: Callback): void;

移除字幕配置启用的监听函数。

系统能力:SystemCapability.Barrierfree.Accessibility.Hearing

  • 参数:

    参数名参数类型必填说明
    typestring监听字幕配置启用状态。
    callbackCallback回调函数,在启用状态变化时将状态通过此函数进行通知。
  • 示例

    captionsManager.off('enableChange')
    
off(‘styleChange’)

off(type: ‘styleChange’, callback?: Callback): void;

移除字幕风格变化的监听函数。

系统能力:SystemCapability.Barrierfree.Accessibility.Hearing

  • 参数:

    参数名参数类型必填说明
    typestring字幕风格变化。
    callbackCallback<[CaptionsStyle]>回调函数,在字幕风格变化时通过此函数进行通知。
  • 示例

    captionsManager.off('styleChange')
    

EventInfo

界面变更事件。

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

属性

名称参数类型可读可写说明
type[EventType]无障碍事件类型。
windowUpdateType[WindowUpdateType]窗口变化类型。
bundleNamestring目标应用名。
componentTypestring事件源组件类型,如按钮、图表。
pageIdnumber事件源的页面 ID。
descriptionstring事件描述。
triggerAction[Action]触发事件的 Action。
textMoveUnit[TextMoveUnit]文本移动粒度。
contentsArray内容列表。
lastContentstring最新内容。
beginIndexnumber画面显示条目的开始序号。
currentIndexnumber当前条目序号。
endIndexnumber画面显示条目的结束序号。
itemCountnumber条目总数。

方法

constructor

constructor(jsonObject)

构造函数。

  • 参数:

    参数名参数类型必填说明
    jsonObjectstring创建对象所需要的 JSON 格式字符串。
  • 示例

    let eventInfo = new accessibility.EventInfo({"type":"click","bundleName":"com.example.MyApplication","triggerAction":"click"})
    

EventType

无障碍事件类型。

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

名称描述
click描述点击组件的事件。
longClick描述长按组件的事件。
select描述选择组件的事件。
focus描述组件获得焦点的事件。
textUpdate描述组件文本已更改的事件。
hoverEnter描述悬停进入组件的事件。
hoverExit描述悬停离开组件的事件。
scroll描述滚动视图的事件。
textSelectionUpdate描述选定文本已更改的事件。
accessibilityFocus描述获得无障碍焦点的事件。
accessibilityFocusClear描述清除无障碍焦点的事件。

TextMoveUnit

文本无障碍导航移动粒度。

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

名称描述
char以字符为移动粒度遍历节点文本。
word以词为移动粒度遍历节点文本。
line以行为移动粒度遍历节点文本。
page以页为移动粒度遍历节点文本。
paragraph以段落为移动粒度遍历节点文本。

WindowUpdateType

窗口变化类型。

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

名称描述
add添加窗口的窗口变化事件。
remove一个窗口被删除的窗口变化事件。
bounds窗口边界已更改的窗口变化事件。
active窗口变为活动或不活动的窗口变化事件。
focus窗口焦点发生变化的窗口变化事件。

accessibility.getAbilityLists

getAbilityLists(abilityType: AbilityType, stateType: AbilityState): Promise<Array>

查询辅助应用列表。

系统能力:SystemCapability.Barrierfree.Accessibility.Core

  • 参数:

    参数名参数类型必填说明
    abilityType[AbilityType]辅助应用的类型。
    stateType[AbilityState]辅助应用的状态。
  • 返回值:

    类型说明
    Promise<Array<[AccessibilityAbilityInfo]>>返回辅助应用信息列表。
  • 示例

    accessibility.getAbilityLists("spoken", "enable").then((data) => {console.info('success data:getAbilityList1 : ' + JSON.stringify(data));for (let item of data) {console.info(item.id);console.info(item.name);console.info(item.description);console.info(item.abilityTypes);console.info(item.eventTypes);console.info(item.capabilities);console.info(item.packageName);console.info(item.filterBundleNames);console.info(item.bundleName);}}).catch((error) => {console.error('failed to  getAbilityList1 because ' + JSON.stringify(error));})
    

accessibility.getAbilityLists

getAbilityLists(abilityType: AbilityType, stateType: AbilityState,callback: AsyncCallback<Array>): void

查询辅助应用列表。

系统能力:SystemCapability.Barrierfree.Accessibility.Core

  • 参数:

    参数名参数类型必填说明
    abilityType[AbilityType]辅助应用的类型。
    stateType[AbilityState]辅助应用的状态。
    callbackAsyncCallback<Array<[AccessibilityAbilityInfo]>>回调函数,返回辅助应用信息列表。
  • 示例

    accessibility.getAbilityLists("visual", "enable", (err, data) => {if (err) {console.error('failed to getAbilityList2 because ' + JSON.stringify(err));return;}console.info('success data:getAbilityList2 : ' + JSON.stringify(data));for (let item of data) {console.info(item.id);console.info(item.name);console.info(item.description);console.info(item.abilityTypes);console.info(item.eventTypes);console.info(item.capabilities);console.info(item.packageName);console.info(item.filterBundleNames);console.info(item.bundleName);}
    })
    

accessibility.getCaptionsManager8+

getCaptionsManager(): CaptionsManager

获取无障碍字幕配置。

系统能力:SystemCapability.Barrierfree.Accessibility.Hearing

  • 返回值:

    类型说明
    [CaptionsManager]无障碍字幕配置管理。
  • 示例

    captionsManager = accessibility.getCaptionsManager()
    

accessibility.on(‘accessibilityStateChange’ | ‘touchGuideStateChange’)

on(type: ‘accessibilityStateChange’ | ‘touchGuideStateChange’, callback: Callback): void

启用辅助应用和触摸浏览功能的状态变化监听。

系统能力:以下各项对应的系统能力有所不同,详见下表。

  • 参数:

    参数名参数类型必填说明
    typestring监听的事件类型。 - type 为’accessibilityStateChange’时表示监听类型为辅助功能启用状态变化监听; 系统能力:SystemCapability.Barrierfree.Accessibility.Core - type 为’touchGuideStateChange’时表示监听类型为触摸浏览启用状态变化监听。 系统能力:SystemCapability.Barrierfree.Accessibility.Vision
    callbackCallback回调函数,在启用状态变化时将状态通过此函数进行通知。
  • 示例

    accessibility.on('accessibilityStateChange',(data) => { console.info('success data:subscribeStateObserver : ' + JSON.stringify(data))
    })
    

accessibility.off(‘accessibilityStateChange’ | ‘touchGuideStateChange’)

off(type: ‘accessibilityStateChange ’ | ‘touchGuideStateChange’, callback?: Callback): void

关闭辅助应用和触摸浏览功能的状态变化监听。

系统能力:以下各项对应的系统能力有所不同,详见下表。

  • 参数:

    参数名参数类型必填说明
    typestring监听的事件类型。 - type 为’accessibilityStateChange’时表示监听类型为辅助功能启用状态变化监听; 系统能力:SystemCapability.Barrierfree.Accessibility.Core - type 为’touchGuideStateChange’时表示监听类型为触摸浏览启用状态变化监听。 系统能力:SystemCapability.Barrierfree.Accessibility.Vision
    callbackCallback要取消的监听回调函数。
  • 示例

    accessibility.off('accessibilityStateChange',(data) => {console.info('success data:unSubscribeStateObserver : ' + JSON.stringify(data))
    })
    

accessibility.isOpenAccessibility

isOpenAccessibility(): Promise

判断是否启用了辅助功能。

系统能力:SystemCapability.Barrierfree.Accessibility.Core

  • 返回值:

    类型说明
    Promise如果辅助功能已启用,则返回 true;否则返回 false。
  • 示例

    accessibility.isOpenAccessibility().then((data) => {console.info('success data:isOpenAccessibility : ' + JSON.stringify(data))}).catch((error) => {console.error('failed to  isOpenAccessibility because ' + JSON.stringify(error));})
    

accessibility.isOpenAccessibility

isOpenAccessibility(callback: AsyncCallback): void

判断是否启用了辅助功能。

系统能力:SystemCapability.Barrierfree.Accessibility.Core

  • 参数

    参数名参数类型必填说明
    callbackAsyncCallback回调函数,如果辅助功能已启用,则返回 true;否则返回 false。
  • 示例

    accessibility.isOpenAccessibility((err, data) => {if (err) {console.error('failed to isOpenAccessibility because ' + JSON.stringify(err));return;}console.info('success data:isOpenAccessibility : ' + JSON.stringify(data))
    })
    

accessibility.isOpenTouchGuide

isOpenTouchGuide(): Promise

判断触摸浏览模式是否开启。

系统能力:SystemCapability.Barrierfree.Accessibility.Core

  • 返回值:

    类型说明
    Promise如果触摸浏览模式已开启,则返回 true;否则返回 false。
  • 示例

    accessibility.isOpenTouchGuide().then((data) => {console.info('success data:isOpenTouchGuide : ' + JSON.stringify(data))}).catch((error) => {console.error('failed to  isOpenTouchGuide because ' + JSON.stringify(error));})
    

accessibility.isOpenTouchGuide

isOpenTouchGuide(callback: AsyncCallback): void

判断触摸浏览模式是否开启。

系统能力:SystemCapability.Barrierfree.Accessibility.Core

  • 参数

    参数名参数类型必填说明
    callbackAsyncCallback回调函数,如果触摸浏览模式已开启,则返回 true;否则返回 false。
  • 示例

    accessibility.isOpenTouchGuide((err, data) => {if (err) {console.error('failed to isOpenTouchGuide because ' + JSON.stringify(err));return;}console.info('success data:isOpenTouchGuide : ' + JSON.stringify(data))
    })
    

accessibility.sendEvent

sendEvent(event: EventInfo): Promise

发送无障碍事件。

系统能力:SystemCapability.Barrierfree.Accessibility.Core

  • 参数:

    参数名参数类型必填说明
    event[EventInfo]无障碍事件对象。
  • 返回值:

    类型说明
    Promise以 Promise 形式返回结果,如果发送无障碍事件成功,则 data 有数据返回;如果发送无障碍事件失败,则 err 有数据返回。
  • 示例

    accessibility.sendEvent(this.eventInfo).then((data) => {console.info('success data:sendEvent : ' + JSON.stringify(data))}).catch((error) => {console.error('failed to  sendEvent because ' + JSON.stringify(error));})
    

accessibility.sendEvent

sendEvent(event: EventInfo, callback: AsyncCallback): void

发送无障碍事件。

系统能力:SystemCapability.Barrierfree.Accessibility.Core

  • 参数:

    参数名参数类型必填说明
    event[EventInfo]辅助事件对象。
    callbackAsyncCallback回调函数,如果发送无障碍事件成功,则 AsyncCallback 中 data 有数据返回;如果发送无障碍事件失败,则 AsyncCallback 中 err 有数据返回。
  • 示例

    accessibility.sendEvent(this.eventInfo,(err, data) => {if (err) {console.error('failed to sendEvent because ' + JSON.stringify(err));return;}   console.info('success data:sendEvent : ' + JSON.stringify(data))
    })
    

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/bicheng/31651.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

智能体合集

海外版coze: 前端代码助手 后端代码助手&#xff1a; 前端代码助手&#xff1a;

添加右键菜单(以git为例)

1、打开注册表编辑器 打开系统注册表&#xff0c;使用组合键“Win R”输入“regedit”。 依次展开”HKEY_CLASSES_ROOT\Directory\Background\shell”。 2、新建右键菜单项 在[Background]下找到“shell”如果没有则新建项shell&#xff0c;接着在“shell”下右键-新建项名…

基于DPU的云原生裸金属网络解决方案

1. 方案背景和挑战 裸金属服务器是云上资源的重要部分&#xff0c;其网络需要与云上的虚拟机和容器互在同一个VPC下&#xff0c;并且能够像容器和虚拟机一样使用云的网络功能和能力。 传统的裸金属服务器使用开源的 OpenStack Ironic 组件&#xff0c;配合 OpenStack Neutron…

修改主频睡眠模式停止模式待机模式

代码示例&#xff1a; 接线图&#xff1a;修改主频 接线图&#xff1a;睡眠模式串口发送接收 CH340 USB转串口模块。GND和stm32共地。RXD接PA9&#xff0c;TXD接PA10。 接线图&#xff1a;停止模式对射式红外传感器计次 对射式红外传感器模块的VCC和GND接上供电。DO输出接S…

张大哥笔记:5种信息差赚钱模式

从古至今&#xff0c;赚钱最快的路子就一个&#xff0c;而且从未改变&#xff0c;那就是信息差&#xff01;在商业活动中&#xff0c;信息不对称现象普遍存在&#xff0c;如果你善于利用这些信息差的话&#xff0c;就可以赚到钱&#xff01; 1、价格的信息差 商品价格在不同地…

python pyautogui实现图片识别点击失败后重试

安装库 pip install Pillow pip install opencv-python confidence作用 confidence 参数是用于指定图像匹配的信度&#xff08;或置信度&#xff09;的&#xff0c;它表示图像匹配的准确程度。这个参数的值在 0 到 1 之间&#xff0c;数值越高表示匹配的要求越严格。 具体来…

ConcurrentHashMap(应对并发问题的工具类)

并发工具类 在JDK的并发包里提供了几个非常有用的并发容器和并发工具类。供我们在多线程开发中进行使用。 5.1 ConcurrentHashMap 5.1.1 概述以及基本使用 在集合类中HashMap是比较常用的集合对象&#xff0c;但是HashMap是线程不安全的(多线程环境下可能会存在问题)。为了…

可一件转化的视频生成模型:快手官方大模型“可灵”重磅来袭!

可一件转化的视频生成模型“可灵”重磅来袭&#xff01; 前言 戴墨镜的蒙娜丽莎 达芬奇的画作《蒙娜丽莎的微笑》相信大家是在熟悉不过了&#xff0c;可《戴墨镜的蒙娜丽莎》大家是不是第一次见&#xff1f;而且这还不是以照片的形式&#xff0c;而是以视频的形式展示给大家。 …

Spring AOP实战--之优雅的统一打印web请求的出参和入参

背景介绍 由于实际项目内网开发&#xff0c;项目保密&#xff0c;因此本文以笔者自己搭建的demo做演示&#xff0c;方便大家理解。 在项目开发过程中&#xff0c;团队成员为了方便调试&#xff0c;经常会在方法的出口和入口处加上log输出&#xff0c;由于每个人的log需求和输…

奔驰EQS SUV升级原厂主动式氛围灯效果展示

以下是一篇关于奔驰 EQs 升级原厂主动氛围灯案例的宣传文案&#xff1a; 在汽车科技不断演进的今天&#xff0c;我们自豪地为您呈现奔驰 EQs 升级原厂主动氛围灯的精彩案例。 奔驰 EQs&#xff0c;作为豪华电动汽车的典范&#xff0c;其卓越品质与高端性能有目共睹。而此次升…

CVPR 2024盛况空前,上海科技大学夺得最佳学生论文奖,惊艳全场

CVPR 2024盛况空前&#xff01;上海科技大学夺得最佳学生论文奖&#xff0c;惊艳全场&#xff01; 会议之眼 快讯 2024 年 CVPR &#xff08;Computer Vision and Pattern Recogntion Conference) 即国际计算机视觉与模式识别会议&#xff0c;于6月17日至21日正在美国西雅图召…

手把手教你java CPU飙升300%如何优化

背景 今天有个项目运行一段时间后&#xff0c;cpu老是不堪负载。 排查 top 命令 TOP 命令 top t 按cpu 排序 top m 按内存使用率排序 从上面看很快看出是 pid 4338 这个进程资源消耗很高。 top -Hp pid top -Hp 4338 找到对应线程消耗的资源shftp cpu占用进行排序&#xf…

【Java】已解决java.net.ProtocolException异常

文章目录 一、分析问题背景二、可能出错的原因三、错误代码示例四、正确代码示例五、注意事项 已解决java.net.ProtocolException异常 在Java的网络编程中&#xff0c;java.net.ProtocolException异常通常表示在网络通信过程中&#xff0c;客户端或服务器违反了某种协议规则。…

计算机组成原理 | 计算机系统概述

CPI:(Clockcycle Per Instruction)&#xff0c;指每条指令的时钟周期数。 时钟周期&#xff1a;对CPU来说&#xff0c;在一个时钟周期内&#xff0c;CPU仅完成一个最基本的动作。时钟脉冲是计算机的基本工作脉冲&#xff0c;控制着计算机的工作节奏。时钟周期 是一个时钟脉冲所…

除了百度,还有哪些搜索引擎工具可以使用

搜索引擎成是我们获取知识和信息不可或缺的工具。百度作为国内最大的搜索引擎&#xff0c;全球最大的中文搜索引擎&#xff0c;是许多人的首选。那么除了百度&#xff0c;还有哪些搜索引擎可以使用呢&#xff1f;小编就来和大家分享国内可以使用的其他搜索工具。 1. AI搜索 AI…

梯度提升决策树(GBDT)的训练过程

以下通过案例&#xff08;根据行为习惯预测年龄&#xff09;帮助我们深入理解梯度提升决策树&#xff08;GBDT&#xff09;的训练过程 假设训练集有4个人&#xff08;A、B、C、D&#xff09;&#xff0c;他们的年龄分别是14、16、24、26。其中A、B分别是高一和高三学生&#x…

大模型时代,新手和程序员如何转型入局AI行业?

在近期的全国两会上&#xff0c;“人工智能”再次被提及&#xff0c;并成为国家战略的焦点。这一举措预示着在接下来的十年到十五年里&#xff0c;人工智能将获得巨大的发展红利。技术革命正在从“互联网”向“人工智能”逐步迈进&#xff0c;我将迎来新一轮技术革新和人才需求…

ASP.NET Core 6.0 启动方式

启动方式 Visualstudio 2022启动 IIS Express IIS Express 是一个专为开发人员优化的轻型独立版本的 IIS。 借助 IIS Express,可以轻松地使用最新版本的 IIS 开发和测试网站。 控制台版面 直接在浏览器输入监听的地址,监听的是 http://localhost:5137 脚本启动 dotnet run…

C++11 右值引用和移动语义

目录 1.左值引用和右值引用 2.右值引用使用场景&#xff08;移动语义&#xff09;和意义 3.右值引用引用左值及其一些更深入的使用场景分析 4.完美转发 1.左值引用和右值引用 传统的C语法中就有引用的语法&#xff0c;而C11中新增了的右值引用语法特性&#xff0c;所以从现…

Verilog:【8】基于FPGA实现SD NAND FLASH的SPI协议读写

在此介绍的是使用FPGA实现SD NAND FLASH的读写操作&#xff0c;以雷龙发展提供的CS创世SD NAND FLASH样品为例&#xff0c;分别讲解电路连接、读写时序与仿真和实验结果。 目录 1 视频讲解 2 SD NAND FLASH背景介绍 3 样品申请 4 电路结构与接口协议 4.1 SD NAND 4.2 SD NAND测…