Module sys 

Raw FFI bindings to the C API (auto-generated).

Structs

MaaAgentClient

MaaContext

MaaController

MaaCustomControllerCallbacks

@brief The custom controller API.

MaaImageBuffer

MaaImageListBuffer

MaaRect

MaaResource

MaaStringBuffer

MaaStringListBuffer

MaaTasker

MaaToolkitAdbDevice

MaaToolkitAdbDeviceList

MaaToolkitDesktopWindow

MaaToolkitDesktopWindowList

Constants

MaaAdbInputMethod_AdbShell

MaaAdbInputMethod_All

MaaAdbInputMethod_Default

MaaAdbInputMethod_EmulatorExtras

MaaAdbInputMethod_Maatouch

MaaAdbInputMethod_MinitouchAndAdbKey

MaaAdbInputMethod_None

MaaAdbScreencapMethod_All

MaaAdbScreencapMethod_Default

MaaAdbScreencapMethod_EmulatorExtras

MaaAdbScreencapMethod_Encode

MaaAdbScreencapMethod_EncodeToFileAndPull

MaaAdbScreencapMethod_MinicapDirect

MaaAdbScreencapMethod_MinicapStream

MaaAdbScreencapMethod_None

MaaAdbScreencapMethod_RawByNetcat

MaaAdbScreencapMethod_RawWithGzip

MaaControllerFeature_NoScalingTouchPoints

MaaControllerFeature_None

MaaControllerFeature_UseKeyboardDownAndUpInsteadOfClick

MaaControllerFeature_UseMouseDownAndUpInsteadOfClick

MaaCtrlOptionEnum_MaaCtrlOption_Invalid

MaaCtrlOptionEnum_MaaCtrlOption_ScreenshotTargetLongSide

Only one of long and short side can be set, and the other is automatically scaled according to the aspect ratio.

MaaCtrlOptionEnum_MaaCtrlOption_ScreenshotTargetShortSide

Only one of long and short side can be set, and the other is automatically scaled according to the aspect ratio.

MaaCtrlOptionEnum_MaaCtrlOption_ScreenshotUseRawSize

Screenshot use raw size without scaling. Please note that this option may cause incorrect coordinates on user devices with different resolutions if scaling is not performed.

MaaDbgControllerType_CarouselImage

MaaDbgControllerType_None

MaaDbgControllerType_ReplayRecording

MaaGamepadButton_A

MaaGamepadButton_B

MaaGamepadButton_BACK

MaaGamepadButton_CIRCLE

MaaGamepadButton_CROSS

MaaGamepadButton_DPAD_DOWN

MaaGamepadButton_DPAD_LEFT

MaaGamepadButton_DPAD_RIGHT

MaaGamepadButton_DPAD_UP

MaaGamepadButton_GUIDE

MaaGamepadButton_L1

MaaGamepadButton_L3

MaaGamepadButton_LB

MaaGamepadButton_LEFT_THUMB

MaaGamepadButton_OPTIONS

MaaGamepadButton_PS

MaaGamepadButton_R1

MaaGamepadButton_R3

MaaGamepadButton_RB

MaaGamepadButton_RIGHT_THUMB

MaaGamepadButton_SHARE

MaaGamepadButton_SQUARE

MaaGamepadButton_START

MaaGamepadButton_TOUCHPAD

MaaGamepadButton_TRIANGLE

MaaGamepadButton_X

MaaGamepadButton_Y

MaaGamepadTouch_LeftStick

MaaGamepadTouch_LeftTrigger

MaaGamepadTouch_RightStick

MaaGamepadTouch_RightTrigger

MaaGamepadType_DualShock4

MaaGamepadType_Xbox360

MaaGlobalOptionEnum_MaaGlobalOption_DebugMode

Whether to debug

MaaGlobalOptionEnum_MaaGlobalOption_DrawQuality

Image quality for draw images

MaaGlobalOptionEnum_MaaGlobalOption_Invalid

MaaGlobalOptionEnum_MaaGlobalOption_LogDir

