native_interface_accessibility.h

概述

声明用于访问Native Accessibility的API，提供无障碍相关能力。支持第三方框架将自身UI组件接入ArkUI无障碍服务体系，包括注册无障碍回调、设置和查询无障碍节点信息、主动上报无障碍事件以及适配多实例场景等，使系统无障碍服务能够识别并操作三方框架的UI组件，适用于第三方UI框架需要与系统无障碍能力进行交互的场景。

引用文件： <arkui/native_interface_accessibility.h>

库： libace_ndk.z.so

系统能力： SystemCapability.ArkUI.ArkUI.Full

起始版本： 13

相关模块： ArkUI_Accessibility

相关示例： AccessibilityCapi

汇总

结构体

枚举

函数

枚举类型说明

ArkUI_Accessibility_ActionType

enum ArkUI_Accessibility_ActionType

描述：

Accessibility操作类型的枚举。

起始版本： 13

ArkUI_AccessibilityEventType

enum ArkUI_AccessibilityEventType

描述：

Accessibility事件类型的枚举。

起始版本： 13

ArkUI_AcessbilityErrorCode

enum ArkUI_AcessbilityErrorCode

描述：

Accessibility错误代码状态的枚举。

起始版本： 13

ArkUI_AccessibilitySearchMode

enum ArkUI_AccessibilitySearchMode

描述：

Accessibility搜索类型的枚举。

起始版本： 13

ArkUI_AccessibilityFocusType

enum ArkUI_AccessibilityFocusType

描述：

Accessibility焦点类型的枚举。

起始版本： 13

ArkUI_AccessibilityFocusMoveDirection

enum ArkUI_AccessibilityFocusMoveDirection

描述：

Accessibility焦点移动方向的枚举。

起始版本： 13

函数说明

OH_ArkUI_AccessibilityProviderRegisterCallback()

int32_t OH_ArkUI_AccessibilityProviderRegisterCallback(ArkUI_AccessibilityProvider* provider, ArkUI_AccessibilityProviderCallbacks* callbacks)

描述：

注册第三方操作provider回调函数到系统侧，由第三方平台实现相关函数并通过本接口完成注册。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityProviderRegisterCallbackWithInstance()

int32_t OH_ArkUI_AccessibilityProviderRegisterCallbackWithInstance(const char* instanceId, ArkUI_AccessibilityProvider* provider, ArkUI_AccessibilityProviderCallbacksWithInstance* callbacks)

描述：

无障碍多实例场景第三方平台将回调函数注册到系统侧。

起始版本： 15

参数：

返回：

OH_ArkUI_SendAccessibilityAsyncEvent()

void OH_ArkUI_SendAccessibilityAsyncEvent(ArkUI_AccessibilityProvider* provider, ArkUI_AccessibilityEventInfo* eventInfo, void (*callback)(int32_t errorCode))

描述：

主动上报事件接口，通知无障碍服务。

使用流程：

1. 先通过OH_ArkUI_CreateAccessibilityEventInfo创建事件信息对象。
2. 通过OH_ArkUI_AccessibilityEventSetEventType、OH_ArkUI_AccessibilityEventSetTextAnnouncedForAccessibility等方法配置事件类型及相关信息。
3. 调用本接口发送事件。
4. 发送完成后通过OH_ArkUI_DestoryAccessibilityEventInfo释放事件信息对象。

起始版本： 13

参数：

OH_ArkUI_AddAndGetAccessibilityElementInfo()

ArkUI_AccessibilityElementInfo* OH_ArkUI_AddAndGetAccessibilityElementInfo(ArkUI_AccessibilityElementInfoList* list)

描述：

在指定的list中增加element成员，并返回element结构。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetElementId()

int32_t OH_ArkUI_AccessibilityElementInfoSetElementId(ArkUI_AccessibilityElementInfo* elementInfo, int32_t elementId)

描述：

为ArkUI_AccessibilityElementInfo设置无障碍元素的唯一标识（elementId）。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetParentId()

