harmony 鸿蒙Native XComponent

2025-06-12 浏览 (1)

Native XComponent

概述

描述ArkUI XComponent持有的Surface和触摸事件，该事件可用于EGL/OpenGLES和媒体数据输入，并显示在ArkUI XComponent上，具体使用请参考Native XComponent。

说明：

该模块从API Version 8 开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。

汇总

文件

名称描述
native_interface_xcomponent.h声明用于访问Native XComponent的API。
native_xcomponent_key_event.h声明用于访问Native XComponent键盘事件所使用到的枚举类型。

结构体

名称描述
OH_NativeXComponent_TouchPoint触摸事件中触摸点的信息。
OH_NativeXComponent_TouchEvent触摸事件。
OH_NativeXComponent_MouseEvent鼠标事件。
OH_NativeXComponent_Callback注册Surface生命周期和触摸事件回调。
OH_NativeXComponent_MouseEvent_Callback注册鼠标事件的回调。
OH_NativeXComponent_ExpectedRateRange定义期望帧率范围。

类型定义

名称描述
OH_NativeXComponent提供封装的OH_NativeXComponent实例。
OH_NativeXComponent_Callback注册Surface生命周期和触摸事件回调。
OH_NativeXComponent_MouseEvent_Callback注册鼠标事件的回调。
OH_NativeXComponent_KeyEvent提供封装的OH_NativeXComponent_KeyEvent实例。
OH_NativeXComponent_ExtraMouseEventInfo提供封装的扩展的鼠标事件信息实例。
OH_ArkUI_SurfaceCallback定义Surface生命周期回调函数。
OH_ArkUI_SurfaceHolder提供封装的OH_ArkUI_SurfaceHolder实例。
OHNativeWindow提供封装的NativeWindow实例。

枚举

名称描述
{ OH_NATIVEXCOMPONENT_RESULT_SUCCESS = 0, OH_NATIVEXCOMPONENT_RESULT_FAILED = -1, OH_NATIVEXCOMPONENT_RESULT_BAD_PARAMETER = -2 }枚举API访问状态。
OH_NativeXComponent_TouchEventType {
OH_NATIVEXCOMPONENT_DOWN = 0, OH_NATIVEXCOMPONENT_UP, OH_NATIVEXCOMPONENT_MOVE, OH_NATIVEXCOMPONENT_CANCEL,
OH_NATIVEXCOMPONENT_UNKNOWN
}		触摸事件类型。
OH_NativeXComponent_TouchPointToolType {
OH_NATIVEXCOMPONENT_TOOL_TYPE_UNKNOWN = 0, OH_NATIVEXCOMPONENT_TOOL_TYPE_FINGER, OH_NATIVEXCOMPONENT_TOOL_TYPE_PEN, OH_NATIVEXCOMPONENT_TOOL_TYPE_RUBBER,
OH_NATIVEXCOMPONENT_TOOL_TYPE_BRUSH, OH_NATIVEXCOMPONENT_TOOL_TYPE_PENCIL, OH_NATIVEXCOMPONENT_TOOL_TYPE_AIRBRUSH, OH_NATIVEXCOMPONENT_TOOL_TYPE_MOUSE,
OH_NATIVEXCOMPONENT_TOOL_TYPE_LENS
}		触摸点工具类型。
OH_NativeXComponent_EventSourceType {
OH_NATIVEXCOMPONENT_SOURCE_TYPE_UNKNOWN = 0, OH_NATIVEXCOMPONENT_SOURCE_TYPE_MOUSE, OH_NATIVEXCOMPONENT_SOURCE_TYPE_TOUCHSCREEN, OH_NATIVEXCOMPONENT_SOURCE_TYPE_TOUCHPAD,
OH_NATIVEXCOMPONENT_SOURCE_TYPE_JOYSTICK, OH_NATIVEXCOMPONENT_SOURCE_TYPE_KEYBOARD
}		触摸事件源类型。
OH_NativeXComponent_MouseEventAction { OH_NATIVEXCOMPONENT_MOUSE_NONE = 0, OH_NATIVEXCOMPONENT_MOUSE_PRESS, OH_NATIVEXCOMPONENT_MOUSE_RELEASE, OH_NATIVEXCOMPONENT_MOUSE_MOVE OH_NATIVEXCOMPONENT_MOUSE_CANCEL }鼠标事件动作。
OH_NativeXComponent_MouseEventButton {
OH_NATIVEXCOMPONENT_NONE_BUTTON = 0, OH_NATIVEXCOMPONENT_LEFT_BUTTON = 0x01, OH_NATIVEXCOMPONENT_RIGHT_BUTTON = 0x02, OH_NATIVEXCOMPONENT_MIDDLE_BUTTON = 0x04,
OH_NATIVEXCOMPONENT_BACK_BUTTON = 0x08, OH_NATIVEXCOMPONENT_FORWARD_BUTTON = 0x10
}		鼠标事件按键。
OH_NativeXComponent_KeyCode {
KEY_UNKNOWN = -1, KEY_FN = 0, KEY_HOME = 1, KEY_BACK = 2,KEY_MEDIA_PLAY_PAUSE = 10, KEY_MEDIA_STOP = 11, KEY_MEDIA_NEXT = 12, KEY_MEDIA_PREVIOUS = 13,
KEY_MEDIA_REWIND = 14, KEY_MEDIA_FAST_FORWARD = 15, KEY_VOLUME_UP = 16, KEY_VOLUME_DOWN = 17,
KEY_POWER = 18, KEY_CAMERA = 19, KEY_VOLUME_MUTE = 22, KEY_MUTE = 23,KEY_BRIGHTNESS_UP = 40, KEY_BRIGHTNESS_DOWN = 41, KEY_0 = 2000, KEY_1 = 2001,
KEY_2 = 2002, KEY_3 = 2003, KEY_4 = 2004, KEY_5 = 2005,
KEY_6 = 2006, KEY_7 = 2007, KEY_8 = 2008, KEY_9 = 2009,
KEY_STAR = 2010, KEY_POUND = 2011, KEY_DPAD_UP = 2012, KEY_DPAD_DOWN = 2013,KEY_DPAD_LEFT = 2014, KEY_DPAD_RIGHT = 2015, KEY_DPAD_CENTER = 2016,
KEY_A = 2017,
KEY_B = 2018, KEY_C = 2019, KEY_D = 2020, KEY_E = 2021,
KEY_F = 2022, KEY_G = 2023, KEY_H = 2024, KEY_I = 2025,
KEY_J = 2026, KEY_K = 2027, KEY_L = 2028, KEY_M = 2029,
KEY_N = 2030, KEY_O = 2031, KEY_P = 2032, KEY_Q = 2033,
KEY_R = 2034, KEY_S = 2035, KEY_T = 2036, KEY_U = 2037,
KEY_V = 2038, KEY_W = 2039, KEY_X = 2040, KEY_Y = 2041,
KEY_Z = 2042, KEY_COMMA = 2043, KEY_PERIOD = 2044, KEY_ALT_LEFT = 2045,
KEY_ALT_RIGHT = 2046, KEY_SHIFT_LEFT = 2047, KEY_SHIFT_RIGHT = 2048, KEY_TAB = 2049,
KEY_SPACE = 2050, KEY_SYM = 2051, KEY_EXPLORER = 2052, KEY_ENVELOPE = 2053,
KEY_ENTER = 2054, KEY_DEL = 2055, KEY_GRAVE = 2056, KEY_MINUS = 2057,
KEY_EQUALS = 2058, KEY_LEFT_BRACKET = 2059, KEY_RIGHT_BRACKET = 2060, KEY_BACKSLASH = 2061,
KEY_SEMICOLON = 2062, KEY_APOSTROPHE = 2063, KEY_SLASH = 2064, KEY_AT = 2065,
KEY_PLUS = 2066, KEY_MENU = 2067, KEY_PAGE_UP = 2068, KEY_PAGE_DOWN = 2069,
KEY_ESCAPE = 2070, KEY_FORWARD_DEL = 2071, KEY_CTRL_LEFT = 2072, KEY_CTRL_RIGHT = 2073,
KEY_CAPS_LOCK = 2074, KEY_SCROLL_LOCK = 2075, KEY_META_LEFT = 2076, KEY_META_RIGHT = 2077,
KEY_FUNCTION = 2078, KEY_SYSRQ = 2079, KEY_BREAK = 2080, KEY_MOVE_HOME = 2081,
KEY_MOVE_END = 2082, KEY_INSERT = 2083, KEY_FORWARD = 2084, KEY_MEDIA_PLAY = 2085,
KEY_MEDIA_PAUSE = 2086, KEY_MEDIA_CLOSE = 2087, KEY_MEDIA_EJECT = 2088, KEY_MEDIA_RECORD = 2089,
KEY_F1 = 2090, KEY_F2 = 2091, KEY_F3 = 2092, KEY_F4 = 2093,
KEY_F5 = 2094, KEY_F6 = 2095, KEY_F7 = 2096, KEY_F8 = 2097,
KEY_F9 = 2098, KEY_F10 = 2099, KEY_F11 = 2100, KEY_F12 = 2101,
KEY_NUM_LOCK = 2102, KEY_NUMPAD_0 = 2103, KEY_NUMPAD_1 = 2104, KEY_NUMPAD_2 = 2105,
KEY_NUMPAD_3 = 2106, KEY_NUMPAD_4 = 2107, KEY_NUMPAD_5 = 2108, KEY_NUMPAD_6 = 2109,
KEY_NUMPAD_7 = 2110, KEY_NUMPAD_8 = 2111, KEY_NUMPAD_9 = 2112, KEY_NUMPAD_DIVIDE = 2113,
KEY_NUMPAD_MULTIPLY = 2114, KEY_NUMPAD_SUBTRACT = 2115, KEY_NUMPAD_ADD = 2116, KEY_NUMPAD_DOT = 2117,
KEY_NUMPAD_COMMA = 2118, KEY_NUMPAD_ENTER = 2119, KEY_NUMPAD_EQUALS = 2120, KEY_NUMPAD_LEFT_PAREN = 2121,
KEY_NUMPAD_RIGHT_PAREN = 2122, KEY_VIRTUAL_MULTITASK = 2210, KEY_SLEEP = 2600, KEY_ZENKAKU_HANKAKU = 2601,
KEY_102ND = 2602, KEY_RO = 2603, KEY_KATAKANA = 2604, KEY_HIRAGANA = 2605,
KEY_HENKAN = 2606, KEY_KATAKANA_HIRAGANA = 2607, KEY_MUHENKAN = 2608, KEY_LINEFEED = 2609,
KEY_MACRO = 2610, KEY_NUMPAD_PLUSMINUS = 2611, KEY_SCALE = 2612, KEY_HANGUEL = 2613,
KEY_HANJA = 2614, KEY_YEN = 2615, KEY_STOP = 2616, KEY_AGAIN = 2617,
KEY_PROPS = 2618, KEY_UNDO = 2619, KEY_COPY = 2620, KEY_OPEN = 2621,
KEY_PASTE = 2622, KEY_FIND = 2623, KEY_CUT = 2624, KEY_HELP = 2625,
KEY_CALC = 2626, KEY_FILE = 2627, KEY_BOOKMARKS = 2628, KEY_NEXT = 2629,
KEY_PLAYPAUSE = 2630, KEY_PREVIOUS = 2631, KEY_STOPCD = 2632, KEY_CONFIG = 2634,
KEY_REFRESH = 2635, KEY_EXIT = 2636, KEY_EDIT = 2637, KEY_SCROLLUP = 2638,
KEY_SCROLLDOWN = 2639, KEY_NEW = 2640, KEY_REDO = 2641, KEY_CLOSE = 2642,
KEY_PLAY = 2643, KEY_BASSBOOST = 2644, KEY_PRINT = 2645, KEY_CHAT = 2646,
KEY_FINANCE = 2647, KEY_CANCEL = 2648, KEY_KBDILLUM_TOGGLE = 2649, KEY_KBDILLUM_DOWN = 2650,
KEY_KBDILLUM_UP = 2651, KEY_SEND = 2652, KEY_REPLY = 2653, KEY_FORWARDMAIL = 2654,
KEY_SAVE = 2655, KEY_DOCUMENTS = 2656, KEY_VIDEO_NEXT = 2657, KEY_VIDEO_PREV = 2658,
KEY_BRIGHTNESS_CYCLE = 2659, KEY_BRIGHTNESS_ZERO = 2660, KEY_DISPLAY_OFF = 2661, KEY_BTN_MISC = 2662,
KEY_GOTO = 2663, KEY_INFO = 2664, KEY_PROGRAM = 2665, KEY_PVR = 2666,
KEY_SUBTITLE = 2667, KEY_FULL_SCREEN = 2668, KEY_KEYBOARD = 2669, KEY_ASPECT_RATIO = 2670,
KEY_PC = 2671, KEY_TV = 2672, KEY_TV2 = 2673, KEY_VCR = 2674,
KEY_VCR2 = 2675, KEY_SAT = 2676, KEY_CD = 2677, KEY_TAPE = 2678,
KEY_TUNER = 2679, KEY_PLAYER = 2680, KEY_DVD = 2681, KEY_AUDIO = 2682,
KEY_VIDEO = 2683, KEY_MEMO = 2684, KEY_CALENDAR = 2685, KEY_RED = 2686,
KEY_GREEN = 2687, KEY_YELLOW = 2688, KEY_BLUE = 2689, KEY_CHANNELUP = 2690,
KEY_CHANNELDOWN = 2691, KEY_LAST = 2692, KEY_RESTART = 2693, KEY_SLOW = 2694,
KEY_SHUFFLE = 2695, KEY_VIDEOPHONE = 2696, KEY_GAMES = 2697, KEY_ZOOMIN = 2698,
KEY_ZOOMOUT = 2699, KEY_ZOOMRESET = 2700, KEY_WORDPROCESSOR = 2701, KEY_EDITOR = 2702,
KEY_SPREADSHEET = 2703, KEY_GRAPHICSEDITOR = 2704, KEY_PRESENTATION = 2705, KEY_DATABASE = 2706,
KEY_NEWS = 2707, KEY_VOICEMAIL = 2708, KEY_ADDRESSBOOK = 2709, KEY_MESSENGER = 2710,
KEY_BRIGHTNESS_TOGGLE = 2711, KEY_SPELLCHECK = 2712, KEY_COFFEE = 2713, KEY_MEDIA_REPEAT = 2714,
KEY_IMAGES = 2715, KEY_BUTTONCONFIG = 2716, KEY_TASKMANAGER = 2717, KEY_JOURNAL = 2718,
KEY_CONTROLPANEL = 2719, KEY_APPSELECT = 2720, KEY_SCREENSAVER = 2721, KEY_ASSISTANT = 2722,
KEY_KBD_LAYOUT_NEXT = 2723, KEY_BRIGHTNESS_MIN = 2724, KEY_BRIGHTNESS_MAX = 2725, KEY_KBDINPUTASSIST_PREV = 2726,
KEY_KBDINPUTASSIST_NEXT = 2727, KEY_KBDINPUTASSIST_PREVGROUP = 2728, KEY_KBDINPUTASSIST_NEXTGROUP = 2729, KEY_KBDINPUTASSIST_ACCEPT = 2730,
KEY_KBDINPUTASSIST_CANCEL = 2731, KEY_FRONT = 2800, KEY_SETUP = 2801, KEY_WAKEUP = 2802,
KEY_SENDFILE = 2803, KEY_DELETEFILE = 2804, KEY_XFER = 2805, KEY_PROG1 = 2806,
KEY_PROG2 = 2807, KEY_MSDOS = 2808, KEY_SCREENLOCK = 2809, KEY_DIRECTION_ROTATE_DISPLAY = 2810,
KEY_CYCLEWINDOWS = 2811, KEY_COMPUTER = 2812, KEY_EJECTCLOSECD = 2813, KEY_ISO = 2814,
KEY_MOVE = 2815, KEY_F13 = 2816, KEY_F14 = 2817, KEY_F15 = 2818,
KEY_F16 = 2819, KEY_F17 = 2820, KEY_F18 = 2821, KEY_F19 = 2822,
KEY_F20 = 2823, KEY_F21 = 2824, KEY_F22 = 2825, KEY_F23 = 2826,
KEY_F24 = 2827, KEY_PROG3 = 2828, KEY_PROG4 = 2829, KEY_DASHBOARD = 2830,
KEY_SUSPEND = 2831, KEY_HP = 2832, KEY_SOUND = 2833, KEY_QUESTION = 2834,
KEY_CONNECT = 2836, KEY_SPORT = 2837, KEY_SHOP = 2838, KEY_ALTERASE = 2839,
KEY_SWITCHVIDEOMODE = 2841, KEY_BATTERY = 2842, KEY_BLUETOOTH = 2843, KEY_WLAN = 2844,
KEY_UWB = 2845, KEY_WWAN_WIMAX = 2846, KEY_RFKILL = 2847, KEY_CHANNEL = 3001,
KEY_BTN_0 = 3100, KEY_BTN_1 = 3101, KEY_BTN_2 = 3102, KEY_BTN_3 = 3103,
KEY_BTN_4 = 3104, KEY_BTN_5 = 3105, KEY_BTN_6 = 3106, KEY_BTN_7 = 3107,
KEY_BTN_8 = 3108, KEY_BTN_9 = 3109
}		按键事件的键码。
OH_NativeXComponent_KeyAction { OH_NATIVEXCOMPONENT_KEY_ACTION_UNKNOWN = -1, OH_NATIVEXCOMPONENT_KEY_ACTION_DOWN = 0, OH_NATIVEXCOMPONENT_KEY_ACTION_UP }按键事件动作。
ArkUI_XComponent_ImageAnalyzerState { ARKUI_XCOMPONENT_AI_ANALYSIS_FINISHED = 0, ARKUI_XCOMPONENT_AI_ANALYSIS_DISABLED = 110000, ARKUI_XCOMPONENT_AI_ANALYSIS_UNSUPPORTED = 110001, ARKUI_XCOMPONENT_AI_ANALYSIS_ONGOING = 110002, ARKUI_XCOMPONENT_AI_ANALYSIS_STOPPED = 110003}XComponent图像AI分析状态码。