Log dir

MaaGlobalOptionEnum_MaaGlobalOption_RecoImageCacheLimit

Recognition image cache limit

MaaGlobalOptionEnum_MaaGlobalOption_SaveDraw

Whether to save draw

MaaGlobalOptionEnum_MaaGlobalOption_SaveOnError

Whether to save screenshot on error

MaaGlobalOptionEnum_MaaGlobalOption_StdoutLevel

The level of log output to stdout

MaaInferenceDeviceEnum_MaaInferenceDevice_0

MaaInferenceDeviceEnum_MaaInferenceDevice_1

MaaInferenceDeviceEnum_MaaInferenceDevice_Auto

MaaInferenceDeviceEnum_MaaInferenceDevice_CPU

MaaInferenceExecutionProviderEnum_MaaInferenceExecutionProvider_Auto

MaaInferenceExecutionProviderEnum_MaaInferenceExecutionProvider_CPU

MaaInferenceExecutionProviderEnum_MaaInferenceExecutionProvider_CUDA

MaaInferenceExecutionProviderEnum_MaaInferenceExecutionProvider_CoreML

MaaInferenceExecutionProviderEnum_MaaInferenceExecutionProvider_DirectML

MaaLoggingLevelEnum_MaaLoggingLevel_All

MaaLoggingLevelEnum_MaaLoggingLevel_Debug

MaaLoggingLevelEnum_MaaLoggingLevel_Error

MaaLoggingLevelEnum_MaaLoggingLevel_Fatal

MaaLoggingLevelEnum_MaaLoggingLevel_Info

MaaLoggingLevelEnum_MaaLoggingLevel_Off

MaaLoggingLevelEnum_MaaLoggingLevel_Trace

MaaLoggingLevelEnum_MaaLoggingLevel_Warn

MaaResOptionEnum_MaaResOption_InferenceDevice

Use the specified inference device. Please set this option before loading the model.

MaaResOptionEnum_MaaResOption_InferenceExecutionProvider

Use the specified inference execution provider Please set this option before loading the model.

MaaResOptionEnum_MaaResOption_Invalid

MaaStatusEnum_MaaStatus_Failed

MaaStatusEnum_MaaStatus_Invalid

MaaStatusEnum_MaaStatus_Pending

MaaStatusEnum_MaaStatus_Running

MaaStatusEnum_MaaStatus_Succeeded

MaaTaskerOptionEnum_MaaTaskerOption_Invalid

MaaWin32InputMethod_LegacyEvent

MaaWin32InputMethod_None

MaaWin32InputMethod_PostMessage

MaaWin32InputMethod_PostMessageWithCursorPos

MaaWin32InputMethod_PostThreadMessage

MaaWin32InputMethod_Seize

MaaWin32InputMethod_SendMessage

MaaWin32InputMethod_SendMessageWithCursorPos

MaaWin32ScreencapMethod_DXGI_DesktopDup

MaaWin32ScreencapMethod_DXGI_DesktopDup_Window

MaaWin32ScreencapMethod_FramePool

MaaWin32ScreencapMethod_GDI

MaaWin32ScreencapMethod_None

MaaWin32ScreencapMethod_PrintWindow

MaaWin32ScreencapMethod_ScreenDC

WCHAR_MAX

WCHAR_MIN

WINT_MAX

WINT_MIN

_CRT_PACKING

_HAS_CXX17

_HAS_CXX20

_HAS_CXX23

_HAS_CXX26

_HAS_EXCEPTIONS

_HAS_NODISCARD

_SAL_VERSION

_STL_LANG

_USE_ATTRIBUTES_FOR_SAL

_USE_DECLSPECS_FOR_SAL

_VCRT_COMPILER_PREPROCESSOR

__SAL_H_VERSION

Statics

__security_cookie^⚠

Functions

MaaAdbControllerCreate^⚠

MaaAgentClientAlive^⚠

MaaAgentClientBindResource^⚠

MaaAgentClientConnect^⚠

MaaAgentClientConnected^⚠