int32_t OH_ArkUI_AccessibilityElementInfoSetParentId(ArkUI_AccessibilityElementInfo* elementInfo, int32_t parentId)

描述：

为ArkUI_AccessibilityElementInfo设置父节点的无障碍编号（parentId）。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetComponentType()

int32_t OH_ArkUI_AccessibilityElementInfoSetComponentType(ArkUI_AccessibilityElementInfo* elementInfo, const char* componentType)

描述：

为ArkUI_AccessibilityElementInfo设置组件类型。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetContents()

int32_t OH_ArkUI_AccessibilityElementInfoSetContents(ArkUI_AccessibilityElementInfo* elementInfo, const char* contents)

描述：

为ArkUI_AccessibilityElementInfo设置组件文本内容。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetHintText()

int32_t OH_ArkUI_AccessibilityElementInfoSetHintText(ArkUI_AccessibilityElementInfo* elementInfo, const char* hintText)

描述：

为ArkUI_AccessibilityElementInfo设置提示文本。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetAccessibilityText()

int32_t OH_ArkUI_AccessibilityElementInfoSetAccessibilityText(ArkUI_AccessibilityElementInfo* elementInfo, const char* accessibilityText)

描述：

为ArkUI_AccessibilityElementInfo设置无障碍专用的替代文本。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetAccessibilityDescription()

int32_t OH_ArkUI_AccessibilityElementInfoSetAccessibilityDescription(ArkUI_AccessibilityElementInfo* elementInfo, const char* accessibilityDescription)

描述：

为ArkUI_AccessibilityElementInfo设置无障碍描述信息。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetChildNodeIds()

int32_t OH_ArkUI_AccessibilityElementInfoSetChildNodeIds(ArkUI_AccessibilityElementInfo* elementInfo, int32_t childCount, int64_t* childNodeIds)

描述：

设置ArkUI_AccessibilityElementInfo的子节点数量和子节点ID集合。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetOperationActions()

int32_t OH_ArkUI_AccessibilityElementInfoSetOperationActions(ArkUI_AccessibilityElementInfo* elementInfo,int32_t operationCount, ArkUI_AccessibleAction* operationActions)

描述：

为ArkUI_AccessibilityElementInfo设置组件支持的无障碍操作列表。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetScreenRect()

int32_t OH_ArkUI_AccessibilityElementInfoSetScreenRect(ArkUI_AccessibilityElementInfo* elementInfo, ArkUI_AccessibleRect* screenRect)

描述：

为ArkUI_AccessibilityElementInfo设置组件在屏幕上的矩形区域。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetCheckable()

int32_t OH_ArkUI_AccessibilityElementInfoSetCheckable(ArkUI_AccessibilityElementInfo* elementInfo, bool checkable)

描述：

为ArkUI_AccessibilityElementInfo设置是否可勾选。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetChecked()

int32_t OH_ArkUI_AccessibilityElementInfoSetChecked(ArkUI_AccessibilityElementInfo* elementInfo, bool checked)

描述：

为ArkUI_AccessibilityElementInfo设置当前的勾选状态。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetFocusable()

int32_t OH_ArkUI_AccessibilityElementInfoSetFocusable(ArkUI_AccessibilityElementInfo* elementInfo, bool focusable)

描述：

为ArkUI_AccessibilityElementInfo设置是否可聚焦。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetFocused()

int32_t OH_ArkUI_AccessibilityElementInfoSetFocused(ArkUI_AccessibilityElementInfo* elementInfo, bool isFocused)

描述：

为ArkUI_AccessibilityElementInfo设置是否已聚焦。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetVisible()

int32_t OH_ArkUI_AccessibilityElementInfoSetVisible(ArkUI_AccessibilityElementInfo* elementInfo, bool isVisible)

描述：

为ArkUI_AccessibilityElementInfo设置组件是否在屏幕上可见。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetAccessibilityFocused()

int32_t OH_ArkUI_AccessibilityElementInfoSetAccessibilityFocused(ArkUI_AccessibilityElementInfo* elementInfo, bool accessibilityFocused)

描述：

