MaaFramework
A automation black-box testing framework based on image recognition.
Loading...
Searching...
No Matches
MaaController.h
Go to the documentation of this file.
1
10// IWYU pragma: private, include <MaaFramework/MaaAPI.h>
11
12#pragma once
13
14#include "../MaaDef.h"
15#include "../MaaPort.h"
16
17#ifdef __cplusplus
18extern "C"
19{
20#endif
21
23
25 const char* adb_path,
26 const char* address,
27 MaaAdbScreencapMethod screencap_methods,
28 MaaAdbInputMethod input_methods,
29 const char* config,
30 const char* agent_path);
31
33 void* hWnd,
34 MaaWin32ScreencapMethod screencap_method,
35 MaaWin32InputMethod mouse_method,
36 MaaWin32InputMethod keyboard_method);
37
39
41 MaaDbgControllerCreate(const char* read_path, const char* write_path, MaaDbgControllerType type, const char* config);
42
44
46
48
50
55 MaaController* ctrl,
56 MaaCtrlOption key,
57 MaaOptionValue value ,
58 MaaOptionValueSize val_size);
59
61
63
65 MaaControllerPostSwipe(MaaController* ctrl, int32_t x1, int32_t y1, int32_t x2, int32_t y2, int32_t duration);
66
68
70
72
74
75 // for adb controller, contact means finger id (0 for first finger, 1 for second finger, etc)
76 // for win32 controller, contact means mouse button id (0 for left, 1 for right, 2 for middle)
77 MAA_FRAMEWORK_API MaaCtrlId MaaControllerPostTouchDown(MaaController* ctrl, int32_t contact, int32_t x, int32_t y, int32_t pressure);
78
79 MAA_FRAMEWORK_API MaaCtrlId MaaControllerPostTouchMove(MaaController* ctrl, int32_t contact, int32_t x, int32_t y, int32_t pressure);
80
81 // for adb controller, contact means finger id (0 for first finger, 1 for second finger, etc)
82 // for win32 controller, contact means mouse button id (0 for left, 1 for right, 2 for middle)
84
86
88
90
102
114 MAA_FRAMEWORK_API MaaCtrlId MaaControllerPostShell(MaaController* ctrl, const char* cmd, int64_t timeout);
115
126
128
130
132
134
136
138
139#ifdef __cplusplus
140}
141#endif
MAA_FRAMEWORK_API MaaBool MaaControllerConnected(const MaaController *ctrl)
MAA_FRAMEWORK_API MaaCtrlId MaaControllerPostConnection(MaaController *ctrl)
MAA_FRAMEWORK_API MaaController * MaaWin32ControllerCreate(void *hWnd, MaaWin32ScreencapMethod screencap_method, MaaWin32InputMethod mouse_method, MaaWin32InputMethod keyboard_method)
MAA_FRAMEWORK_API MaaBool MaaControllerGetUuid(MaaController *ctrl, MaaStringBuffer *buffer)
MAA_FRAMEWORK_API MaaCtrlId MaaControllerPostTouchUp(MaaController *ctrl, int32_t contact)
MAA_FRAMEWORK_API MaaCtrlId MaaControllerPostStopApp(MaaController *ctrl, const char *intent)
MAA_FRAMEWORK_API void MaaControllerRemoveSink(MaaController *ctrl, MaaSinkId sink_id)
MAA_FRAMEWORK_API MaaController * MaaDbgControllerCreate(const char *read_path, const char *write_path, MaaDbgControllerType type, const char *config)
MAA_FRAMEWORK_API MaaController * MaaCustomControllerCreate(MaaCustomControllerCallbacks *controller, void *controller_arg)
MAA_FRAMEWORK_API MaaCtrlId MaaControllerPostShell(MaaController *ctrl, const char *cmd, int64_t timeout)
Post a shell command to the controller.
MAA_FRAMEWORK_API void MaaControllerDestroy(MaaController *ctrl)
MAA_FRAMEWORK_API void MaaControllerClearSinks(MaaController *ctrl)
MAA_DEPRECATED MAA_FRAMEWORK_API MaaCtrlId MaaControllerPostPressKey(MaaController *ctrl, int32_t keycode)
MAA_FRAMEWORK_API MaaStatus MaaControllerWait(const MaaController *ctrl, MaaCtrlId id)
MAA_FRAMEWORK_API MaaBool MaaControllerCachedImage(const MaaController *ctrl, MaaImageBuffer *buffer)
MAA_FRAMEWORK_API MaaController * MaaAdbControllerCreate(const char *adb_path, const char *address, MaaAdbScreencapMethod screencap_methods, MaaAdbInputMethod input_methods, const char *config, const char *agent_path)
MAA_FRAMEWORK_API MaaCtrlId MaaControllerPostClickKey(MaaController *ctrl, int32_t keycode)
MAA_FRAMEWORK_API MaaBool MaaControllerGetShellOutput(const MaaController *ctrl, MaaStringBuffer *buffer)
Get the cached shell command output.
MAA_FRAMEWORK_API MaaSinkId MaaControllerAddSink(MaaController *ctrl, MaaEventCallback sink, void *trans_arg)
MAA_FRAMEWORK_API MaaCtrlId MaaControllerPostTouchMove(MaaController *ctrl, int32_t contact, int32_t x, int32_t y, int32_t pressure)
MAA_FRAMEWORK_API MaaCtrlId MaaControllerPostStartApp(MaaController *ctrl, const char *intent)
MAA_FRAMEWORK_API MaaCtrlId MaaControllerPostClick(MaaController *ctrl, int32_t x, int32_t y)
MAA_FRAMEWORK_API MaaCtrlId MaaControllerPostSwipe(MaaController *ctrl, int32_t x1, int32_t y1, int32_t x2, int32_t y2, int32_t duration)
MAA_FRAMEWORK_API MaaCtrlId MaaControllerPostScroll(MaaController *ctrl, int32_t dx, int32_t dy)
Post a scroll action to the controller.
MAA_FRAMEWORK_API MaaCtrlId MaaControllerPostKeyDown(MaaController *ctrl, int32_t keycode)
MAA_FRAMEWORK_API MaaBool MaaControllerSetOption(MaaController *ctrl, MaaCtrlOption key, MaaOptionValue value, MaaOptionValueSize val_size)
MAA_FRAMEWORK_API MaaCtrlId MaaControllerPostInputText(MaaController *ctrl, const char *text)
MAA_FRAMEWORK_API MaaCtrlId MaaControllerPostTouchDown(MaaController *ctrl, int32_t contact, int32_t x, int32_t y, int32_t pressure)
MAA_FRAMEWORK_API MaaCtrlId MaaControllerPostScreencap(MaaController *ctrl)
MAA_FRAMEWORK_API MaaCtrlId MaaControllerPostKeyUp(MaaController *ctrl, int32_t keycode)
MAA_FRAMEWORK_API MaaStatus MaaControllerStatus(const MaaController *ctrl, MaaCtrlId id)
struct MaaImageBuffer MaaImageBuffer
Definition MaaDef.h:33
uint64_t MaaWin32ScreencapMethod
Definition MaaDef.h:256
uint64_t MaaWin32InputMethod
Definition MaaDef.h:269
uint8_t MaaBool
Definition MaaDef.h:18
uint64_t MaaAdbScreencapMethod
Definition MaaDef.h:222
struct MaaStringBuffer MaaStringBuffer
Definition MaaDef.h:32
uint64_t MaaOptionValueSize
Definition MaaDef.h:70
void(MAA_CALL * MaaEventCallback)(void *handle, const char *message, const char *details_json, void *trans_arg)
Definition MaaDef.h:313
uint64_t MaaDbgControllerType
Definition MaaDef.h:283
uint64_t MaaAdbInputMethod
Definition MaaDef.h:242
struct MaaController MaaController
Definition MaaDef.h:38
MaaId MaaSinkId
Definition MaaDef.h:29
void * MaaOptionValue
Definition MaaDef.h:69
int32_t MaaStatus
Definition MaaDef.h:42
MaaId MaaCtrlId
Definition MaaDef.h:23
MaaOption MaaCtrlOption
Definition MaaDef.h:175
#define MAA_FRAMEWORK_API
Definition MaaPort.h:36
#define MAA_DEPRECATED
Definition MaaPort.h:30
The custom controller API.
Definition MaaCustomController.h:32