MaaAgentClientCreate^⚠

MaaAgentClientCreateSocket^⚠

MaaAgentClientCreateV2^⚠

MaaAgentClientDestroy^⚠

MaaAgentClientDisconnect^⚠

MaaAgentClientGetCustomActionList^⚠

MaaAgentClientGetCustomRecognitionList^⚠

MaaAgentClientIdentifier^⚠

MaaAgentClientRegisterControllerSink^⚠

MaaAgentClientRegisterResourceSink^⚠

MaaAgentClientRegisterTaskerSink^⚠

MaaAgentClientSetTimeout^⚠

MaaAgentServerAddContextSink^⚠

MaaAgentServerAddControllerSink^⚠

MaaAgentServerAddResourceSink^⚠

MaaAgentServerAddTaskerSink^⚠

MaaAgentServerDetach^⚠

MaaAgentServerJoin^⚠

MaaAgentServerRegisterCustomAction^⚠

MaaAgentServerRegisterCustomRecognition^⚠

MaaAgentServerShutDown^⚠

MaaAgentServerStartUp^⚠

MaaContextClearHitCount^⚠

MaaContextClone^⚠

MaaContextGetAnchor^⚠

MaaContextGetHitCount^⚠

MaaContextGetNodeData^⚠

MaaContextGetTaskId^⚠

MaaContextGetTasker^⚠

MaaContextOverrideImage^⚠

MaaContextOverrideNext^⚠

MaaContextOverridePipeline^⚠

MaaContextRunAction^⚠

MaaContextRunActionDirect^⚠

@brief Run action directly with type and parameters, without requiring a pipeline entry.

MaaContextRunRecognition^⚠

MaaContextRunRecognitionDirect^⚠

@brief Run recognition directly with type and parameters, without requiring a pipeline entry.

MaaContextRunTask^⚠

MaaContextSetAnchor^⚠

MaaControllerAddSink^⚠

MaaControllerCachedImage^⚠

@brief Get the cached screenshot image.

MaaControllerClearSinks^⚠

MaaControllerConnected^⚠

MaaControllerDestroy^⚠

MaaControllerGetResolution^⚠

@brief Get the raw (unscaled) device resolution.

MaaControllerGetShellOutput^⚠

@brief Get the cached shell command output.

MaaControllerGetUuid^⚠

MaaControllerPostClick^⚠

MaaControllerPostClickKey^⚠

MaaControllerPostClickV2^⚠

MaaControllerPostConnection^⚠

MaaControllerPostInputText^⚠

MaaControllerPostKeyDown^⚠

MaaControllerPostKeyUp^⚠

MaaControllerPostPressKey^⚠

MaaControllerPostScreencap^⚠

@brief Post a screenshot request to the controller.

MaaControllerPostScroll^⚠

@brief Post a scroll action to the controller.

MaaControllerPostShell^⚠

@brief Post a shell command to the controller.

MaaControllerPostStartApp^⚠

MaaControllerPostStopApp^⚠

MaaControllerPostSwipe^⚠

MaaControllerPostSwipeV2^⚠

MaaControllerPostTouchDown^⚠

MaaControllerPostTouchMove^⚠

MaaControllerPostTouchUp^⚠

MaaControllerRemoveSink^⚠

MaaControllerSetOption^⚠

@param[in] value

MaaControllerStatus^⚠

MaaControllerWait^⚠

MaaCustomControllerCreate^⚠

MaaDbgControllerCreate^⚠

MaaGamepadControllerCreate^⚠

@brief Create a virtual gamepad controller for Windows.

MaaGlobalLoadPlugin^⚠

load a plugin with full path or name only, name only will search in system directory and current directory or load plugins with recursive search in the directory

MaaGlobalSetOption^⚠

@param[in] value

MaaImageBufferChannels^⚠

MaaImageBufferClear^⚠

MaaImageBufferCreate^⚠

MaaImageBufferDestroy^⚠

MaaImageBufferGetEncoded^⚠