为ArkUI_AccessibilityElementInfo设置当前的无障碍辅助焦点状态。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetSelected()

int32_t OH_ArkUI_AccessibilityElementInfoSetSelected(ArkUI_AccessibilityElementInfo* elementInfo, bool selected)

描述：

为ArkUI_AccessibilityElementInfo设置是否处于选中状态。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetClickable()

int32_t OH_ArkUI_AccessibilityElementInfoSetClickable(ArkUI_AccessibilityElementInfo* elementInfo, bool clickable)

描述：

为ArkUI_AccessibilityElementInfo设置是否支持点击操作。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetLongClickable()

int32_t OH_ArkUI_AccessibilityElementInfoSetLongClickable(ArkUI_AccessibilityElementInfo* elementInfo, bool longClickable)

描述：

为ArkUI_AccessibilityElementInfo设置是否支持长按操作。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetEnabled()

int32_t OH_ArkUI_AccessibilityElementInfoSetEnabled(ArkUI_AccessibilityElementInfo* elementInfo, bool isEnabled)

描述：

为ArkUI_AccessibilityElementInfo设置组件是否处于启用状态。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetIsPassword()

int32_t OH_ArkUI_AccessibilityElementInfoSetIsPassword(ArkUI_AccessibilityElementInfo* elementInfo, bool isPassword)

描述：

为ArkUI_AccessibilityElementInfo设置是否为密码输入框。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetScrollable()

int32_t OH_ArkUI_AccessibilityElementInfoSetScrollable(ArkUI_AccessibilityElementInfo* elementInfo, bool scrollable)

描述：

为ArkUI_AccessibilityElementInfo设置是否支持滚动操作。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetEditable()

int32_t OH_ArkUI_AccessibilityElementInfoSetEditable(ArkUI_AccessibilityElementInfo* elementInfo, bool editable)

描述：

为ArkUI_AccessibilityElementInfo设置文本内容是否可编辑。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetIsHint()

int32_t OH_ArkUI_AccessibilityElementInfoSetIsHint(ArkUI_AccessibilityElementInfo* elementInfo, bool isHint)

描述：

为ArkUI_AccessibilityElementInfo设置是否处于提示文本状态。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetRangeInfo()

int32_t OH_ArkUI_AccessibilityElementInfoSetRangeInfo(ArkUI_AccessibilityElementInfo* elementInfo, ArkUI_AccessibleRangeInfo* rangeInfo)

描述：

为ArkUI_AccessibilityElementInfo设置范围值信息。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetGridInfo()

int32_t OH_ArkUI_AccessibilityElementInfoSetGridInfo(ArkUI_AccessibilityElementInfo* elementInfo, ArkUI_AccessibleGridInfo* gridInfo)

描述：

为ArkUI_AccessibilityElementInfo设置网格信息。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetGridItemInfo()

int32_t OH_ArkUI_AccessibilityElementInfoSetGridItemInfo(ArkUI_AccessibilityElementInfo* elementInfo, ArkUI_AccessibleGridItemInfo* gridItem)

描述：

为ArkUI_AccessibilityElementInfo设置网格容器中子项的属性信息。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetSelectedTextStart()

int32_t OH_ArkUI_AccessibilityElementInfoSetSelectedTextStart(ArkUI_AccessibilityElementInfo* elementInfo, int32_t selectedTextStart)

描述：

为ArkUI_AccessibilityElementInfo设置选中文本的起始位置。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetSelectedTextEnd()

int32_t OH_ArkUI_AccessibilityElementInfoSetSelectedTextEnd(ArkUI_AccessibilityElementInfo* elementInfo, int32_t selectedTextEnd)

描述：

为ArkUI_AccessibilityElementInfo设置选中文本的结束位置。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetCurrentItemIndex()

int32_t OH_ArkUI_AccessibilityElementInfoSetCurrentItemIndex(ArkUI_AccessibilityElementInfo* elementInfo, int32_t currentItemIndex)

描述：

为ArkUI_AccessibilityElementInfo设置当前获焦或高亮子项的位置索引。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetStartItemIndex()