函数

名称描述
OH_NativeXComponent_GetXComponentId (OH_NativeXComponent *component, char *id, uint64_t *size)获取ArkUI XComponent的id。
OH_NativeXComponent_GetXComponentSize (OH_NativeXComponent *component, const void *window, uint64_t *width, uint64_t *height)获取ArkUI XComponent持有的Surface的大小。
OH_NativeXComponent_GetXComponentOffset (OH_NativeXComponent *component, const void *window, double *x, double *y)获取XComponent持有的Surface相对其父组件左顶点的偏移量。
OH_NativeXComponent_GetTouchEvent (OH_NativeXComponent *component, const void *window, OH_NativeXComponent_TouchEvent *touchEvent)获取ArkUI XComponent调度的触摸事件。
OH_NativeXComponent_GetTouchPointToolType (OH_NativeXComponent *component, uint32_t pointIndex, OH_NativeXComponent_TouchPointToolType *toolType)获取ArkUI XComponent触摸点工具类型。
OH_NativeXComponent_GetTouchPointTiltX (OH_NativeXComponent *component, uint32_t pointIndex, float *tiltX)获取ArkUI XComponent触摸点倾斜与X轴角度。
OH_NativeXComponent_GetTouchPointTiltY (OH_NativeXComponent *component, uint32_t pointIndex, float *tiltY)获取ArkUI XComponent触摸点倾斜与Y轴角度。
OH_NativeXComponent_GetMouseEvent (OH_NativeXComponent *component, const void *window, OH_NativeXComponent_MouseEvent *mouseEvent)获取ArkUI XComponent调度的鼠标事件。
OH_NativeXComponent_RegisterCallback (OH_NativeXComponent *component, OH_NativeXComponent_Callback *callback)为此OH_NativeXComponent实例注册回调。
OH_NativeXComponent_RegisterMouseEventCallback (OH_NativeXComponent *component, OH_NativeXComponent_MouseEvent_Callback *callback)为此OH_NativeXComponent实例注册鼠标事件回调。
OH_NativeXComponent_RegisterFocusEventCallback (OH_NativeXComponent *component, void(*callback)(OH_NativeXComponent *component, void *window))为此OH_NativeXComponent实例注册获焦事件回调。
OH_NativeXComponent_RegisterKeyEventCallback (OH_NativeXComponent *component, void(*callback)(OH_NativeXComponent *component, void *window))为此OH_NativeXComponent实例注册按键事件回调。
OH_NativeXComponent_RegisterKeyEventCallbackWithResult (OH_NativeXComponent *component, bool(*callback)(OH_NativeXComponent *component, void *window))为此OH_NativeXComponent实例注册有返回值的按键事件回调。
OH_NativeXComponent_RegisterBlurEventCallback (OH_NativeXComponent *component, void(*callback)(OH_NativeXComponent *component, void *window))为此OH_NativeXComponent实例注册失焦事件回调。
OH_NativeXComponent_GetKeyEvent (OH_NativeXComponent *component, OH_NativeXComponent_KeyEvent **keyEvent)获取ArkUI XComponent调度的按键事件。
OH_NativeXComponent_GetKeyEventAction (OH_NativeXComponent_KeyEvent *keyEvent, OH_NativeXComponent_KeyAction *action)获取传入按键事件的动作。
OH_NativeXComponent_GetKeyEventCode (OH_NativeXComponent_KeyEvent *keyEvent, OH_NativeXComponent_KeyCode *code)获取传入按键事件的按键码。
OH_NativeXComponent_GetKeyEventSourceType (OH_NativeXComponent_KeyEvent *keyEvent, OH_NativeXComponent_EventSourceType *sourceType)获取传入按键事件的事件源类型。
OH_NativeXComponent_GetKeyEventDeviceId (OH_NativeXComponent_KeyEvent *keyEvent, int64_t *deviceId)获取传入按键事件的设备id。
OH_NativeXComponent_GetKeyEventTimestamp (OH_NativeXComponent_KeyEvent *keyEvent, int64_t *timeStamp)获取传入按键事件的时间戳。
OH_NativeXComponent_SetExpectedFrameRateRange (OH_NativeXComponent *component, OH_NativeXComponent_ExpectedRateRange *range)设置期望帧率范围。
OH_NativeXComponent_RegisterOnFrameCallback (OH_NativeXComponent *component, void(*callback)(OH_NativeXComponent *component, uint64_t timestamp, uint64_t targetTimestamp))为此OH_NativeXComponent实例注册显示更新回调，并使能每帧回调此函数。
OH_NativeXComponent_UnregisterOnFrameCallback (OH_NativeXComponent *component)为此OH_NativeXComponent实例取消注册回调函数，并关闭每帧回调此函数。
int32_t OH_NativeXComponent_AttachNativeRootNode (OH_NativeXComponent *component, ArkUI_NodeHandle root)将通过ArkUI的Native接口创建出来的UI组件挂载到当前XComponent上。
int32_t OH_NativeXComponent_DetachNativeRootNode (OH_NativeXComponent *component, ArkUI_NodeHandle root)将ArkUI的Native组件从当前XComponent上卸载。
int32_t OH_NativeXComponent_RegisterUIInputEventCallback (OH_NativeXComponent *component, void(*callback)(OH_NativeXComponent *component, ArkUI_UIInputEvent *event, ArkUI_UIInputEvent_Type type), ArkUI_UIInputEvent_Type type)为此OH_NativeXComponent实例注册UI输入事件回调，并使能收到UI输入事件时回调此函数。
int32_t OH_NativeXComponent_RegisterOnTouchInterceptCallback (OH_NativeXComponent *component, ArkUI_HitTestMode(*callback)(OH_NativeXComponent *component, ArkUI_UIInputEvent *event))为此OH_NativeXComponent实例注册自定义事件拦截回调，并使能在做触摸测试时回调此函数。
int32_t OH_NativeXComponent_SetNeedSoftKeyboard (OH_NativeXComponent *component, bool isNeedSoftKeyboard)为此OH_NativeXComponent实例设置是否需要软键盘。
int32_t OH_NativeXComponent_RegisterSurfaceShowCallback (OH_NativeXComponent *component, void(*callback)(OH_NativeXComponent *component, void *window))为此OH_NativeXComponent实例注册Surface显示回调，该回调在应用从后台返回前台后触发。
int32_t OH_NativeXComponent_RegisterSurfaceHideCallback (OH_NativeXComponent *component, void(*callback)(OH_NativeXComponent *component, void *window))为此OH_NativeXComponent实例注册Surface隐藏回调，该回调在应用从前台来到后台后触发。
int32_t OH_NativeXComponent_GetTouchEventSourceType (OH_NativeXComponent *component, int32_t pointId, OH_NativeXComponent_EventSourceType *sourceType)获取ArkUI XComponent触摸事件的输入设备类型。
OH_NativeXComponent * OH_NativeXComponent_GetNativeXComponent (ArkUI_NodeHandle node)基于Native接口创建的组件实例获取OH_NativeXComponent类型的指针。
int32_t OH_NativeXComponent_GetNativeAccessibilityProvider(OH_NativeXComponent* component, ArkUI_AccessibilityProvider** handle);基于NativeXComponent实例获取的ArkUI_AccessibilityProvider类型的指针。
int32_t OH_NativeXComponent_RegisterKeyEventCallbackWithResult (OH_NativeXComponent *component, bool(*callback)(OH_NativeXComponent *component, void *window))为此OH_NativeXComponent实例注册有返回值的按键事件回调。
int32_t OH_ArkUI_XComponent_StartImageAnalyzer (ArkUI_NodeHandle node, void *userData,void (*callback)(ArkUI_NodeHandle node, ArkUI_XComponent_ImageAnalyzerState statusCode, void *userData))为此XComponent组件实例开始图像AI分析。
int32_t OH_ArkUI_XComponent_StopImageAnalyzer(ArkUI_NodeHandle node)为此XComponent组件实例停止图像AI分析。
OH_ArkUI_SurfaceCallback* OH_ArkUI_SurfaceCallback_Create()创建OH_ArkUI_SurfaceCallback对象。
void OH_ArkUI_SurfaceCallback_Dispose(OH_ArkUI_SurfaceCallback* callback)销毁OH_ArkUI_SurfaceCallback对象。
OH_ArkUI_SurfaceHolder* OH_ArkUI_SurfaceHolder_Create(ArkUI_NodeHandle node)创建XComponent组件的OH_ArkUI_SurfaceHolder对象。
void OH_ArkUI_SurfaceHolder_Dispose(OH_ArkUI_SurfaceHolder* surfaceHolder)销毁OH_ArkUI_SurfaceHolder对象。
int32_t OH_ArkUI_SurfaceHolder_SetUserData(OH_ArkUI_SurfaceHolder* surfaceHolder, void* userData)向OH_ArkUI_SurfaceHolder实例存储自定义数据。
void* OH_ArkUI_SurfaceHolder_GetUserData(OH_ArkUI_SurfaceHolder* surfaceHolder)获取OH_ArkUI_SurfaceHolder实例存储的自定义数据。
void OH_ArkUI_SurfaceCallback_SetSurfaceCreatedEvent(OH_ArkUI_SurfaceCallback* callback, void (*onSurfaceCreated)(OH_ArkUI_SurfaceHolder* surfaceHolder))设置Surface生命周期回调中的创建回调事件。
void OH_ArkUI_SurfaceCallback_SetSurfaceChangedEvent(OH_ArkUI_SurfaceCallback* callback, void (*onSurfaceChanged)(OH_ArkUI_SurfaceHolder* surfaceHolder, uint64_t width, uint64_t height))设置Surface生命周期回调中的大小改变回调事件。
void OH_ArkUI_SurfaceCallback_SetSurfaceDestroyedEvent(OH_ArkUI_SurfaceCallback* callback, void (*onSurfaceDestroyed)(OH_ArkUI_SurfaceHolder* surfaceHolder))设置Surface生命周期回调中的销毁回调事件。
int32_t OH_ArkUI_SurfaceHolder_AddSurfaceCallback(OH_ArkUI_SurfaceHolder* surfaceHolder, OH_ArkUI_SurfaceCallback* callback)添加Surface生命周期回调到OH_ArkUI_SurfaceHolder实例。
int32_t OH_ArkUI_SurfaceHolder_RemoveSurfaceCallback(OH_ArkUI_SurfaceHolder* surfaceHolder, OH_ArkUI_SurfaceCallback* callback)删除OH_ArkUI_SurfaceHolder实例的先前添加的Surface生命周期回调。
OHNativeWindow* OH_ArkUI_XComponent_GetNativeWindow(OH_ArkUI_SurfaceHolder* surfaceHolder)获取OH_ArkUI_SurfaceHolder实例关联的NativeWindow。
int32_t OH_ArkUI_XComponent_SetAutoInitialize(ArkUI_NodeHandle node, bool autoInitialize)设置XComponent组件是否需要自动初始化Surface的标志位。
int32_t OH_ArkUI_XComponent_Initialize(ArkUI_NodeHandle node)初始化XComponent组件持有的Surface。
int32_t OH_ArkUI_XComponent_Finalize(ArkUI_NodeHandle node)销毁XComponent组件持有的Surface。
int32_t OH_ArkUI_XComponent_IsInitialized(ArkUI_NodeHandle node, bool* isInitialized)获取XComponent组件是否已经初始化Surface的标志位。
int32_t OH_NativeXComponent_GetExtraMouseEventInfo(OH_NativeXComponent* component, OH_NativeXComponent_ExtraMouseEventInfo** extraMouseEventInfo)从此OH_NativeXComponent实例中获取扩展的鼠标事件信息。
int32_t OH_NativeXComponent_GetMouseEventModifierKeyStates(OH_NativeXComponent_ExtraMouseEventInfo* extraMouseEventInfo, uint64_t* keys)从OH_NativeXComponent_ExtraMouseEventInfo实例中获取功能键按压状态信息。
int32_t OH_NativeXComponent_GetKeyEventModifierKeyStates(OH_NativeXComponent_KeyEvent* keyEvent, uint64_t* keys)从按键事件中获取功能键按压状态信息。
int32_t OH_NativeXComponent_GetKeyEventNumLockState(OH_NativeXComponent_KeyEvent* keyEvent, bool* isNumLockOn)从按键事件中获取NumLock（小键盘锁定）键的状态信息。
int32_t OH_NativeXComponent_GetKeyEventCapsLockState(OH_NativeXComponent_KeyEvent* keyEvent, bool* isCapsLockOn)从按键事件中获取CapsLock（大写锁定）键的状态信息。
int32_t OH_NativeXComponent_GetKeyEventScrollLockState(OH_NativeXComponent_KeyEvent* keyEvent, bool* isScrollLockOn)从按键事件中获取ScrollLock（滚动锁定）键的状态信息。
int32_t OH_ArkUI_XComponent_SetExpectedFrameRateRange(ArkUI_NodeHandle node, OH_NativeXComponent_ExpectedRateRange range)为此XComponent组件实例设置期望帧率。
int32_t OH_ArkUI_XComponent_RegisterOnFrameCallback(ArkUI_NodeHandle node,void (*callback)(ArkUI_NodeHandle node, uint64_t timestamp, uint64_t targetTimestamp))为此XComponent组件实例注册帧回调函数。
int32_t OH_ArkUI_XComponent_UnregisterOnFrameCallback(ArkUI_NodeHandle node)为此XComponent组件实例取消注册帧回调函数。
int32_t OH_ArkUI_XComponent_SetNeedSoftKeyboard(ArkUI_NodeHandle node, bool needSoftKeyboard)为此XComponent组件实例设置是否需要软键盘。
ArkUI_AccessibilityProvider* OH_ArkUI_AccessibilityProvider_Create(ArkUI_NodeHandle node)基于此XComponent组件实例创建ArkUI_AccessibilityProvider实例。
void OH_ArkUI_AccessibilityProvider_Dispose(ArkUI_AccessibilityProvider* provider)销毁由NDK接口OH_ArkUI_AccessibilityProvider_Create创建的ArkUI_AccessibilityProvider实例。
void OH_ArkUI_SurfaceCallback_SetSurfaceShowEvent(OH_ArkUI_SurfaceCallback* callback,void (*onSurfaceShow)(OH_ArkUI_SurfaceHolder* surfaceHolder))为此OH_ArkUI_SurfaceCallback实例设置Surface显示回调。
void OH_ArkUI_SurfaceCallback_SetSurfaceHideEvent(OH_ArkUI_SurfaceCallback* callback,void (*onSurfaceHide)(OH_ArkUI_SurfaceHolder* surfaceHolder))为此OH_ArkUI_SurfaceCallback实例设置Surface隐藏回调。