MaaImageBufferGetEncodedSize^⚠

MaaImageBufferGetRawData^⚠

MaaImageBufferHeight^⚠

MaaImageBufferIsEmpty^⚠

MaaImageBufferResize^⚠

MaaImageBufferSetEncoded^⚠

MaaImageBufferSetRawData^⚠

MaaImageBufferType^⚠

MaaImageBufferWidth^⚠

MaaImageListBufferAppend^⚠

MaaImageListBufferAt^⚠

MaaImageListBufferClear^⚠

MaaImageListBufferCreate^⚠

MaaImageListBufferDestroy^⚠

MaaImageListBufferIsEmpty^⚠

MaaImageListBufferRemove^⚠

MaaImageListBufferSize^⚠

MaaPlayCoverControllerCreate^⚠

@brief Create a PlayCover controller for macOS.

MaaRectCreate^⚠

MaaRectDestroy^⚠

MaaRectGetH^⚠

MaaRectGetW^⚠

MaaRectGetX^⚠

MaaRectGetY^⚠

MaaRectSet^⚠

MaaResourceAddSink^⚠

MaaResourceClear^⚠

MaaResourceClearCustomAction^⚠

MaaResourceClearCustomRecognition^⚠

MaaResourceClearSinks^⚠

MaaResourceCreate^⚠

MaaResourceDestroy^⚠

MaaResourceGetCustomActionList^⚠

MaaResourceGetCustomRecognitionList^⚠

MaaResourceGetDefaultActionParam^⚠

@brief Get default action parameters for the specified type from DefaultPipelineMgr.

MaaResourceGetDefaultRecognitionParam^⚠

@brief Get default recognition parameters for the specified type from DefaultPipelineMgr.

MaaResourceGetHash^⚠

MaaResourceGetNodeData^⚠

MaaResourceGetNodeList^⚠

MaaResourceLoaded^⚠

MaaResourceOverrideImage^⚠

MaaResourceOverrideNext^⚠

MaaResourceOverridePipeline^⚠

MaaResourcePostBundle^⚠

MaaResourcePostImage^⚠

MaaResourcePostOcrModel^⚠

MaaResourcePostPipeline^⚠

MaaResourceRegisterCustomAction^⚠

MaaResourceRegisterCustomRecognition^⚠

MaaResourceRemoveSink^⚠

MaaResourceSetOption^⚠

MaaResourceStatus^⚠

MaaResourceUnregisterCustomAction^⚠

MaaResourceUnregisterCustomRecognition^⚠

MaaResourceWait^⚠

MaaSetGlobalOption^⚠

MaaStringBufferClear^⚠

MaaStringBufferCreate^⚠

MaaStringBufferDestroy^⚠

MaaStringBufferGet^⚠

MaaStringBufferIsEmpty^⚠

MaaStringBufferSet^⚠

MaaStringBufferSetEx^⚠

MaaStringBufferSize^⚠

MaaStringListBufferAppend^⚠

MaaStringListBufferAt^⚠

MaaStringListBufferClear^⚠

MaaStringListBufferCreate^⚠

MaaStringListBufferDestroy^⚠

MaaStringListBufferIsEmpty^⚠

MaaStringListBufferRemove^⚠

MaaStringListBufferSize^⚠

MaaTaskerAddContextSink^⚠

MaaTaskerAddSink^⚠

MaaTaskerBindController^⚠

MaaTaskerBindResource^⚠

MaaTaskerClearCache^⚠

MaaTaskerClearContextSinks^⚠

MaaTaskerClearSinks^⚠

MaaTaskerCreate^⚠

MaaTaskerDestroy^⚠

MaaTaskerGetActionDetail^⚠

@param[out] action @param[out] box @param[out] success @param[out] detail_json

MaaTaskerGetController^⚠

MaaTaskerGetLatestNode^⚠

@param[out] latest_id

MaaTaskerGetNodeDetail^⚠

@param[out] reco_id @param[out] action_id @param[out] completed

MaaTaskerGetRecognitionDetail^⚠