int32_t OH_ArkUI_AccessibilityElementInfoSetStartItemIndex(ArkUI_AccessibilityElementInfo* elementInfo, int32_t startItemIndex)

描述：

为ArkUI_AccessibilityElementInfo设置当前屏幕可见区域中第一个元素的位置索引。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetEndItemIndex()

int32_t OH_ArkUI_AccessibilityElementInfoSetEndItemIndex(ArkUI_AccessibilityElementInfo* elementInfo, int32_t endItemIndex)

描述：

为ArkUI_AccessibilityElementInfo设置当前屏幕可见区域中最后一个元素的位置索引。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetItemCount()

int32_t OH_ArkUI_AccessibilityElementInfoSetItemCount(ArkUI_AccessibilityElementInfo* elementInfo, int32_t itemCount)

描述：

为ArkUI_AccessibilityElementInfo设置容器中子项的总数。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetAccessibilityOffset()

int32_t OH_ArkUI_AccessibilityElementInfoSetAccessibilityOffset(ArkUI_AccessibilityElementInfo* elementInfo, int32_t offset)

描述：

为ArkUI_AccessibilityElementInfo设置滚动偏移量。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetAccessibilityGroup()

int32_t OH_ArkUI_AccessibilityElementInfoSetAccessibilityGroup(ArkUI_AccessibilityElementInfo* elementInfo, bool accessibilityGroup)

描述：

为ArkUI_AccessibilityElementInfo设置无障碍分组。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetAccessibilityLevel()

int32_t OH_ArkUI_AccessibilityElementInfoSetAccessibilityLevel(ArkUI_AccessibilityElementInfo* elementInfo, const char* accessibilityLevel)

描述：

为ArkUI_AccessibilityElementInfo设置无障碍重要性级别。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetZIndex()

int32_t OH_ArkUI_AccessibilityElementInfoSetZIndex(ArkUI_AccessibilityElementInfo* elementInfo, int32_t zIndex)

描述：

为ArkUI_AccessibilityElementInfo设置组件的Z序。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetAccessibilityOpacity()

int32_t OH_ArkUI_AccessibilityElementInfoSetAccessibilityOpacity(ArkUI_AccessibilityElementInfo* elementInfo, float opacity)

描述：

为ArkUI_AccessibilityElementInfo设置透明度。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetBackgroundColor()

int32_t OH_ArkUI_AccessibilityElementInfoSetBackgroundColor(ArkUI_AccessibilityElementInfo* elementInfo, const char* backgroundColor)

描述：

为ArkUI_AccessibilityElementInfo设置背景色。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetBackgroundImage()

int32_t OH_ArkUI_AccessibilityElementInfoSetBackgroundImage(ArkUI_AccessibilityElementInfo* elementInfo, const char* backgroundImage)

描述：

为ArkUI_AccessibilityElementInfo设置背景图片。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetBlur()

int32_t OH_ArkUI_AccessibilityElementInfoSetBlur(ArkUI_AccessibilityElementInfo* elementInfo, const char* blur)

描述：

为ArkUI_AccessibilityElementInfo设置模糊效果。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetHitTestBehavior()

int32_t OH_ArkUI_AccessibilityElementInfoSetHitTestBehavior(ArkUI_AccessibilityElementInfo* elementInfo, const char* hitTestBehavior)

描述：

为ArkUI_AccessibilityElementInfo设置触摸测试的响应逻辑及节点阻塞规则。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityElementInfoSetComponentIdentifier()

int32_t OH_ArkUI_AccessibilityElementInfoSetComponentIdentifier(ArkUI_AccessibilityElementInfo* elementInfo, const char* identifier)

描述：

为无障碍节点信息ArkUI_AccessibilityElementInfo设置组件标识，可用于自动化测试识别特定组件。

起始版本： 24

参数：

返回：

OH_ArkUI_CreateAccessibilityElementInfo()

ArkUI_AccessibilityElementInfo* OH_ArkUI_CreateAccessibilityElementInfo(void)

描述：