变量

名称描述
OH_XCOMPONENT_ID_LEN_MAX = 128ArkUI XComponent的id最大长度。
OH_MAX_TOUCH_POINTS_NUMBER = 10触摸事件中的可识别的触摸点个数最大值。
OH_NativeXComponent_TouchPoint::id = 0手指的唯一标识符。
OH_NativeXComponent_TouchPoint::screenX = 0.0触摸点相对于XComponent所在应用窗口左上角的x坐标。
OH_NativeXComponent_TouchPoint::screenY = 0.0触摸点相对于XComponent所在应用窗口左上角的y坐标。
OH_NativeXComponent_TouchPoint::x = 0.0触摸点相对于XComponent组件左边缘的x坐标。
OH_NativeXComponent_TouchPoint::y = 0.0触摸点相对于XComponent组件上边缘的y坐标。
OH_NativeXComponent_TouchPoint::type = OH_NativeXComponent_TouchEventType::OH_NATIVEXCOMPONENT_UNKNOWN触摸事件的触摸类型。
OH_NativeXComponent_TouchPoint::size = 0.0指垫和屏幕之间的接触面积。
OH_NativeXComponent_TouchPoint::force = 0.0当前触摸事件的压力。
OH_NativeXComponent_TouchPoint::timeStamp = 0当前触摸事件的时间戳。
OH_NativeXComponent_TouchPoint::isPressed = false当前点是否被按下。
OH_NativeXComponent_TouchEvent::id = 0手指的唯一标识符。
OH_NativeXComponent_TouchEvent::screenX = 0.0触摸点相对于XComponent所在应用窗口左上角的x坐标。
OH_NativeXComponent_TouchEvent::screenY = 0.0触摸点相对于XComponent所在应用窗口左上角的y坐标。
OH_NativeXComponent_TouchEvent::x = 0.0触摸点相对于XComponent组件左边缘的x坐标。
OH_NativeXComponent_TouchEvent::y = 0.0触摸点相对于XComponent组件上边缘的y坐标。
OH_NativeXComponent_TouchEvent::type = OH_NativeXComponent_TouchEventType::OH_NATIVEXCOMPONENT_UNKNOWN触摸事件的触摸类型。
OH_NativeXComponent_TouchEvent::size = 0.0指垫和屏幕之间的接触面积。
OH_NativeXComponent_TouchEvent::force = 0.0当前触摸事件的压力。
OH_NativeXComponent_TouchEvent::deviceId = 0产生当前触摸事件的设备的ID。
OH_NativeXComponent_TouchEvent::timeStamp = 0当前触摸事件的时间戳。
OH_NativeXComponent_TouchEvent::touchPoints [OH_MAX_TOUCH_POINTS_NUMBER]当前触摸点的数组。
OH_NativeXComponent_TouchEvent::numPoints = 0当前接触点的数量。
OH_NativeXComponent_MouseEvent::x = 0.0点击触点相对于当前组件左上角的x轴坐标。
OH_NativeXComponent_MouseEvent::y = 0.0点击触点相对于当前组件左上角的y轴坐标。
OH_NativeXComponent_MouseEvent::screenX = 0.0点击触点相对于屏幕左上角的x轴坐标。
OH_NativeXComponent_MouseEvent::screenY = 0.0点击触点相对于屏幕左上角的y轴坐标。
OH_NativeXComponent_MouseEvent::timestamp = 0当前鼠标事件的时间戳。
OH_NativeXComponent_MouseEvent::action = OH_NativeXComponent_MouseEventAction::OH_NATIVEXCOMPONENT_MOUSE_NONE当前鼠标事件动作。
OH_NativeXComponent_MouseEvent::button = OH_NativeXComponent_MouseEventButton::OH_NATIVEXCOMPONENT_NONE_BUTTON鼠标事件按键。
OH_NativeXComponent_Callback::OnSurfaceCreated创建Surface时调用。
OH_NativeXComponent_Callback::OnSurfaceChanged当Surface改变时调用。
OH_NativeXComponent_Callback::OnSurfaceDestroyed当Surface被销毁时调用。
OH_NativeXComponent_Callback::DispatchTouchEvent当触摸事件被触发时调用。
OH_NativeXComponent_MouseEvent_Callback::DispatchMouseEvent当鼠标事件被触发时调用。
OH_NativeXComponent_MouseEvent_Callback::DispatchHoverEvent当悬停事件被触发时调用。

类型定义说明

OH_NativeXComponent

typedef struct OH_NativeXComponent OH_NativeXComponent

描述:

提供封装的OH_NativeXComponent实例。

起始版本：

8

OH_NativeXComponent_Callback

typedef struct OH_NativeXComponent_Callback OH_NativeXComponent_Callback

描述:

注册Surface生命周期和触摸事件回调。

起始版本：

8

OH_NativeXComponent_KeyEvent

typedef struct OH_NativeXComponent_KeyEvent OH_NativeXComponent_KeyEvent

描述:

提供封装的OH_NativeXComponent_KeyEvent实例。

起始版本：

10

OH_NativeXComponent_MouseEvent_Callback

typedef struct OH_NativeXComponent_MouseEvent_Callback OH_NativeXComponent_MouseEvent_Callback

描述:

注册鼠标事件的回调。

起始版本：

9

OH_ArkUI_SurfaceCallback

typedef struct OH_ArkUI_SurfaceCallback OH_ArkUI_SurfaceCallback

描述：

定义Surface生命周期回调函数。

说明：

此类型的具体定义并不直接暴露。可调用OH_ArkUI_SurfaceCallback_Create接口以创建此类型实例，可调用OH_ArkUI_SurfaceCallback_Dispose接口以销毁此类型实例。

起始版本：

19

OH_ArkUI_SurfaceHolder

typedef struct OH_ArkUI_SurfaceHolder OH_ArkUI_SurfaceHolder

描述：

提供封装的OH_ArkUI_SurfaceHolder实例。

说明：

此类型的具体定义并不直接暴露。可调用OH_ArkUI_SurfaceHolder_Create接口以创建此类型实例，可调用OH_ArkUI_SurfaceHolder_Dispose接口以销毁此类型实例。

起始版本：

19

OHNativeWindow

typedef struct NativeWindow OHNativeWindow

描述：

提供封装的NativeWindow实例。

说明：

此类型的具体定义并不直接暴露。可调用OH_ArkUI_XComponent_GetNativeWindow接口以获取此类型实例

起始版本：

19

OH_NativeXComponent_ExtraMouseEventInfo

typedef struct OH_NativeXComponent_ExtraMouseEventInfo OH_NativeXComponent_ExtraMouseEventInfo

描述：

提供封装的扩展的鼠标事件信息实例。

说明：

此类型的具体定义并不直接暴露。可调用OH_NativeXComponent_GetMouseEventModifierKeyStates接口以获取该类型实例中的内容。

起始版本：

20

枚举类型说明

anonymous enum

anonymous enum

描述:

枚举API访问状态。

枚举值描述
OH_NATIVEXCOMPONENT_RESULT_SUCCESS成功结果。
OH_NATIVEXCOMPONENT_RESULT_FAILED失败结果。
OH_NATIVEXCOMPONENT_RESULT_BAD_PARAMETER无效参数。

起始版本：

8

OH_NativeXComponent_EventSourceType

enum OH_NativeXComponent_EventSourceType

描述:

触摸事件源类型。

枚举值描述
OH_NATIVEXCOMPONENT_SOURCE_TYPE_UNKNOWN未知的输入源类型。
OH_NATIVEXCOMPONENT_SOURCE_TYPE_MOUSE表示输入源生成鼠标多点触摸事件。
OH_NATIVEXCOMPONENT_SOURCE_TYPE_TOUCHSCREEN表示输入源生成一个触摸屏多点触摸事件。
OH_NATIVEXCOMPONENT_SOURCE_TYPE_TOUCHPAD表示输入源生成一个触摸板多点触摸事件。
OH_NATIVEXCOMPONENT_SOURCE_TYPE_JOYSTICK表示输入源生成一个操纵杆多点触摸事件。
OH_NATIVEXCOMPONENT_SOURCE_TYPE_KEYBOARD10+表示输入源生成一个键盘事件。

起始版本：

9

OH_NativeXComponent_KeyAction

enum OH_NativeXComponent_KeyAction

描述:

按键事件动作。

枚举值描述
OH_NATIVEXCOMPONENT_KEY_ACTION_UNKNOWN未知的按键动作。
OH_NATIVEXCOMPONENT_KEY_ACTION_DOWN按键按下动作。
OH_NATIVEXCOMPONENT_KEY_ACTION_UP按键抬起动作。

起始版本：

10

OH_NativeXComponent_KeyCode

enum OH_NativeXComponent_KeyCode

描述:

按键事件的键码。