@param[out] hit

MaaTaskerGetResource^⚠

MaaTaskerGetTaskDetail^⚠

@param[out] node_id_list @param[in, out] node_id_list_size @param[out] status

MaaTaskerInited^⚠

MaaTaskerOverridePipeline^⚠

MaaTaskerPostAction^⚠

@param action_type Action type string @param action_param Action parameters json @param box Previous recognition position @param reco_detail Previous recognition details

MaaTaskerPostRecognition^⚠

@param reco_type Recognition type string @param reco_param Recognition parameters json @param image Previous screenshot

MaaTaskerPostStop^⚠

MaaTaskerPostTask^⚠

MaaTaskerRemoveContextSink^⚠

MaaTaskerRemoveSink^⚠

MaaTaskerRunning^⚠

MaaTaskerSetOption^⚠

@param[in] value

MaaTaskerStatus^⚠

MaaTaskerStopping^⚠

MaaTaskerWait^⚠

MaaToolkitAdbDeviceFind^⚠

MaaToolkitAdbDeviceFindSpecified^⚠

MaaToolkitAdbDeviceGetAdbPath^⚠

MaaToolkitAdbDeviceGetAddress^⚠

MaaToolkitAdbDeviceGetConfig^⚠

MaaToolkitAdbDeviceGetInputMethods^⚠

MaaToolkitAdbDeviceGetName^⚠

MaaToolkitAdbDeviceGetScreencapMethods^⚠

MaaToolkitAdbDeviceListAt^⚠

MaaToolkitAdbDeviceListCreate^⚠

MaaToolkitAdbDeviceListDestroy^⚠

MaaToolkitAdbDeviceListSize^⚠

MaaToolkitConfigInitOption^⚠

MaaToolkitDesktopWindowFindAll^⚠

MaaToolkitDesktopWindowGetClassName^⚠

MaaToolkitDesktopWindowGetHandle^⚠

MaaToolkitDesktopWindowGetWindowName^⚠

MaaToolkitDesktopWindowListAt^⚠

MaaToolkitDesktopWindowListCreate^⚠

MaaToolkitDesktopWindowListDestroy^⚠

MaaToolkitDesktopWindowListSize^⚠

MaaVersion^⚠

MaaWin32ControllerCreate^⚠

Type Aliases

MaaActId

MaaAdbInputMethod

@brief Adb input method flags

MaaAdbScreencapMethod

@brief Adb screencap method flags

MaaBool

MaaControllerFeature

Controller feature flags returned by get_features(). These flags indicate which input methods the controller supports/prefers.

MaaCtrlId

MaaCtrlOption

MaaCtrlOptionEnum

@brief Option keys for controller instance options. See MaaControllerSetOption().

MaaCustomActionCallback

MaaCustomRecognitionCallback

MaaDbgControllerType

No bitwise OR, just set it

MaaEventCallback

void* handle:

MaaGamepadButton

@brief Virtual gamepad button codes for click_key/key_down/key_up

MaaGamepadTouch

@brief Virtual gamepad touch contact definitions for touch_down/touch_move/touch_up

MaaGamepadType

@brief Virtual gamepad type

MaaGlobalOption

MaaGlobalOptionEnum

MaaId

MaaImageEncodedData

MaaImageRawData

MaaInferenceDevice

MaaInferenceDeviceEnum

MaaInferenceExecutionProvider

MaaInferenceExecutionProviderEnum

MaaLoggingLevel

MaaLoggingLevelEnum

MaaNodeId

MaaNotificationCallback

MaaOption

MaaOptionValue

MaaOptionValueSize

MaaRecoId

MaaResId

MaaResOption

MaaResOptionEnum

MaaSinkId

MaaSize

MaaStatus

MaaStatusEnum

MaaTaskId

MaaTaskerOption

MaaTaskerOptionEnum

MaaWin32InputMethod

@brief Win32 input method

MaaWin32ScreencapMethod

@brief Win32 screencap method

__vcrt_bool

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

va_list

wchar_t