创建一个ArkUI_AccessibilityElementInfo对象，创建后需要调用OH_ArkUI_DestoryAccessibilityElementInfo释放。

起始版本： 13

返回：

OH_ArkUI_DestoryAccessibilityElementInfo()

void OH_ArkUI_DestoryAccessibilityElementInfo(ArkUI_AccessibilityElementInfo* elementInfo)

描述：

销毁一个ArkUI_AccessibilityElementInfo对象。

起始版本： 13

参数：

OH_ArkUI_CreateAccessibilityEventInfo()

ArkUI_AccessibilityEventInfo* OH_ArkUI_CreateAccessibilityEventInfo(void)

描述：

创建一个ArkUI_AccessibilityEventInfo对象，创建后需要调用OH_ArkUI_DestoryAccessibilityEventInfo释放。

起始版本： 13

返回：

OH_ArkUI_DestoryAccessibilityEventInfo()

void OH_ArkUI_DestoryAccessibilityEventInfo(ArkUI_AccessibilityEventInfo* eventInfo)

描述：

销毁ArkUI_AccessibilityEventInfo对象。

起始版本： 13

参数：

OH_ArkUI_AccessibilityEventSetEventType()

int32_t OH_ArkUI_AccessibilityEventSetEventType(ArkUI_AccessibilityEventInfo* eventInfo,  ArkUI_AccessibilityEventType eventType)

描述：

为ArkUI_AccessibilityEventInfo设置事件类型。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityEventSetTextAnnouncedForAccessibility()

int32_t OH_ArkUI_AccessibilityEventSetTextAnnouncedForAccessibility(ArkUI_AccessibilityEventInfo* eventInfo,  const char* textAnnouncedForAccessibility)

描述：

为ArkUI_AccessibilityEventInfo设置主动播报的内容。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityEventSetRequestFocusId()

int32_t OH_ArkUI_AccessibilityEventSetRequestFocusId(ArkUI_AccessibilityEventInfo* eventInfo,  int32_t requestFocusId)

描述：

为ArkUI_AccessibilityEventInfo设置请求焦点id。

起始版本： 13

参数：

返回：

OH_ArkUI_AccessibilityEventSetElementInfo()

int32_t OH_ArkUI_AccessibilityEventSetElementInfo(ArkUI_AccessibilityEventInfo* eventInfo,  ArkUI_AccessibilityElementInfo* elementInfo)

描述：

为ArkUI_AccessibilityEventInfo设置elementInfo。

起始版本： 13

参数：

返回：

OH_ArkUI_FindAccessibilityActionArgumentByKey()

int32_t OH_ArkUI_FindAccessibilityActionArgumentByKey(ArkUI_AccessibilityActionArguments* arguments, const char* key, char** value)

描述：

获取ArkUI_AccessibilityActionArguments中指定key的value值。

起始版本： 13

参数：

返回：

OH_ArkUI_NativeModule_GetNativeAccessibilityProvider()

int32_t OH_ArkUI_NativeModule_GetNativeAccessibilityProvider(ArkUI_NodeHandle* node, ArkUI_AccessibilityProvider** provider)

描述：

获取指向ArkUI_AccessibilityProvider对象指针的二级指针变量。

其中ArkUI_AccessibilityProvider对象与传入的ArkUI_NodeHandle的实例一一对应。

三方框架将自身UI组件映射为ARKUI_NODE_CUSTOM类型的RenderNode并得到ArkUI_NodeHandle。

再调用OH_ArkUI_NativeModule_GetNativeAccessibilityProvider接口获取ArkUI_AccessibilityProvider指针并注册无障碍回调。

最终实现ArkUI无障碍服务对三方框架UI的识别与事件触发。

仅当三方框架将自身UI组件映射为ARKUI_NODE_CUSTOM的RenderNode，该接口才会生效，否则会报错误码。

本接口通过RenderNode实现三方框架的接入，仅支持ARKUI_NODE_CUSTOM接入无障碍服务，可以实现无障碍控件树获取能力。

不支持多线程并发，由三方框架保证调用时的线程安全。

起始版本： 23

参数：

返回：