枚举值描述
KEY_UNKNOWN未知按键
KEY_FN功能（Fn）键
KEY_HOME功能（Home）键
KEY_BACK返回键
KEY_MEDIA_PLAY_PAUSE多媒体键 播放/暂停
KEY_MEDIA_STOP多媒体键 停止
KEY_MEDIA_NEXT多媒体键 下一首
KEY_MEDIA_PREVIOUS多媒体键 上一首
KEY_MEDIA_REWIND多媒体键 快退
KEY_MEDIA_FAST_FORWARD多媒体键 快进
KEY_VOLUME_UP音量增加键
KEY_VOLUME_DOWN音量减小键
KEY_POWER电源键
KEY_CAMERA拍照键
KEY_VOLUME_MUTE扬声器静音键
KEY_MUTE话筒静音键
KEY_BRIGHTNESS_UP亮度调节按键 调亮
KEY_BRIGHTNESS_DOWN亮度调节按键 调暗
KEY_0按键'0'
KEY_1按键'1'
KEY_2按键'2'
KEY_3按键'3'
KEY_4按键'4'
KEY_5按键'5'
KEY_6按键'6'
KEY_7按键'7'
KEY_8按键'8'
KEY_9按键'9'
KEY_STAR按键'*'
KEY_POUND按键'#'
KEY_DPAD_UP导航键 向上
KEY_DPAD_DOWN导航键 向下
KEY_DPAD_LEFT导航键 向左
KEY_DPAD_RIGHT导航键 向右
KEY_DPAD_CENTER导航键 确定键
KEY_A按键'A'
KEY_B按键'B'
KEY_C按键'C'
KEY_D按键'D'
KEY_E按键'E'
KEY_F按键'F'
KEY_G按键'G'
KEY_H按键'H'
KEY_I按键'I'
KEY_J按键'J'
KEY_K按键'K'
KEY_L按键'L'
KEY_M按键'M'
KEY_N按键'N'
KEY_O按键'O'
KEY_P按键'P'
KEY_Q按键'Q'
KEY_R按键'R'
KEY_S按键'S'
KEY_T按键'T'
KEY_U按键'U'
KEY_V按键'V'
KEY_W按键'W'
KEY_X按键'X'
KEY_Y按键'Y'
KEY_Z按键'Z'
KEY_COMMA按键','
KEY_PERIOD按键'.'
KEY_ALT_LEFT左Alt键
KEY_ALT_RIGHT右Alt键
KEY_SHIFT_LEFT左Shift键
KEY_SHIFT_RIGHT右Shift键
KEY_TABTab键
KEY_SPACE空格键
KEY_SYM符号修改器按键
KEY_EXPLORER浏览器功能键，此键用于启动浏览器应用程序。
KEY_ENVELOPE电子邮件功能键，此键用于启动电子邮件应用程序。
KEY_ENTER回车键
KEY_DEL退格键
KEY_GRAVE按键'‘’
KEY_MINUS按键'-'
KEY_EQUALS按键'='
KEY_LEFT_BRACKET按键'['
KEY_RIGHT_BRACKET按键']'
KEY_BACKSLASH按键'\'
KEY_SEMICOLON按键';'
KEY_APOSTROPHE按键''' (单引号)
KEY_SLASH按键'/'
KEY_AT按键'@'
KEY_PLUS按键'+'
KEY_MENU菜单键
KEY_PAGE_UP向上翻页键
KEY_PAGE_DOWN向下翻页键
KEY_ESCAPEESC键
KEY_FORWARD_DEL删除键
KEY_CTRL_LEFT左Ctrl键
KEY_CTRL_RIGHT右Ctrl键
KEY_CAPS_LOCK大写锁定键
KEY_SCROLL_LOCK滚动锁定键
KEY_META_LEFT左元修改器键
KEY_META_RIGHT右元修改器键
KEY_FUNCTION功能键
KEY_SYSRQ系统请求/打印屏幕键
KEY_BREAKBreak/Pause键
KEY_MOVE_HOME光标移动到开始键
KEY_MOVE_END光标移动到末尾键
KEY_INSERT插入键
KEY_FORWARD前进键
KEY_MEDIA_PLAY多媒体键 播放
KEY_MEDIA_PAUSE多媒体键 暂停
KEY_MEDIA_CLOSE多媒体键 关闭
KEY_MEDIA_EJECT多媒体键 弹出
KEY_MEDIA_RECORD多媒体键 录音
KEY_F1按键'F1'
KEY_F2按键'F2'
KEY_F3按键'F3'
KEY_F4按键'F4'
KEY_F5按键'F5'
KEY_F6按键'F6'
KEY_F7按键'F7'
KEY_F8按键'F8'
KEY_F9按键'F9'
KEY_F10按键'F10'
KEY_F11按键'F11'
KEY_F12按键'F12'
KEY_NUM_LOCK小键盘锁
KEY_NUMPAD_0小键盘按键'0'
KEY_NUMPAD_1小键盘按键'1'
KEY_NUMPAD_2小键盘按键'2'
KEY_NUMPAD_3小键盘按键'3'
KEY_NUMPAD_4小键盘按键'4'
KEY_NUMPAD_5小键盘按键'5'
KEY_NUMPAD_6小键盘按键'6'
KEY_NUMPAD_7小键盘按键'7'
KEY_NUMPAD_8小键盘按键'8'
KEY_NUMPAD_9小键盘按键'9'
KEY_NUMPAD_DIVIDE小键盘按键'/'
KEY_NUMPAD_MULTIPLY小键盘按键'*'
KEY_NUMPAD_SUBTRACT小键盘按键'-'
KEY_NUMPAD_ADD小键盘按键'+'
KEY_NUMPAD_DOT小键盘按键'.'
KEY_NUMPAD_COMMA小键盘按键','
KEY_NUMPAD_ENTER小键盘按键回车
KEY_NUMPAD_EQUALS小键盘按键'='
KEY_NUMPAD_LEFT_PAREN小键盘按键'('
KEY_NUMPAD_RIGHT_PAREN小键盘按键')'
KEY_VIRTUAL_MULTITASK虚拟多任务键
KEY_SLEEP睡眠键
KEY_ZENKAKU_HANKAKU日文全宽/半宽键
KEY_102ND102nd按键
KEY_RO日文Ro键
KEY_KATAKANA日文片假名键
KEY_HIRAGANA日文平假名键
KEY_HENKAN日文转换键
KEY_KATAKANA_HIRAGANA日语片假名/平假名键
KEY_MUHENKAN日文非转换键
KEY_LINEFEED换行键
KEY_MACRO宏键
KEY_NUMPAD_PLUSMINUS数字键盘上的加号/减号键
KEY_SCALE扩展键
KEY_HANGUEL日文韩语键
KEY_HANJA日文汉语键
KEY_YEN日元键
KEY_STOP停止键
KEY_AGAIN重复键
KEY_PROPS道具键
KEY_UNDO撤消键
KEY_COPY复制键
KEY_OPEN打开键
KEY_PASTE粘贴键
KEY_FIND查找键
KEY_CUT剪切键
KEY_HELP帮助键
KEY_CALC计算器特殊功能键，用于启动计算器应用程序
KEY_FILE文件按键
KEY_BOOKMARKS书签键
KEY_NEXT下一个按键
KEY_PLAYPAUSE播放/暂停键
KEY_PREVIOUS上一个按键
KEY_STOPCDCD停止键
KEY_CONFIG配置键
KEY_REFRESH刷新键
KEY_EXIT退出键
KEY_EDIT编辑键
KEY_SCROLLUP向上滚动键
KEY_SCROLLDOWN向下滚动键
KEY_NEW新建键
KEY_REDO恢复键
KEY_CLOSE关闭键
KEY_PLAY播放键
KEY_BASSBOOST低音增强键
KEY_PRINT打印键
KEY_CHAT聊天键
KEY_FINANCE金融键
KEY_CANCEL取消键
KEY_KBDILLUM_TOGGLE键盘灯光切换键
KEY_KBDILLUM_DOWN键盘灯光调亮键
KEY_KBDILLUM_UP键盘灯光调暗键
KEY_SEND发送键
KEY_REPLY答复键
KEY_FORWARDMAIL邮件转发键
KEY_SAVE保存键
KEY_DOCUMENTS文件键
KEY_VIDEO_NEXT下一个视频键
KEY_VIDEO_PREV上一个视频键
KEY_BRIGHTNESS_CYCLE背光渐变键
KEY_BRIGHTNESS_ZERO亮度调节为0键
KEY_DISPLAY_OFF显示关闭键
KEY_BTN_MISC游戏手柄上的各种按键
KEY_GOTO进入键
KEY_INFO信息查看键
KEY_PROGRAM程序键
KEY_PVR个人录像机(PVR)键
KEY_SUBTITLE字幕键
KEY_FULL_SCREEN全屏键
KEY_KEYBOARD键盘
KEY_ASPECT_RATIO屏幕纵横比调节键
KEY_PC端口控制键
KEY_TVTV键
KEY_TV2TV键2
KEY_VCR录像机开启键
KEY_VCR2录像机开启键2
KEY_SATSIM卡应用工具包（SAT）键
KEY_CDCD键
KEY_TAPE磁带键
KEY_TUNER调谐器键
KEY_PLAYER播放器键
KEY_DVDDVD键
KEY_AUDIO音频键
KEY_VIDEO视频键
KEY_MEMO备忘录键
KEY_CALENDAR日历键
KEY_RED红色指示器
KEY_GREEN绿色指示器
KEY_YELLOW黄色指示器
KEY_BLUE蓝色指示器
KEY_CHANNELUP频道向上键
KEY_CHANNELDOWN频道向下键
KEY_LAST末尾键
KEY_RESTART重启键
KEY_SLOW慢速键
KEY_SHUFFLE随机播放键
KEY_VIDEOPHONE可视电话键
KEY_GAMES游戏键
KEY_ZOOMIN放大键
KEY_ZOOMOUT缩小键
KEY_ZOOMRESET缩放重置键
KEY_WORDPROCESSOR文字处理键
KEY_EDITOR编辑器键
KEY_SPREADSHEET电子表格键
KEY_GRAPHICSEDITOR图形编辑器键
KEY_PRESENTATION演示文稿键
KEY_DATABASE数据库键标
KEY_NEWS新闻键
KEY_VOICEMAIL语音信箱
KEY_ADDRESSBOOK通讯簿
KEY_MESSENGER通信键
KEY_BRIGHTNESS_TOGGLE亮度切换键
KEY_SPELLCHECKAL拼写检查
KEY_COFFEE终端锁/屏幕保护程序
KEY_MEDIA_REPEAT媒体循环键
KEY_IMAGES图像键
KEY_BUTTONCONFIG按键配置键
KEY_TASKMANAGER任务管理器
KEY_JOURNAL日志按键
KEY_CONTROLPANEL控制面板键
KEY_APPSELECT应用程序选择键
KEY_SCREENSAVER屏幕保护程序键
KEY_ASSISTANT辅助键
KEY_KBD_LAYOUT_NEXT下一个键盘布局键
KEY_BRIGHTNESS_MIN最小亮度键
KEY_BRIGHTNESS_MAX最大亮度键
KEY_KBDINPUTASSIST_PREV键盘输入Assist_Previous
KEY_KBDINPUTASSIST_NEXT键盘输入Assist_Next
KEY_KBDINPUTASSIST_PREVGROUP键盘输入Assist_Previous
KEY_KBDINPUTASSIST_NEXTGROUP键盘输入Assist_Next
KEY_KBDINPUTASSIST_ACCEPT键盘输入Assist_Accept
KEY_KBDINPUTASSIST_CANCEL键盘输入Assist_Cancel
KEY_FRONT挡风玻璃除雾器开关
KEY_SETUP设置键
KEY_WAKEUP唤醒键
KEY_SENDFILE发送文件按键
KEY_DELETEFILE删除文件按键
KEY_XFER文件传输(XFER)按键
KEY_PROG1程序键1
KEY_PROG2程序键2
KEY_MSDOSMS-DOS键（微软磁盘操作系统
KEY_SCREENLOCK屏幕锁定键
KEY_DIRECTION_ROTATE_DISPLAY方向旋转显示键
KEY_CYCLEWINDOWSWindows循环键
KEY_COMPUTER按键
KEY_EJECTCLOSECD弹出CD键
KEY_ISOISO键
KEY_MOVE移动键
KEY_F13按键'F13'
KEY_F14按键'F14'
KEY_F15按键'F15'
KEY_F16按键'F16'
KEY_F17按键'F17'
KEY_F18按键'F18'
KEY_F19按键'F19'
KEY_F20按键'F20'
KEY_F21按键'F21'
KEY_F22按键'F22'
KEY_F23按键'F23'
KEY_F24按键'F24'
KEY_PROG3程序键3
KEY_PROG4程序键4
KEY_DASHBOARD仪表板
KEY_SUSPEND挂起键
KEY_HP高阶路径键
KEY_SOUND音量键
KEY_QUESTION疑问按键
KEY_CONNECT连接键
KEY_SPORT运动按键
KEY_SHOP商城键
KEY_ALTERASE交替键
KEY_SWITCHVIDEOMODE在可用视频之间循环输出（监视器/LCD/TV输出/等）
KEY_BATTERY电池按键
KEY_BLUETOOTH蓝牙按键
KEY_WLAN无线局域网
KEY_UWB超宽带（UWB）
KEY_WWAN_WIMAXWWAN WiMAX按键
KEY_RFKILL控制所有收音机的键
KEY_CHANNEL向上频道键
KEY_BTN_0按键0
KEY_BTN_1按键1
KEY_BTN_2按键2
KEY_BTN_3按键3
KEY_BTN_4按键4
KEY_BTN_5按键5
KEY_BTN_6按键6
KEY_BTN_7按键7
KEY_BTN_8按键8
KEY_BTN_9按键9

起始版本：

10

OH_NativeXComponent_MouseEventAction

enum OH_NativeXComponent_MouseEventAction

描述:

鼠标事件动作。

枚举值描述
OH_NATIVEXCOMPONENT_MOUSE_NONE无效鼠标事件。
OH_NATIVEXCOMPONENT_MOUSE_PRESS鼠标按键按下时触发鼠标事件。
OH_NATIVEXCOMPONENT_MOUSE_RELEASE鼠标按键松开时触发鼠标事件。
OH_NATIVEXCOMPONENT_MOUSE_MOVE鼠标在屏幕上移动时触发鼠标事件。
OH_NATIVEXCOMPONENT_MOUSE_CANCEL鼠标按键被取消时触发鼠标事件。
起始版本： 18

起始版本：

9

OH_NativeXComponent_MouseEventButton

enum OH_NativeXComponent_MouseEventButton

描述:

鼠标事件按键。

枚举值描述
OH_NATIVEXCOMPONENT_NONE_BUTTON鼠标无按键操作时触发鼠标事件。
OH_NATIVEXCOMPONENT_LEFT_BUTTON按下鼠标左键时触发鼠标事件。
OH_NATIVEXCOMPONENT_RIGHT_BUTTON按下鼠标右键时触发鼠标事件。
OH_NATIVEXCOMPONENT_MIDDLE_BUTTON按下鼠标中键时触发鼠标事件。
OH_NATIVEXCOMPONENT_BACK_BUTTON按下鼠标左侧后退键时触发鼠标事件。
OH_NATIVEXCOMPONENT_FORWARD_BUTTON按下鼠标左侧前进键时触发鼠标事件。

起始版本：

9

OH_NativeXComponent_TouchEventType

enum OH_NativeXComponent_TouchEventType

描述:

触摸事件类型。

枚举值描述
OH_NATIVEXCOMPONENT_DOWN手指按下时触发触摸事件。
OH_NATIVEXCOMPONENT_UP手指抬起时触发触摸事件。
OH_NATIVEXCOMPONENT_MOVE手指按下状态下在屏幕上移动时触发触摸事件。
OH_NATIVEXCOMPONENT_CANCEL触摸事件取消时触发事件。
OH_NATIVEXCOMPONENT_UNKNOWN无效的触摸类型。

起始版本：

8

OH_NativeXComponent_TouchPointToolType

enum OH_NativeXComponent_TouchPointToolType

描述:

触摸点工具类型。

枚举值描述
OH_NATIVEXCOMPONENT_TOOL_TYPE_UNKNOWN未识别工具类型。
OH_NATIVEXCOMPONENT_TOOL_TYPE_FINGER表示用手指。
OH_NATIVEXCOMPONENT_TOOL_TYPE_PEN表示用触笔。
OH_NATIVEXCOMPONENT_TOOL_TYPE_RUBBER表示用橡皮擦。
OH_NATIVEXCOMPONENT_TOOL_TYPE_BRUSH表示用画笔。
OH_NATIVEXCOMPONENT_TOOL_TYPE_PENCIL表示用铅笔。
OH_NATIVEXCOMPONENT_TOOL_TYPE_AIRBRUSH表示用气笔。
OH_NATIVEXCOMPONENT_TOOL_TYPE_MOUSE表示用鼠标。
OH_NATIVEXCOMPONENT_TOOL_TYPE_LENS表示用晶状体。

起始版本：

9

ArkUI_XComponent_ImageAnalyzerState

enum ArkUI_XComponent_ImageAnalyzerState

描述

XComponent图像AI分析状态码。

枚举值描述
ARKUI_XCOMPONENT_AI_ANALYSIS_FINISHED图像AI分析完成。
ARKUI_XCOMPONENT_AI_ANALYSIS_DISABLED图像AI分析已禁用。
ARKUI_XCOMPONENT_AI_ANALYSIS_UNSUPPORTED设备不支持图像AI分析。
ARKUI_XCOMPONENT_AI_ANALYSIS_ONGOING图像AI分析进行中。
ARKUI_XCOMPONENT_AI_ANALYSIS_STOPPED图像AI分析停止。

起始版本：

18

函数说明

OH_NativeXComponent_AttachNativeRootNode()

int32_t OH_NativeXComponent_AttachNativeRootNode (OH_NativeXComponent * component, ArkUI_NodeHandle root )

描述：

将通过ArkUI的Native接口创建出来的UI组件挂载到当前XComponent上。

起始版本： 12

参数:

名称描述
component表示指向OH_NativeXComponent实例的指针。
root表示指向Native接口创建的组件实例的指针。

返回：

0：成功。

-2：参数异常。

OH_NativeXComponent_DetachNativeRootNode()

int32_t OH_NativeXComponent_DetachNativeRootNode (OH_NativeXComponent * component, ArkUI_NodeHandle root )

描述：

将ArkUI的Native组件从当前XComponent上卸载。

起始版本： 12

参数:

名称描述
component表示指向OH_NativeXComponent实例的指针。
root表示指向Native接口创建的组件实例的指针。

返回：

0：成功。

-2：参数异常。

OH_NativeXComponent_GetKeyEvent()

int32_t OH_NativeXComponent_GetKeyEvent (OH_NativeXComponent * component, OH_NativeXComponent_KeyEvent ** keyEvent )

描述:

获取ArkUI XComponent调度的按键事件。

参数:

名称描述
component表示指向OH_NativeXComponent实例的指针。
keyEvent表示指向当前按键事件指针的指针。

返回:

返回执行的状态代码。

起始版本：

10

OH_NativeXComponent_GetKeyEventAction()

int32_t OH_NativeXComponent_GetKeyEventAction (OH_NativeXComponent_KeyEvent * keyEvent, OH_NativeXComponent_KeyAction * action )

描述:

获取传入按键事件的动作。

参数:

名称描述
keyEvent表示指向OH_NativeXComponent_KeyEvent实例的指针。
action表示指向按键事件动作的指针。

返回:

返回执行的状态代码。

起始版本：

10

OH_NativeXComponent_GetKeyEventCode()

int32_t OH_NativeXComponent_GetKeyEventCode (OH_NativeXComponent_KeyEvent * keyEvent, OH_NativeXComponent_KeyCode * code )

描述:

获取传入按键事件的按键码。

参数:

名称描述
keyEvent表示指向OH_NativeXComponent_KeyEvent实例的指针。
code表示指向按键事件按键码的指针。

返回:

返回执行的状态代码。

起始版本：

10

OH_NativeXComponent_GetKeyEventDeviceId()

int32_t OH_NativeXComponent_GetKeyEventDeviceId (OH_NativeXComponent_KeyEvent * keyEvent, int64_t * deviceId )

描述:

获取传入按键事件的设备id。

参数:

名称描述
keyEvent表示指向OH_NativeXComponent_KeyEvent实例的指针。
deviceId表示指向按键事件设备id的指针。

返回:

返回执行的状态代码。

起始版本：

10

OH_NativeXComponent_GetKeyEventSourceType()

int32_t OH_NativeXComponent_GetKeyEventSourceType (OH_NativeXComponent_KeyEvent * keyEvent, OH_NativeXComponent_EventSourceType * sourceType )

描述:

获取传入按键事件的事件源类型。

参数:

名称描述
keyEvent表示指向OH_NativeXComponent_KeyEvent实例的指针。
sourceType表示指向按键事件事件源类型的指针。

返回:

返回执行的状态代码。

起始版本：

10

OH_NativeXComponent_GetKeyEventTimestamp()

int32_t OH_NativeXComponent_GetKeyEventTimestamp (OH_NativeXComponent_KeyEvent * keyEvent, int64_t * timeStamp )

描述:

获取传入按键事件的时间戳。

参数:

名称描述
keyEvent表示指向OH_NativeXComponent_KeyEvent实例的指针。
timeStamp表示指向按键事件时间戳的指针。

返回:

返回执行的状态代码。

起始版本：

10

OH_NativeXComponent_GetMouseEvent()

int32_t OH_NativeXComponent_GetMouseEvent (OH_NativeXComponent * component, const void * window, OH_NativeXComponent_MouseEvent * mouseEvent )

描述:

获取ArkUI XComponent调度的鼠标事件。

参数:

名称描述
component表示指向OH_NativeXComponent实例的指针。
window表示NativeWindow句柄。
mouseEvent表示指向当前鼠标事件的指针。

返回:

返回执行的状态代码。

起始版本：

9

OH_NativeXComponent_GetNativeXComponent()

OH_NativeXComponent* OH_NativeXComponent_GetNativeXComponent (ArkUI_NodeHandle node)

描述：

基于Native接口创建的组件实例获取OH_NativeXComponent类型的指针。

起始版本： 12

参数:

名称描述
node指向Native接口创建的组件实例的指针。

返回：

表示指向OH_NativeXComponent实例的指针。

OH_NativeXComponent_GetTouchEvent()

int32_t OH_NativeXComponent_GetTouchEvent (OH_NativeXComponent * component, const void * window, OH_NativeXComponent_TouchEvent * touchEvent )

描述:

获取ArkUI XComponent调度的触摸事件。

参数:

名称描述
component表示指向OH_NativeXComponent实例的指针。
window表示NativeWindow句柄。
touchEvent表示指向当前触摸事件的指针。

返回:

返回执行的状态代码。

起始版本：

8

OH_NativeXComponent_GetTouchPointTiltX()

int32_t OH_NativeXComponent_GetTouchPointTiltX (OH_NativeXComponent * component, uint32_t pointIndex, float * tiltX )

描述:

获取ArkUI XComponent触摸点倾斜与X轴角度。

参数:

名称描述
component表示指向OH_NativeXComponent实例的指针。
pointIndex表示触摸点的指针索引。
tiltX表示指向X倾斜度的指针。

返回:

返回执行的状态代码。

起始版本：

9

OH_NativeXComponent_GetTouchPointTiltY()

int32_t OH_NativeXComponent_GetTouchPointTiltY (OH_NativeXComponent * component, uint32_t pointIndex, float * tiltY )

描述:

获取ArkUI XComponent触摸点倾斜与Y轴角度。

参数:

名称描述
component表示指向OH_NativeXComponent实例的指针。
pointIndex表示触摸点的指针索引。
tiltY表示指向Y倾斜度的指针。

返回:

返回执行的状态代码。

起始版本：

9

OH_NativeXComponent_GetTouchPointWindowX()

int32_t OH_NativeXComponent_GetTouchPointWindowX(OH_NativeXComponent * component, uint32_t pointIndex, float * windowX )

描述:

获取ArkUI XComponent触摸点相对于应用窗口左上角的X坐标。

参数:

名称描述
component表示指向OH_NativeXComponent实例的指针。
pointIndex表示触摸点的指针索引。
windowX表示指向触摸点相对于应用窗口左上角的X坐标的指针。

返回:

返回执行的状态代码。

起始版本：

12

OH_NativeXComponent_GetTouchPointWindowY()

int32_t OH_NativeXComponent_GetTouchPointWindowY(OH_NativeXComponent * component, uint32_t pointIndex, float * windowY )

描述:

获取ArkUI XComponent触摸点相对于应用窗口左上角的Y坐标。

参数:

名称描述
component表示指向OH_NativeXComponent实例的指针。
pointIndex表示触摸点的指针索引。
windowY表示指向触摸点相对于应用窗口左上角的Y坐标的指针。

返回:

返回执行的状态代码。

起始版本：

12

OH_NativeXComponent_GetTouchPointDisplayX()

int32_t OH_NativeXComponent_GetTouchPointDisplayX(OH_NativeXComponent * component, uint32_t pointIndex, float * displayX )

描述:

获取ArkUI XComponent触摸点相对于应用所在屏幕左上角的X坐标。

参数:

名称描述
component表示指向OH_NativeXComponent实例的指针。
pointIndex表示触摸点的指针索引。
displayX表示指向触摸点相对于应用所在屏幕左上角的X坐标的指针。

返回:

返回执行的状态代码。

起始版本：

12

OH_NativeXComponent_GetTouchPointDisplayY()

int32_t OH_NativeXComponent_GetTouchPointDisplayY(OH_NativeXComponent * component, uint32_t pointIndex, float * displayY )

描述:

获取ArkUI XComponent触摸点相对于应用所在屏幕左上角的Y坐标。

参数:

名称描述
component表示指向OH_NativeXComponent实例的指针。
pointIndex表示触摸点的指针索引。
displayY表示指向触摸点相对于应用所在屏幕左上角的Y坐标的指针。

返回:

返回执行的状态代码。

起始版本：

12

OH_NativeXComponent_GetTouchPointToolType()

int32_t OH_NativeXComponent_GetTouchPointToolType (OH_NativeXComponent * component, uint32_t pointIndex, OH_NativeXComponent_TouchPointToolType * toolType )

描述:

获取ArkUI XComponent触摸点工具类型。

参数:

名称描述
component表示指向OH_NativeXComponent实例的指针。
pointIndex表示触摸点的指针索引。
toolType表示指向工具类型的指针。

返回:

返回执行的状态代码。

起始版本：

9

OH_NativeXComponent_GetXComponentId()

int32_t OH_NativeXComponent_GetXComponentId (OH_NativeXComponent * component, char * id, uint64_t * size )

描述:

获取ArkUI XComponent的id。

参数:

名称描述
component表示指向OH_NativeXComponent实例的指针。
id表示用于保存此OH_NativeXComponent实例的ID的字符缓冲区。 请注意，空终止符将附加到字符缓冲区，因此字符缓冲区的大小应至少比真实id长度大一个单位。 建议字符缓冲区的大小为[OH_XCOMPONENT_ID_LEN_MAX + 1]。
size表示指向id长度的指针，用于接收id的长度信息。

返回:

返回执行的状态代码。

起始版本：

8

OH_NativeXComponent_GetXComponentOffset()

int32_t OH_NativeXComponent_GetXComponentOffset (OH_NativeXComponent * component, const void * window, double * x, double * y )

描述:

获取ArkUI XComponent持有的Surface相对其父组件左顶点的偏移量。

参数:

名称描述
component表示指向OH_NativeXComponent实例的指针。
window表示NativeWindow句柄。
x表示指向当前Surface相对于XComponent父组件左顶点x坐标的指针。
y表示指向当前Surface相对于XComponent父组件左顶点y坐标的指针。

返回:

返回执行的状态代码。

起始版本：

8

OH_NativeXComponent_GetXComponentSize()

int32_t OH_NativeXComponent_GetXComponentSize (OH_NativeXComponent * component, const void * window, uint64_t * width, uint64_t * height )

描述:

获取ArkUI XComponent持有的Surface的大小。

参数:

名称描述
component表示指向OH_NativeXComponent实例的指针。
window表示NativeWindow句柄。
width表示指向当前Surface宽度的指针。
height表示指向当前Surface高度的指针。

返回:

返回执行的状态代码。

起始版本：

8

OH_NativeXComponent_RegisterBlurEventCallback()

int32_t OH_NativeXComponent_RegisterBlurEventCallback (OH_NativeXComponent * component, void(*callback)(OH_NativeXComponent *component, void *window))

描述:

为此OH_NativeXComponent实例注册失焦事件回调。

参数:

名称描述
component表示指向OH_NativeXComponent实例的指针。
callback表示指向失焦事件回调的指针。
- window: 表示NativeWindow句柄。

返回:

返回执行的状态代码。

起始版本：

10

OH_NativeXComponent_RegisterCallback()

int32_t OH_NativeXComponent_RegisterCallback (OH_NativeXComponent * component, OH_NativeXComponent_Callback * callback )

描述:

为此OH_NativeXComponent实例注册回调。

参数:

名称描述
component表示指向OH_NativeXComponent实例的指针。
callback表示指向Surface生命周期和触摸事件回调的指针。

返回:

返回执行的状态代码。

起始版本：

8

OH_NativeXComponent_RegisterFocusEventCallback()

int32_t OH_NativeXComponent_RegisterFocusEventCallback (OH_NativeXComponent * component, void(*callback)(OH_NativeXComponent *component, void *window))

描述:

为此OH_NativeXComponent实例注册获焦事件回调。

参数:

名称描述
component表示指向OH_NativeXComponent实例的指针。
callback表示指向获焦事件回调的指针。
- window: 表示NativeWindow句柄。

返回:

返回执行的状态代码。

起始版本：

10

OH_NativeXComponent_RegisterKeyEventCallback()

int32_t OH_NativeXComponent_RegisterKeyEventCallback (OH_NativeXComponent * component, void(*callback)(OH_NativeXComponent *component, void *window))

描述:

为此OH_NativeXComponent实例注册按键事件回调。

参数:

名称描述
component表示指向OH_NativeXComponent实例的指针。
callback表示指向按键事件回调的指针。
- window: 表示NativeWindow句柄。

返回:

返回执行的状态代码。

起始版本：

10

OH_NativeXComponent_RegisterKeyEventCallbackWithResult()

int32_t OH_NativeXComponent_RegisterKeyEventCallbackWithResult (OH_NativeXComponent * component, bool(*callback)(OH_NativeXComponent *component, void *window))

描述:

为此OH_NativeXComponent实例注册带有返回值的按键事件回调。通过此接口注册的按键事件回调都必须返回一个结果，即true或false。当返回值为true时，该事件将不会继续分发；当返回值为false时，该事件将按照事件处理流程继续分发。

参数:

名称描述
component表示指向OH_NativeXComponent实例的指针。
callback表示指向按键事件回调的指针。
- window: 表示NativeWindow句柄。

返回:

返回执行的状态代码。

起始版本：

14

OH_NativeXComponent_RegisterMouseEventCallback()

int32_t OH_NativeXComponent_RegisterMouseEventCallback (OH_NativeXComponent * component, OH_NativeXComponent_MouseEvent_Callback * callback )

描述:

为此OH_NativeXComponent实例注册鼠标事件回调。

参数:

名称描述
component表示指向OH_NativeXComponent实例的指针。
callback表示指向鼠标事件回调的指针。

返回:

返回执行的状态代码。

起始版本：

9

OH_NativeXComponent_RegisterOnFrameCallback()

int32_t OH_NativeXComponent_RegisterOnFrameCallback (OH_NativeXComponent* component, void (*callback)(OH_NativeXComponent *component, uint64_t timestamp, uint64_t targetTimestamp))

描述：

为此OH_NativeXComponent实例注册显示更新回调，并使能每帧回调此函数。

参数:

名称描述
component表示指向OH_NativeXComponent实例的指针。
callback表示指向显示更新回调的指针。
- timestamp: 当前帧到达的时间（单位：纳秒）。
- targetTimestamp: 下一帧预期到达的时间（单位：纳秒）。

返回：

返回执行的状态代码。

起始版本：

11

OH_NativeXComponent_RegisterOnTouchInterceptCallback()

int32_t OH_NativeXComponent_RegisterOnTouchInterceptCallback (OH_NativeXComponent * component, HitTestMode(*callback)(OH_NativeXComponent *component, ArkUI_UIInputEvent *event))

描述：

为此OH_NativeXComponent实例注册自定义事件拦截回调，并使能在做触摸测试时回调此函数。 通过该回调获取到的事件对象不支持UIInput相关信息操作接口，建议切换为通过注册native node上的NODE_ON_TOUCH_INTERCEPT通用事件来支持。

起始版本： 12

参数:

名称描述
component表示指向OH_NativeXComponent实例的指针。
callback表示指向自定义事件拦截回调的指针。
- event: 表示指向UI输入事件的指针。

返回：

0 - 成功。 401 - 参数异常。

OH_NativeXComponent_RegisterUIInputEventCallback()

int32_t OH_NativeXComponent_RegisterUIInputEventCallback (OH_NativeXComponent * component, void(*callback)(OH_NativeXComponent *component, ArkUI_UIInputEvent *event, ArkUI_UIInputEvent_Type type), ArkUI_UIInputEvent_Type type )

描述：

为此OH_NativeXComponent实例注册UI输入事件回调，并使能收到UI输入事件时回调此函数。当前仅支持轴事件。

起始版本： 12

参数:

名称描述
component表示指向OH_NativeXComponent实例的指针。
callback表示指向UI输入事件回调的指针。
- event: 表示指向UI输入事件的指针。
type表示当前UI输入事件的类型。

返回：

返回执行的状态代码。

OH_NativeXComponent_SetExpectedFrameRateRange()

int32_t OH_NativeXComponent_SetExpectedFrameRateRange (OH_NativeXComponent * component, OH_NativeXComponent_ExpectedRateRange * range )

描述：

设置期望帧率范围。

参数:

名称描述
component表示指向OH_NativeXComponent实例的指针。
range表示指向期望帧率范围的指针。

返回：

返回执行的状态代码。

起始版本：

11

OH_NativeXComponent_UnregisterOnFrameCallback()

int32_t OH_NativeXComponent_UnregisterOnFrameCallback (OH_NativeXComponent * component)

描述：

为此OH_NativeXComponent实例取消注册回调函数，并关闭每帧回调此函数。

参数:

名称描述
component表示指向OH_NativeXComponent实例的指针。

返回：

返回执行的状态代码。

起始版本：

11

OH_NativeXComponent_SetNeedSoftKeyboard()

int32_t OH_NativeXComponent_SetNeedSoftKeyboard(OH_NativeXComponent* component, bool isNeedSoftKeyboard)

描述：

为此OH_NativeXComponent实例设置是否需要软键盘。

参数:

名称描述
component表示指向OH_NativeXComponent实例的指针。
isNeedSoftKeyboard表示此OH_NativeXComponent实例是否需要软键盘。

返回：

返回执行的状态代码。

起始版本：

12

OH_NativeXComponent_RegisterSurfaceShowCallback()

int32_t OH_NativeXComponent_RegisterSurfaceShowCallback (OH_NativeXComponent * component, void(*callback)(OH_NativeXComponent *component, void *window))

描述:

为此OH_NativeXComponent实例注册Surface显示回调，该回调在应用窗口已经从后台回到前台时触发。

参数:

名称描述
component表示指向OH_NativeXComponent实例的指针。
callback表示指向Surface显示回调的指针。
- window: 表示NativeWindow句柄。

返回:

返回执行的状态代码。

起始版本：

12

OH_NativeXComponent_RegisterSurfaceHideCallback()

int32_t OH_NativeXComponent_RegisterSurfaceHideCallback (OH_NativeXComponent * component, void(*callback)(OH_NativeXComponent *component, void *window))

描述:

为此OH_NativeXComponent实例注册Surface隐藏回调，该回调在应用窗口已经从前台进入后台时触发。

参数:

名称描述
component表示指向OH_NativeXComponent实例的指针。
callback指示指向surface隐藏回调的指针。
- window: 表示NativeWindow句柄。

返回:

返回执行的状态代码。

起始版本：

12

OH_NativeXComponent_GetTouchEventSourceType()

int32_t OH_NativeXComponent_GetTouchEventSourceType (OH_NativeXComponent* component, int32_t pointId, OH_NativeXComponent_EventSourceType* sourceType)

描述:

获取ArkUI XComponent触摸事件的输入设备类型。

参数:

名称描述
component表示指向OH_NativeXComponent实例的指针。
pointId表示触摸点的id。
说明：
仅当传入的id为触发该touch事件的触点id时，可正确返回输入设备类型，否则返回OH_NATIVEXCOMPONENT_RESULT_BAD_PARAMETER。
sourceType表示指向返回设备类型的指针。

返回:

OH_NATIVEXCOMPONENT_RESULT_SUCCESS - 成功。

OH_NATIVEXCOMPONENT_RESULT_BAD_PARAMETER - 参数异常。

OH_NATIVEXCOMPONENT_RESULT_FAILED - 其他错误。

起始版本：

12

OH_NativeXComponent_GetNativeAccessibilityProvider()

int32_t OH_NativeXComponent_GetNativeAccessibilityProvider(
    OH_NativeXComponent* component, ArkUI_AccessibilityProvider** handle)

描述:

获取ArkUI XComponent无障碍接入句柄指针。

参数:

名称描述
component表示指向OH_NativeXComponent实例的指针。
handle表示指向ArkUI_AccessibilityProvider实例的指针。

返回:

OH_NATIVEXCOMPONENT_RESULT_SUCCESS - 成功。

OH_NATIVEXCOMPONENT_RESULT_BAD_PARAMETER - 参数异常。

OH_NATIVEXCOMPONENT_RESULT_FAILED - 其他错误。

起始版本：

13

OH_ArkUI_XComponent_StartImageAnalyzer()

int32_t OH_ArkUI_XComponent_StartImageAnalyzer(ArkUI_NodeHandle node, void* userData,
    void (*callback)(ArkUI_NodeHandle node, ArkUI_XComponent_ImageAnalyzerState statusCode, void* userData))

描述：

为此XComponent组件实例开始图像AI分析，使用前需先使能图像AI分析能力。

起始版本：

18

参数：

名称描述
node表示XComponent组件实例。
userData表示开发者需要在回调函数执行时获取的数据的指针。
callback表示图像AI分析状态刷新时触发的回调函数。
- statusCode: 回调函数的入参之一，表示当前的图像分析状态。

说明：

该接口发起的图像AI分析过程为异步执行，接口返回后，并不代表图像AI分析已经产生分析内容。

该方法调用时，将截取调用时刻的画面帧进行分析，使用时需注意启动分析的时机，以避免出现画面和分析内容不一致的情况。

图像AI分析状态刷新时，将会触发传入的回调函数。

返回：

ARKUI_ERROR_CODE_NO_ERROR - 执行成功。

ARKUI_ERROR_CODE_PARAM_INVALID - 传入参数异常。

OH_ArkUI_XComponent_StopImageAnalyzer()

int32_t OH_ArkUI_XComponent_StopImageAnalyzer(ArkUI_NodeHandle node)

描述：

为此XComponent组件实例停止图像AI分析。

起始版本：

18

参数：

名称描述
node表示XComponent组件实例。

说明：

停止图像AI分析功能后，图像AI分析展示的内容将被销毁。

返回：

ARKUI_ERROR_CODE_NO_ERROR - 执行成功。

ARKUI_ERROR_CODE_PARAM_INVALID - 传入参数异常。

OH_ArkUI_SurfaceCallback_Create()

OH_ArkUI_SurfaceCallback* OH_ArkUI_SurfaceCallback_Create()

描述：

创建OH_ArkUI_SurfaceCallback对象。

起始版本：

19

返回：

返回创建的OH_ArkUI_SurfaceCallback对象的指针。

OH_ArkUI_SurfaceCallback_Dispose()

void OH_ArkUI_SurfaceCallback_Dispose(OH_ArkUI_SurfaceCallback* callback)

描述：

销毁OH_ArkUI_SurfaceCallback对象。

起始版本：

19

参数:

名称描述
callback表示指向需要销毁的OH_ArkUI_SurfaceCallback对象的指针。

OH_ArkUI_SurfaceHolder_Create()

OH_ArkUI_SurfaceHolder* OH_ArkUI_SurfaceHolder_Create(ArkUI_NodeHandle node)

描述：

创建XComponent组件的OH_ArkUI_SurfaceHolder对象。

起始版本：

19

参数:

名称描述
node表示指向Native接口创建的XComponent组件实例的指针。

返回：

返回被创建的OH_ArkUI_SurfaceHolder对象的指针。

OH_ArkUI_SurfaceHolder_Dispose()

void OH_ArkUI_SurfaceHolder_Dispose(OH_ArkUI_SurfaceHolder* surfaceHolder)

描述：

销毁OH_ArkUI_SurfaceHolder对象。

起始版本：

19

参数:

名称描述
surfaceHolder表示指向需要销毁的OH_ArkUI_SurfaceHolder实例的指针。

OH_ArkUI_SurfaceHolder_SetUserData()

int32_t OH_ArkUI_SurfaceHolder_SetUserData(OH_ArkUI_SurfaceHolder* surfaceHolder, void* userData)

描述：

向OH_ArkUI_SurfaceHolder实例存储自定义数据。

起始版本：

19

参数:

名称描述
surfaceHolder表示指向存储自定义数据的OH_ArkUI_SurfaceHolder实例的指针。
userData表示指向要存储的自定义数据的指针。

返回：

ARKUI_ERROR_CODE_NO_ERROR - 执行成功。

ARKUI_ERROR_CODE_PARAM_INVALID - 传入参数异常。

OH_ArkUI_SurfaceHolder_GetUserData()

void* OH_ArkUI_SurfaceHolder_GetUserData(OH_ArkUI_SurfaceHolder* surfaceHolder);

描述：

获取OH_ArkUI_SurfaceHolder实例存储的自定义数据。

起始版本：

19

参数:

名称描述
surfaceHolder表示指向存储自定义数据的OH_ArkUI_SurfaceHolder实例的指针。

返回：

返回自定义数据。

OH_ArkUI_SurfaceCallback_SetSurfaceCreatedEvent()

void OH_ArkUI_SurfaceCallback_SetSurfaceCreatedEvent(OH_ArkUI_SurfaceCallback* callback, void (*onSurfaceCreated)(OH_ArkUI_SurfaceHolder* surfaceHolder))

描述：

设置Surface生命周期回调中的创建回调事件。

起始版本：

19

参数:

名称描述
callback表示指向Surface生命周期回调的指针。
onSurfaceCreated表示声明Surface创建时会触发的回调事件。
- surfaceHolder: 表示指向OH_ArkUI_SurfaceHolder实例的指针。

OH_ArkUI_SurfaceCallback_SetSurfaceChangedEvent()

void OH_ArkUI_SurfaceCallback_SetSurfaceCreatedEvent(OH_ArkUI_SurfaceCallback* callback, void (*onSurfaceChanged)(OH_ArkUI_SurfaceHolder* surfaceHolder, uint64_t width, uint64_t heigh))

描述：

设置Surface生命周期回调中的大小改变回调事件。

起始版本：

19

参数:

名称描述
callback表示指向Surface生命周期回调的指针。
onSurfaceChanged表示声明Surface大小改变时会触发的回调事件。
- surfaceHolder: 表示指向OH_ArkUI_SurfaceHolder实例的指针。

OH_ArkUI_SurfaceCallback_SetSurfaceDestroyedEvent()

void OH_ArkUI_SurfaceCallback_SetSurfaceCreatedEvent(OH_ArkUI_SurfaceCallback* callback, void (*onSurfaceDestroyed)(OH_ArkUI_SurfaceHolder* surfaceHolder))

描述：

设置Surface生命周期回调中的销毁回调事件。

起始版本：

19

参数:

名称描述
callback表示指向Surface生命周期回调的指针。
onSurfaceDestroyed表示声明Surface销毁时会触发的回调事件。
- surfaceHolder: 表示指向OH_ArkUI_SurfaceHolder实例的指针。

OH_ArkUI_SurfaceHolder_AddSurfaceCallback()

int32_t OH_ArkUI_SurfaceHolder_AddSurfaceCallback(OH_ArkUI_SurfaceHolder* surfaceHolder, OH_ArkUI_SurfaceCallback* callback)

描述：

添加Surface生命周期回调到OH_ArkUI_SurfaceHolder实例。

起始版本：

19

参数:

名称描述
surfaceHolder表示指向OH_ArkUI_SurfaceHolder实例的指针。
callback表示指向新回调的指针。

返回：

ARKUI_ERROR_CODE_NO_ERROR - 执行成功。

ARKUI_ERROR_CODE_PARAM_INVALID - 传入参数异常。

OH_ArkUI_SurfaceHolder_RemoveSurfaceCallback()

int32_t OH_ArkUI_SurfaceHolder_RemoveSurfaceCallback(OH_ArkUI_SurfaceHolder* surfaceHolder, OH_ArkUI_SurfaceCallback* callback)

描述：

删除OH_ArkUI_SurfaceHolder实例先前添加的Surface生命周期回调。

起始版本：

19

参数:

名称描述
surfaceHolder表示指向需要销毁的OH_ArkUI_SurfaceHolder实例的指针。
callback表示指向需要删除的回调的指针。

返回：

ARKUI_ERROR_CODE_NO_ERROR - 执行成功。

ARKUI_ERROR_CODE_PARAM_INVALID - 传入参数异常。

OH_ArkUI_XComponent_GetNativeWindow()

OHNativeWindow* OH_ArkUI_XComponent_GetNativeWindow(OH_ArkUI_SurfaceHolder* surfaceHolder)

描述：

获取OH_ArkUI_SurfaceHolder实例关联的NativeWindow。

起始版本：

19

参数:

名称描述
surfaceHolder表示指向OH_ArkUI_SurfaceHolder实例的指针。

返回：

返回OH_ArkUI_SurfaceHolder实例关联的NativeWindow。

OH_ArkUI_XComponent_SetAutoInitialize()

int32_t OH_ArkUI_XComponent_SetAutoInitialize(ArkUI_NodeHandle node, bool autoInitialize)

描述：

设置XComponent组件是否需要自动初始化Surface的标志位。

起始版本：

19

参数:

名称描述
node表示指向XComponent组件实例的指针。
autoInitialize表示XComponent组件是否需要自动初始化Surface。如果autoInitialize值是true，OnSurfaceCreated回调会在挂树时被触发，OnSurfaceDestroyed回调会在下树时被触发。autoInitialize默认值是true。

返回：

ARKUI_ERROR_CODE_NO_ERROR - 执行成功。

ARKUI_ERROR_CODE_PARAM_INVALID - 传入参数异常。

OH_ArkUI_XComponent_Initialize()

int32_t OH_ArkUI_XComponent_Initialize(ArkUI_NodeHandle node)

描述：

初始化XComponent组件持有的Surface。

起始版本：

19

参数:

名称描述
node表示指向XComponent组件实例的指针。

返回：

ARKUI_ERROR_CODE_NO_ERROR - 执行成功。

ARKUI_ERROR_CODE_PARAM_INVALID - 传入参数异常。

ARKUI_ERROR_CODE_XCOMPONENT_STATE_INVALID - XComponent持有的Surface已经被初始化。

OH_ArkUI_XComponent_Finalize()

int32_t OH_ArkUI_XComponent_Finalize(ArkUI_NodeHandle node)

描述：

销毁XComponent组件持有的Surface。

起始版本：

19

参数:

名称描述
node表示指向XComponent组件实例的指针。

返回：

ARKUI_ERROR_CODE_NO_ERROR - 执行成功。

ARKUI_ERROR_CODE_PARAM_INVALID - 传入参数异常。

ARKUI_ERROR_CODE_XCOMPONENT_STATE_INVALID - XComponent持有的Surface已经被销毁。

OH_ArkUI_XComponent_IsInitialized()

int32_t OH_ArkUI_XComponent_IsInitialized(ArkUI_NodeHandle node, bool* isInitialized)

描述：

获取XComponent组件是否已经初始化的标志位。

起始版本：

19

参数:

名称描述
node表示指向XComponent组件实例的指针。
isInitialized表示XComponent组件是否已经初始化Surface。

返回：

ARKUI_ERROR_CODE_NO_ERROR - 执行成功。

ARKUI_ERROR_CODE_PARAM_INVALID - 传入参数异常。

OH_NativeXComponent_GetExtraMouseEventInfo()

int32_t OH_NativeXComponent_GetExtraMouseEventInfo(OH_NativeXComponent* component, OH_NativeXComponent_ExtraMouseEventInfo** extraMouseEventInfo)

描述：

从此OH_NativeXComponent实例中获取扩展的鼠标事件信息。

起始版本：

20

参数:

名称描述
component表示指向OH_NativeXComponent实例的指针。
extraMouseEventInfo表示指向OH_NativeXComponent_ExtraMouseEventInfo类型指针的地址。

说明：

此接口应在鼠标事件回调函数的作用域中调用，不应在鼠标事件回调函数的作用域之外调用此接口或使用OH_NativeXComponent_ExtraMouseEventInfo实例。

对于调用此接口获取的OH_NativeXComponent_ExtraMouseEventInfo类型的指针，不能调用delete语句将其销毁。

传入此接口的component参数或extraMouseEventInfo参数为空指针时，为传入参数异常情况。

返回：

ARKUI_ERROR_CODE_NO_ERROR - 执行成功。

ARKUI_ERROR_CODE_PARAM_INVALID - 传入参数异常。

OH_NativeXComponent_GetMouseEventModifierKeyStates()

int32_t OH_NativeXComponent_GetMouseEventModifierKeyStates(OH_NativeXComponent_ExtraMouseEventInfo* extraMouseEventInfo, uint64_t* keys)

描述：

从OH_NativeXComponent_ExtraMouseEventInfo实例中获取功能键按压状态信息。

起始版本：

20

参数:

名称描述
extraMouseEventInfo表示指向扩展的鼠标事件信息实例的指针。
keys用于接收功能键按压状态信息的64位无符号整数的地址。

说明：

调用此接口获取的功能键按状态信息存储在一个64位无符号整数中，应使用ArkUI_ModifierKeyName类型的枚举值与获取的64位无符号整数进行与（&）位运算操作来获取某一功能按键的按压状态，位运算的结果为0表示该功能键未按下，位运算的结果为1表示该功能键按下。

传入此接口的component参数或keys参数为空指针时，为传入参数异常情况。

返回：

ARKUI_ERROR_CODE_NO_ERROR - 执行成功。

ARKUI_ERROR_CODE_PARAM_INVALID - 传入参数异常。

OH_NativeXComponent_GetKeyEventModifierKeyStates()

int32_t OH_NativeXComponent_GetKeyEventModifierKeyStates(OH_NativeXComponent_KeyEvent* keyEvent, uint64_t* keys)

描述：

从按键事件中获取功能键按压状态。

起始版本：

20

参数:

名称描述
keyEvent表示指向按键事件的指针。
keys用于接收功能键按压状态信息的64位无符号整数的地址。

说明：

调用此接口获取的功能键按状态信息存储在一个64位无符号整数中，应使用ArkUI_ModifierKeyName类型的枚举值与获取的64位无符号整数进行与（&）位运算操作来获取某一功能按键的按压状态，位运算的结果为0表示该功能键未按下，位运算的结果为1表示该功能键按下。

传入此接口的keyEvent参数或keys参数为空指针时，为传入参数异常情况。

返回：

ARKUI_ERROR_CODE_NO_ERROR - 执行成功。

ARKUI_ERROR_CODE_PARAM_INVALID - 传入参数异常。

OH_NativeXComponent_GetKeyEventNumLockState()

int32_t OH_NativeXComponent_GetKeyEventNumLockState(OH_NativeXComponent_KeyEvent* keyEvent, bool* isNumLockOn)

描述：

从按键事件中获取NumLock（小键盘锁定）键的状态信息。

起始版本：

20

参数:

名称描述
keyEvent表示指向按键事件的指针。
isNumLockOn用于接收NumLock（小键盘锁定）键状态的bool类型变量的地址。

说明：

调用此接口获取的NumLock（小键盘锁定）键状态信息存储在一个bool类型变量中，其值为true时表示NumLock（小键盘锁定）键处于生效状态，其值为false时表示NumLock（小键盘锁定）键处于未生效状态。

传入此接口的keyEvent参数或isNumLockOn参数为空指针时，为传入参数异常情况。

返回：

ARKUI_ERROR_CODE_NO_ERROR - 执行成功。

ARKUI_ERROR_CODE_PARAM_INVALID - 传入参数异常。

OH_NativeXComponent_GetKeyEventCapsLockState()

int32_t OH_NativeXComponent_GetKeyEventCapsLockState(OH_NativeXComponent_KeyEvent* keyEvent, bool* isCapsLockOn)

描述：

从按键事件中获取CapsLock（大写锁定）键的状态信息。

起始版本：

20

参数:

名称描述
keyEvent表示指向按键事件的指针。
isCapsLockOn用于接收CapsLock（大写锁定）键状态的bool类型变量的地址。

说明：

调用此接口获取的CapsLock（大写锁定）键状态信息存储在一个bool类型变量中，其值为true时表示CapsLock（大写锁定）键处于生效状态，其值为false时表示CapsLock（大写锁定）键处于未生效状态。

传入此接口的keyEvent参数或isCapsLockOn参数为空指针时，为传入参数异常情况。

返回：

ARKUI_ERROR_CODE_NO_ERROR - 执行成功。

ARKUI_ERROR_CODE_PARAM_INVALID - 传入参数异常。

OH_NativeXComponent_GetKeyEventScrollLockState()

int32_t OH_NativeXComponent_GetKeyEventScrollLockState(OH_NativeXComponent_KeyEvent* keyEvent, bool* isScrollLockOn)

描述：

从按键事件中获取ScrollLock（滚动锁定）键的状态信息。

起始版本：

20

参数:

名称描述
keyEvent表示指向按键事件的指针。
isScrollLockOn表示用于接收ScrollLock（滚动锁定）键状态的bool类型变量的地址。

说明：

调用此接口获取的ScrollLock（滚动锁定）键状态信息存储在一个bool类型变量中，其值为true时表示ScrollLock（滚动锁定）键处于生效状态，其值为false时表示ScrollLock（滚动锁定）键处于未生效状态。

传入此接口的keyEvent参数或isScrollLockOn参数为空指针时，为传入参数异常情况。

返回：

ARKUI_ERROR_CODE_NO_ERROR - 执行成功。

ARKUI_ERROR_CODE_PARAM_INVALID - 传入参数异常。

OH_ArkUI_XComponent_SetExpectedFrameRateRange()

int32_t OH_ArkUI_XComponent_SetExpectedFrameRateRange(
    ArkUI_NodeHandle node, OH_NativeXComponent_ExpectedRateRange range)

描述：

为此XComponent组件实例设置期望帧率。

起始版本：

20

参数:

名称描述
node表示XComponent组件实例。
range表示OH_NativeXComponent_ExpectedRateRange类型的期望帧率信息对象。

说明：

此接口中传入的XComponent组件实例需要由ArkUI NDK接口创建或通过NativeXComponentParameters构造。

传入参数中的OH_NativeXComponent_ExpectedRateRange对象的min成员的值需要小于等于max成员的值，同时expected成员的值应大于等于min成员的值且小于等于max成员的值。

返回：

ARKUI_ERROR_CODE_NO_ERROR - 执行成功。

ARKUI_ERROR_CODE_PARAM_INVALID - 传入参数异常。

OH_ArkUI_XComponent_RegisterOnFrameCallback()

int32_t OH_ArkUI_XComponent_RegisterOnFrameCallback(ArkUI_NodeHandle node,
    void (*callback)(ArkUI_NodeHandle node, uint64_t timestamp, uint64_t targetTimestamp))

描述：

为此XComponent组件实例注册帧回调函数。

起始版本：

20

参数:

名称描述
node表示XComponent组件实例。
callback表示执行帧回调函数的指针。
- timestamp: 当前帧到达的时间（单位：纳秒）。
- targetTimestamp: 下一帧预期到达的时间（单位：纳秒）。

说明：

此接口中传入的XComponent组件实例需要由ArkUI NDK接口创建或通过NativeXComponentParameters构造。

返回：

ARKUI_ERROR_CODE_NO_ERROR - 执行成功。

ARKUI_ERROR_CODE_PARAM_INVALID - 传入参数异常。

OH_ArkUI_XComponent_UnregisterOnFrameCallback()

int32_t OH_ArkUI_XComponent_UnregisterOnFrameCallback(ArkUI_NodeHandle node)

描述：

为此XComponent组件实例取消注册帧回调函数。

起始版本：

20

参数:

名称描述
node表示XComponent组件实例。

说明：

此接口中传入的XComponent组件实例需要由ArkUI NDK接口创建或通过NativeXComponentParameters构造。

返回：

ARKUI_ERROR_CODE_NO_ERROR - 执行成功。

ARKUI_ERROR_CODE_PARAM_INVALID - 传入参数异常。

OH_ArkUI_XComponent_SetNeedSoftKeyboard()

int32_t OH_ArkUI_XComponent_SetNeedSoftKeyboard(ArkUI_NodeHandle node, bool needSoftKeyboard)

描述：

为此XComponent组件实例设置是否需要软键盘。

起始版本：

20

参数:

名称描述
node表示XComponent组件实例。
needSoftKeyboard表示是否需要软键盘。

说明：

此接口中传入的XComponent组件实例需要由ArkUI NDK接口创建或通过NativeXComponentParameters构造。

XComponent组件默认的needSoftKeyboard值为false。

返回：

ARKUI_ERROR_CODE_NO_ERROR - 执行成功。

ARKUI_ERROR_CODE_PARAM_INVALID - 传入参数异常。

OH_ArkUI_AccessibilityProvider_Create()

ArkUI_AccessibilityProvider* OH_ArkUI_AccessibilityProvider_Create(ArkUI_NodeHandle node)

描述：

基于此XComponent实例创建ArkUI_AccessibilityProvider实例。

起始版本：

20

参数:

名称描述
node表示XComponent组件实例。

说明：

此接口中传入的XComponent组件实例需要由ArkUI NDK接口创建或通过NativeXComponentParameters构造。

返回：

ArkUI_AccessibilityProvider类型的指针。

OH_ArkUI_AccessibilityProvider_Dispose()

void OH_ArkUI_AccessibilityProvider_Dispose(ArkUI_AccessibilityProvider* provider)

描述：

销毁由Native接口OH_ArkUI_AccessibilityProvider_Create创建的ArkUI_AccessibilityProvider实例。

起始版本：

20

参数:

名称描述
provider表示由Native接口OH_ArkUI_AccessibilityProvider_Create创建的ArkUI_AccessibilityProvider实例。

OH_ArkUI_SurfaceCallback_SetSurfaceShowEvent()

void OH_ArkUI_SurfaceCallback_SetSurfaceShowEvent(
    OH_ArkUI_SurfaceCallback* callback,
    void (*onSurfaceShow)(OH_ArkUI_SurfaceHolder* surfaceHolder))

描述：

为此OH_ArkUI_SurfaceCallback实例设置Surface显示回调。

起始版本：

20

参数:

名称描述
callback表示指向OH_ArkUI_SurfaceCallback实例的指针。
onSurfaceShow表示Surface显示回调函数指针。
- surfaceHolder：表示指向OH_ArkUI_SurfaceHolder实例的指针。

OH_ArkUI_SurfaceCallback_SetSurfaceHideEvent()

void OH_ArkUI_SurfaceCallback_SetSurfaceHideEvent(
    OH_ArkUI_SurfaceCallback* callback,
    void (*onSurfaceHide)(OH_ArkUI_SurfaceHolder* surfaceHolder))

描述：

为此OH_ArkUI_SurfaceCallback实例设置Surface隐藏回调。

起始版本：

20

参数:

名称描述
callback表示指向OH_ArkUI_SurfaceCallback实例的指针。
onSurfaceHide表示Surface隐藏回调函数指针。
- surfaceHolder：表示指向OH_ArkUI_SurfaceHolder实例的指针。

变量说明

OH_XCOMPONENT_ID_LEN_MAX

const uint32_t OH_XCOMPONENT_ID_LEN_MAX = 128

描述：

ArkUI XComponent的id最大长度。

起始版本：

8

OH_MAX_TOUCH_POINTS_NUMBER

const uint32_t OH_MAX_TOUCH_POINTS_NUMBER = 10

描述：

触摸事件中的可识别的触摸点个数最大值。

起始版本：

8

action

OH_NativeXComponent_MouseEventAction OH_NativeXComponent_MouseEvent::action

描述:

当前鼠标事件动作。

起始版本：

8

button

OH_NativeXComponent_MouseEventButton OH_NativeXComponent_MouseEvent::button

描述:

鼠标事件按键。

起始版本：

8

deviceId

int64_t OH_NativeXComponent_TouchEvent::deviceId = 0

描述:

产生当前触摸事件的设备的ID。

起始版本：

8

DispatchHoverEvent

void(* OH_NativeXComponent_MouseEvent_Callback::DispatchHoverEvent) (OH_NativeXComponent *component, bool isHover)

描述:

当悬停事件被触发时调用。

参数:

名称描述
component表示指向OH_NativeXComponent实例的指针。
isHover表示鼠标或手写笔是否悬浮在组件上，进入时为true，离开时为false。

起始版本：

8

DispatchMouseEvent

void(* OH_NativeXComponent_MouseEvent_Callback::DispatchMouseEvent) (OH_NativeXComponent *component, void *window)

描述:

当鼠标事件被触发时调用。

参数:

名称描述
component表示指向OH_NativeXComponent实例的指针。
window表示NatievWindow句柄。

起始版本：

8

DispatchTouchEvent

void(* OH_NativeXComponent_Callback::DispatchTouchEvent) (OH_NativeXComponent *component, void *window)

描述:

当触摸事件被触发时调用。

参数:

名称描述
component表示指向OH_NativeXComponent实例的指针。
window表示NatievWindow句柄。

起始版本：

8

force [1/2]

float OH_NativeXComponent_TouchPoint::force = 0.0

描述:

当前触摸事件的压力。

起始版本：

8

force [2/2]

float OH_NativeXComponent_TouchEvent::force = 0.0

描述:

当前触摸事件的压力。

起始版本：

8

id [1/2]

int32_t OH_NativeXComponent_TouchPoint::id = 0

描述:

手指的唯一标识符。

起始版本：

8

id [2/2]

int32_t OH_NativeXComponent_TouchEvent::id = 0

描述:

手指的唯一标识符。

起始版本：

8

isPressed

bool OH_NativeXComponent_TouchPoint::isPressed = false

描述:

当前点是否被按下。

起始版本：

8

numPoints

uint32_t OH_NativeXComponent_TouchEvent::numPoints = 0

描述:

当前接触点的数量。

起始版本：

8

OnSurfaceChanged

void(* OH_NativeXComponent_Callback::OnSurfaceChanged) (OH_NativeXComponent *component, void *window)

描述:

当surface改变时调用。

参数:

名称描述
component表示指向OH_NativeXComponent实例的指针。
window表示NatievWindow句柄。

起始版本：

8

OnSurfaceCreated

void(* OH_NativeXComponent_Callback::OnSurfaceCreated) (OH_NativeXComponent *component, void *window)

描述:

创建surface时调用。

参数:

名称描述
component表示指向OH_NativeXComponent实例的指针。
window表示NatievWindow句柄。

起始版本：

8

OnSurfaceDestroyed

void(* OH_NativeXComponent_Callback::OnSurfaceDestroyed) (OH_NativeXComponent *component, void *window)

描述:

当surface被销毁时调用。

参数:

名称描述
component表示指向OH_NativeXComponent实例的指针。
window表示NatievWindow句柄。

起始版本：

8

screenX [1/3]

float OH_NativeXComponent_TouchPoint::screenX = 0.0

描述:

触摸点相对于XComponent所在应用窗口左上角的x坐标。

起始版本：

8

screenX [2/3]

float OH_NativeXComponent_TouchEvent::screenX = 0.0

描述:

触摸点相对于XComponent所在应用窗口左上角的x坐标。

起始版本：

8

screenX [3/3]

float OH_NativeXComponent_MouseEvent::screenX

描述:

点击触点相对于XComponent所在应用屏幕左上角的x轴坐标。

起始版本：

8

screenY [1/3]

float OH_NativeXComponent_TouchPoint::screenY = 0.0

描述:

触摸点相对于XComponent所在应用窗口左上角的y坐标。

起始版本：

8

screenY [2/3]

float OH_NativeXComponent_TouchEvent::screenY = 0.0

描述:

触摸点相对于所在应用窗口左上角的y坐标。

起始版本：

8

screenY [3/3]

float OH_NativeXComponent_MouseEvent::screenY

描述:

点击触点相对于所在应用屏幕左上角的y轴坐标。

起始版本：

8

size [1/2]

double OH_NativeXComponent_TouchPoint::size = 0.0

描述:

指垫和屏幕之间的接触面积。

起始版本：

8

size [2/2]

double OH_NativeXComponent_TouchEvent::size = 0.0

描述:

指垫和屏幕之间的接触面积。

起始版本：

8

timeStamp [1/2]

long long OH_NativeXComponent_TouchPoint::timeStamp = 0

描述:

当前触摸事件的时间戳。触发事件时距离系统启动的时间间隔，单位纳秒。

起始版本：

8

timeStamp [2/2]

long long OH_NativeXComponent_TouchEvent::timeStamp = 0

描述:

当前触摸事件的时间戳。触发事件时距离系统启动的时间间隔，单位纳秒。

起始版本：

8

timestamp

int64_t OH_NativeXComponent_MouseEvent::timestamp

描述:

当前鼠标事件的时间戳。触发事件时距离系统启动的时间间隔，单位纳秒。

起始版本：

8

touchPoints

OH_NativeXComponent_TouchPoint OH_NativeXComponent_TouchEvent::touchPoints[OH_MAX_TOUCH_POINTS_NUMBER]

描述:

当前触摸点的数组。

起始版本：

8

type [1/2]

OH_NativeXComponent_TouchEventType OH_NativeXComponent_TouchPoint::type = OH_NativeXComponent_TouchEventType::OH_NATIVEXCOMPONENT_UNKNOWN

描述:

触摸事件的触摸类型。

起始版本：

8

type [2/2]

OH_NativeXComponent_TouchEventType OH_NativeXComponent_TouchEvent::type = OH_NativeXComponent_TouchEventType::OH_NATIVEXCOMPONENT_UNKNOWN

描述:

触摸事件的触摸类型。

起始版本：

8

x [1/3]

float OH_NativeXComponent_TouchPoint::x = 0.0

描述:

触摸点相对于XComponent组件左边缘的x坐标。

起始版本：

8

x [2/3]

float OH_NativeXComponent_TouchEvent::x = 0.0

描述:

触摸点相对于XComponent组件左边缘的x坐标。

起始版本：

8

x [3/3]

float OH_NativeXComponent_MouseEvent::x

描述:

点击触点相对于当前组件左上角的x轴坐标。

起始版本：

8

y [1/3]

float OH_NativeXComponent_TouchPoint::y = 0.0

描述:

触摸点相对于XComponent组件上边缘的y坐标。

起始版本：

8

y [2/3]

float OH_NativeXComponent_TouchEvent::y = 0.0

描述:

触摸点相对于XComponent组件上边缘的y坐标。

起始版本：

8

y [3/3]

float OH_NativeXComponent_MouseEvent::y

描述:

点击触点相对于当前组件左上角的y轴坐标。

起始版本：

8

expected

int32_t OH_NativeXComponent_ExpectedRateRange::expected

描述：

期望帧率。

起始版本：

11

max

int32_t OH_NativeXComponent_ExpectedRateRange::max

描述：

期望帧率范围最大值。

起始版本：

11

min

int32_t OH_NativeXComponent_ExpectedRateRange::min

描述：

期望帧率范围最小值。

起始版本：

11

你可能感兴趣的鸿蒙文章

harmony 鸿蒙ArkUI（方舟UI框架）

harmony 鸿蒙ARKUI_TextPickerCascadeRangeContent

harmony 鸿蒙ARKUI_TextPickerRangeContent

harmony 鸿蒙ArkUI_AnimateCompleteCallback

harmony 鸿蒙ArkUI_AttributeItem

harmony 鸿蒙ArkUI_ColorStop

harmony 鸿蒙ArkUI_ContextCallback

harmony 鸿蒙ArkUI_EventModule

harmony 鸿蒙ArkUI_ExpectedFrameRateRange

harmony 鸿蒙ArkUI_IntOffset

  • 所属分类： 后端技术
  • 本文标签： 软件 鸿蒙
  • 版权声明： 本文链接 https://seaxiang.com/blog/ugYwv6