Available on crate feature
internal only.Structs§
- MaaControllerAPI
- MaaCustom
ActionAPI - @brief The custom action API.
- MaaCustom
ControllerAPI - @brief The custom controller API.
- MaaCustom
RecognizerAPI - @brief The custom recognizer API.
- MaaImage
Buffer - MaaImage
List Buffer - MaaInstanceAPI
- MaaRect
- MaaResourceAPI
- MaaString
Buffer - MaaString
List Buffer - MaaSync
ContextAPI
Constants§
- MaaAdb
Controller Type Enum_ MaaAdb Controller Type_ Input_ Preset_ Adb - MaaAdb
Controller Type Enum_ MaaAdb Controller Type_ Input_ Preset_ Auto Detect - MaaAdb
Controller Type Enum_ MaaAdb Controller Type_ Input_ Preset_ Emulator Extras - MaaAdb
Controller Type Enum_ MaaAdb Controller Type_ Input_ Preset_ Maatouch - MaaAdb
Controller Type Enum_ MaaAdb Controller Type_ Input_ Preset_ Minitouch - MaaAdb
Controller Type Enum_ MaaAdb Controller Type_ Invalid - MaaAdb
Controller Type Enum_ MaaAdb Controller Type_ Key_ Adb - MaaAdb
Controller Type Enum_ MaaAdb Controller Type_ Key_ Auto Detect - MaaAdb
Controller Type Enum_ MaaAdb Controller Type_ Key_ Emulator Extras - MaaAdb
Controller Type Enum_ MaaAdb Controller Type_ Key_ MaaTouch - MaaAdb
Controller Type Enum_ MaaAdb Controller Type_ Screencap_ Emulator Extras - \deprecated
- MaaAdb
Controller Type Enum_ MaaAdb Controller Type_ Screencap_ Encode - \deprecated
- MaaAdb
Controller Type Enum_ MaaAdb Controller Type_ Screencap_ Encode ToFile - \deprecated
- MaaAdb
Controller Type Enum_ MaaAdb Controller Type_ Screencap_ Fastest Lossless Way - \deprecated
- MaaAdb
Controller Type Enum_ MaaAdb Controller Type_ Screencap_ Fastest Way - \deprecated
- MaaAdb
Controller Type Enum_ MaaAdb Controller Type_ Screencap_ Fastest Way_ Compatible - \deprecated
- MaaAdb
Controller Type Enum_ MaaAdb Controller Type_ Screencap_ Minicap Direct - \deprecated
- MaaAdb
Controller Type Enum_ MaaAdb Controller Type_ Screencap_ Minicap Stream - \deprecated
- MaaAdb
Controller Type Enum_ MaaAdb Controller Type_ Screencap_ RawBy Netcat - \deprecated
- MaaAdb
Controller Type Enum_ MaaAdb Controller Type_ Screencap_ RawWith Gzip - \deprecated
- MaaAdb
Controller Type Enum_ MaaAdb Controller Type_ Touch_ Adb - MaaAdb
Controller Type Enum_ MaaAdb Controller Type_ Touch_ Auto Detect - MaaAdb
Controller Type Enum_ MaaAdb Controller Type_ Touch_ Emulator Extras - MaaAdb
Controller Type Enum_ MaaAdb Controller Type_ Touch_ MaaTouch - MaaAdb
Controller Type Enum_ MaaAdb Controller Type_ Touch_ Mini Touch - MaaAdb
Controller Type_ Key_ Mask - MaaAdb
Controller Type_ Screencap_ Mask - MaaAdb
Controller Type_ Touch_ Mask - MaaCtrl
Option Enum_ MaaCtrl Option_ Default AppPackage - For StopApp
- MaaCtrl
Option Enum_ MaaCtrl Option_ Default AppPackage Entry - For StartApp
- MaaCtrl
Option Enum_ MaaCtrl Option_ Invalid - MaaCtrl
Option Enum_ MaaCtrl Option_ Recording - Dump all screenshots and actions
- MaaCtrl
Option Enum_ MaaCtrl Option_ Screenshot Target Long Side - Only one of long and short side can be set, and the other is automatically scaled according to the aspect ratio.
- MaaCtrl
Option Enum_ MaaCtrl Option_ Screenshot Target Short Side - Only one of long and short side can be set, and the other is automatically scaled according to the aspect ratio.
- MaaDbg
Controller Type Enum_ MaaDbg Controller Type_ Carousel Image - MaaDbg
Controller Type Enum_ MaaDbg Controller Type_ Replay Recording - MaaDbg
Controller Type Enum_ MaaDbg Controller_ Invalid - MaaGlobal
Option Enum_ MaaGlobal Option_ Debug Message - Whether to callback debug message
- MaaGlobal
Option Enum_ MaaGlobal Option_ Invalid - MaaGlobal
Option Enum_ MaaGlobal Option_ LogDir - Log dir
- MaaGlobal
Option Enum_ MaaGlobal Option_ Recording - Dump all screenshots and actions
- MaaGlobal
Option Enum_ MaaGlobal Option_ Save Draw - Whether to save draw
- MaaGlobal
Option Enum_ MaaGlobal Option_ Show HitDraw - Whether to show hit draw
- MaaGlobal
Option Enum_ MaaGlobal Option_ Stdout Level - The level of log output to stdout
- MaaInst
Option Enum_ MaaInst Option_ Invalid - MaaLogging
Level Eunm_ MaaLogging Level_ All - MaaLogging
Level Eunm_ MaaLogging Level_ Debug - MaaLogging
Level Eunm_ MaaLogging Level_ Error - MaaLogging
Level Eunm_ MaaLogging Level_ Fatal - MaaLogging
Level Eunm_ MaaLogging Level_ Info - MaaLogging
Level Eunm_ MaaLogging Level_ Off - MaaLogging
Level Eunm_ MaaLogging Level_ Trace - MaaLogging
Level Eunm_ MaaLogging Level_ Warn - MaaRes
Option Enum_ MaaRes Option_ Invalid - MaaStatus
Enum_ MaaStatus_ Failed - MaaStatus
Enum_ MaaStatus_ Invalid - MaaStatus
Enum_ MaaStatus_ Pending - MaaStatus
Enum_ MaaStatus_ Running - MaaStatus
Enum_ MaaStatus_ Success - MaaTask
Param_ Empty - MaaThrift
Controller Type Enum_ MaaThrift Controller Type_ Socket - MaaThrift
Controller Type Enum_ MaaThrift Controller Type_ Unix Domain Socket - MaaThrift
Controller Type Enum_ MaaThrift Controller_ Invalid - MaaWin32
Controller Type Enum_ MaaWin32 Controller Type_ Key_ Seize - MaaWin32
Controller Type Enum_ MaaWin32 Controller Type_ Key_ Send Message - MaaWin32
Controller Type Enum_ MaaWin32 Controller Type_ Screencap_ DXGI_ Desktop Dup - MaaWin32
Controller Type Enum_ MaaWin32 Controller Type_ Screencap_ DXGI_ Frame Pool - MaaWin32
Controller Type Enum_ MaaWin32 Controller Type_ Screencap_ GDI - MaaWin32
Controller Type Enum_ MaaWin32 Controller Type_ Touch_ Seize - MaaWin32
Controller Type Enum_ MaaWin32 Controller Type_ Touch_ Send Message - MaaWin32
Controller Type Enum_ MaaWin32 Controller_ Invalid - MaaWin32
Controller Type_ Key_ Mask - MaaWin32
Controller Type_ Screencap_ Mask - MaaWin32
Controller Type_ Touch_ Mask
Functions§
- MaaAdb
Controller ⚠Create - \deprecated Use MaaAdbControllerCreateV2() instead.
- MaaAdb
Controller ⚠Create V2 - @brief Create a ADB controller instance.
- MaaBind
Controller ⚠ - @brief Bind the instance to an initialized controller.
- MaaBind
Resource ⚠ - @brief Bind the instance to an initialized resource.
- MaaClear
Custom ⚠Action - @brief Clear all custom actions registered to the instance.
- MaaClear
Custom ⚠Recognizer - @brief Clear all custom recognizers registered to the instance.
- MaaClear
Image ⚠ - MaaClear
Image ⚠List - MaaClear
String ⚠ - MaaClear
String ⚠List - MaaController
Connected ⚠ - @brief Check if the controller is connected.
- MaaController
Destroy ⚠ - @brief Free the controller instance.
- MaaController
GetImage ⚠ - @brief Get the image buffer of the last screencap request.
- MaaController
GetUUID ⚠ - @brief Get the UUID of the controller.
- MaaController
Post ⚠Click - MaaController
Post ⚠Connection - @defgroup MaaControllerPostRequest Controller Requests
- MaaController
Post ⚠Input Text - MaaController
Post ⚠Press Key - MaaController
Post ⚠Screencap - MaaController
Post ⚠Start App - MaaController
Post ⚠Stop App - MaaController
Post ⚠Swipe - MaaController
Post ⚠Touch Down - MaaController
Post ⚠Touch Move - MaaController
Post ⚠Touch Up - MaaController
SetOption ⚠ - @brief Set options for a given controller instance.
- MaaController
Status ⚠ - @brief Get the status of a request identified by the given id.
- MaaController
Wait ⚠ - @brief Wait for the request identified by the given id to complete.
- MaaCreate⚠
- @brief Create an instance.
- MaaCreate
Image ⚠Buffer - MaaCreate
Image ⚠List Buffer - MaaCreate
Rect ⚠Buffer - MaaCreate
String ⚠Buffer - MaaCreate
String ⚠List Buffer - MaaCustom
Controller ⚠Create - @brief Create a custom controller instance.
- MaaDbg
Controller ⚠Create - MaaDestroy⚠
- @brief Free the instance.
- MaaDestroy
Image ⚠Buffer - MaaDestroy
Image ⚠List Buffer - MaaDestroy
Rect ⚠Buffer - MaaDestroy
String ⚠Buffer - MaaDestroy
String ⚠List Buffer - MaaGet
Controller ⚠ - @brief Get the controller handle of the instance.
- MaaGet
Image ⚠Encoded - MaaGet
Image ⚠Encoded Size - MaaGet
Image ⚠Height - MaaGet
Image ⚠List At - MaaGet
Image ⚠List Size - MaaGet
Image ⚠RawData - MaaGet
Image ⚠Type - MaaGet
Image ⚠Width - MaaGet
RectH ⚠ - MaaGet
RectW ⚠ - MaaGet
RectX ⚠ - MaaGet
RectY ⚠ - MaaGet
Resource ⚠ - @brief Get the resource handle of the instance.
- MaaGet
String ⚠ - MaaGet
String ⚠List At - MaaGet
String ⚠List Size - MaaGet
String ⚠Size - MaaImage
List ⚠Append - MaaImage
List ⚠Remove - MaaInited⚠
- @brief Check if the instance is initialized.
- MaaIs
Image ⚠Empty - MaaIs
Image ⚠List Empty - MaaIs
String ⚠Empty - MaaIs
String ⚠List Empty - MaaPost
Stop ⚠ - @brief Post a stop signal to the instance.
- MaaPost
Task ⚠ - @brief Post a task to the instance.
- MaaQuery
Recognition ⚠Detail - MaaQuery
Running ⚠Detail - MaaRegister
Custom ⚠Action - @brief Register a custom action to the instance.
- MaaRegister
Custom ⚠Recognizer - @brief Register a custom recognizer to the instance.
- MaaResource
Clear ⚠ - @brief Clear the resource loading paths
- MaaResource
Create ⚠ - @brief Create a resource.
- MaaResource
Destroy ⚠ - @brief Free the resource.
- MaaResource
GetHash ⚠ - @brief Get the hash of the resource.
- MaaResource
GetTask ⚠List - @brief Get the task list of the resource.
- MaaResource
Loaded ⚠ - @brief Check if resources are loaded.
- MaaResource
Post ⚠Path - @brief Add a path to the resource loading paths
- MaaResource
SetOption ⚠ - @brief Set options for a given resource.
- MaaResource
Status ⚠ - @brief Get the loading status of a resource identified by id.
- MaaResource
Wait ⚠ - @brief Wait for a resource to be loaded.
- MaaRunning⚠
- @brief Is maa running?
- MaaSet
Global ⚠Option - @brief Set options globally.
- MaaSet
Image ⚠Encoded - MaaSet
Image ⚠RawData - MaaSet
Option ⚠ - @brief Set options for a given instance.
- MaaSet
Rect ⚠ - MaaSet
RectH ⚠ - MaaSet
RectW ⚠ - MaaSet
RectX ⚠ - MaaSet
RectY ⚠ - MaaSet
String ⚠ - MaaSet
String ⚠Ex - MaaSet
Task ⚠Param - @brief Set the parameter of a task.
- MaaStop⚠
- \deprecated Use MaaPostStop() instead.
- MaaString
List ⚠Append - MaaString
List ⚠Remove - MaaSync
Context ⚠Cached Image - MaaSync
Context ⚠Click - MaaSync
Context ⚠Input Text - MaaSync
Context ⚠Press Key - MaaSync
Context ⚠RunAction - MaaSync
Context ⚠RunRecognition - MaaSync
Context ⚠RunTask - MaaSync
Context ⚠Screencap - MaaSync
Context ⚠Swipe - MaaSync
Context ⚠Touch Down - MaaSync
Context ⚠Touch Move - MaaSync
Context ⚠Touch Up - MaaTask
AllFinished ⚠ - \deprecated Use !MaaRunning() instead.
- MaaTask
Status ⚠ - @brief Get the status of a task identified by the id.
- MaaThrift
Controller ⚠Create - MaaToolkit
Clear ⚠Custom Action Executor - MaaToolkit
Clear ⚠Custom Recognizer Executor - MaaToolkit
Find ⚠Device - \deprecated Use MaaToolkitPostFindDevice() and MaaToolkitWaitForFindDeviceToComplete() instead.
- MaaToolkit
Find ⚠Device With Adb - \deprecated Use MaaToolkitPostFindDeviceWithAdb() and MaaToolkitWaitForFindDeviceToComplete() instead.
- MaaToolkit
Find ⚠Window - @brief Find a win32 window by class name and window name.
- MaaToolkit
GetCursor ⚠Window - @brief Get the window handle of the window under the cursor. This uses the WindowFromPoint() system API.
- MaaToolkit
GetDesktop ⚠Window - @brief Get the desktop window handle. This uses the GetDesktopWindow() system API.
- MaaToolkit
GetDevice ⚠AdbConfig - @brief Get the device ADB config by index.
- MaaToolkit
GetDevice ⚠AdbController Type - @brief Get the device ADB controller type by index.
- MaaToolkit
GetDevice ⚠AdbPath - @brief Get the device ADB path by index.
- MaaToolkit
GetDevice ⚠AdbSerial - @brief Get the device ADB serial by index.
- MaaToolkit
GetDevice ⚠Count - @brief Get the number of devices found.
- MaaToolkit
GetDevice ⚠Name - @brief Get the device name by index.
- MaaToolkit
GetForeground ⚠Window - @brief Get the foreground window handle. This uses the GetForegroundWindow() system API.
- MaaToolkit
GetWindow ⚠ - @brief Get the window handle by index.
- MaaToolkit
GetWindow ⚠Class Name - @brief Get the window class name by hwnd.
- MaaToolkit
GetWindow ⚠Window Name - @brief Get the window window name by hwnd.
- MaaToolkit
Init ⚠ - \deprecated Use MaaToolkitInitOptionConfig instead.
- MaaToolkit
Init ⚠Option Config - MaaToolkit
IsFind ⚠Device Completed - @brief Check if the find device request is completed.
- MaaToolkit
List ⚠Windows - @brief List all windows. @return MaaSize The number of windows found. To get the corresponding window handle, use
- MaaToolkit
Post ⚠Find Device - @brief Post a request to find all ADB devices.
- MaaToolkit
Post ⚠Find Device With Adb - @brief Post a request to find all ADB devices with a given ADB path.
- MaaToolkit
Register ⚠Custom Action Executor - MaaToolkit
Register ⚠Custom Recognizer Executor - MaaToolkit
Search ⚠Window - @brief Regex search a win32 window by class name and window name.
- MaaToolkit
Uninit ⚠ - \deprecated Don’t use it.
- MaaToolkit
Unregister ⚠Custom Action Executor - MaaToolkit
Unregister ⚠Custom Recognizer Executor - MaaToolkit
Wait ⚠ForFind Device ToComplete - @brief Wait for the find device request to complete.
- MaaUnregister
Custom ⚠Action - @brief Unregister a custom action from the instance.
- MaaUnregister
Custom ⚠Recognizer - @brief Unregister a custom recognizer from the instance.
- MaaVersion⚠
- @brief Get the version of the framework.
- MaaWait
Task ⚠ - @brief Wait for a task to finish.
- MaaWin32
Controller ⚠Create - @brief Create a win32 controller instance.
Type Aliases§
- MaaAPI
Callback - @brief The callback function type.
- MaaAdb
Controller Type - MaaAdb
Controller Type Enum - @brief ADB controller type
- MaaBool
- MaaCallback
Transparent Arg - MaaController
Callback - MaaController
Handle - MaaCtrl
Id - MaaCtrl
Option - MaaCtrl
Option Enum - @brief Option keys for controller instance options. See MaaControllerSetOption().
- MaaCustom
Action Handle - MaaCustom
Controller Handle - MaaCustom
Recognizer Handle - MaaDbg
Controller Type - MaaDbg
Controller Type Enum - MaaGlobal
Option - MaaGlobal
Option Enum - MaaId
- MaaImage
Buffer Handle - MaaImage
Encoded Data - MaaImage
List Buffer Handle - MaaImage
RawData - MaaInst
Option - MaaInst
Option Enum - MaaInstance
Callback - MaaInstance
Handle - MaaLogging
Level - MaaLogging
Level Eunm - MaaOption
- MaaOption
Value - MaaOption
Value Size - MaaReco
Id - MaaRect
Handle - MaaRes
Id - MaaRes
Option - MaaRes
Option Enum - MaaResource
Callback - MaaResource
Handle - MaaRunning
Id - MaaSize
- MaaStatus
- MaaStatus
Enum - MaaString
Buffer Handle - MaaString
List Buffer Handle - MaaString
View - MaaSync
Context Handle - MaaTask
Id - MaaThrift
Controller Type - MaaThrift
Controller Type Enum - MaaTransparent
Arg - MaaWin32
Controller Type - MaaWin32
Controller Type Enum - @brief Win32 controller type
- MaaWin32
Hwnd - int_
fast8_ t - int_
fast16_ t - int_
fast32_ t - int_
fast64_ t - int_
least8_ t - int_
least16_ t - int_
least32_ t - int_
least64_ t - intmax_
t - uint_
fast8_ t - uint_
fast16_ t - uint_
fast32_ t - uint_
fast64_ t - uint_
least8_ t - uint_
least16_ t - uint_
least32_ t - uint_
least64_ t - uintmax_
t