Crate maa_framework_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

__fsid_t

Constants

INT8_MAX

INT8_MIN

INT16_MAX

INT16_MIN

INT32_MAX

INT32_MIN

INTPTR_MAX

INTPTR_MIN

INT_FAST8_MAX

INT_FAST8_MIN

INT_FAST16_MAX

INT_FAST16_MIN

INT_FAST32_MAX

INT_FAST32_MIN

INT_LEAST8_MAX

INT_LEAST8_MIN

INT_LEAST16_MAX

INT_LEAST16_MIN

INT_LEAST32_MAX

INT_LEAST32_MIN

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

PTRDIFF_MAX

PTRDIFF_MIN

SIG_ATOMIC_MAX

SIG_ATOMIC_MIN

SIZE_MAX

UINT8_MAX

UINT16_MAX

UINT32_MAX

UINTPTR_MAX

UINT_FAST8_MAX

UINT_FAST16_MAX

UINT_FAST32_MAX

UINT_LEAST8_MAX

UINT_LEAST16_MAX

UINT_LEAST32_MAX

WINT_MAX

WINT_MIN

_ATFILE_SOURCE

_BITS_STDINT_INTN_H

_BITS_STDINT_LEAST_H

_BITS_STDINT_UINTN_H

_BITS_TIME64_H

_BITS_TYPESIZES_H

_BITS_TYPES_H

_BITS_WCHAR_H

_DEFAULT_SOURCE

_FEATURES_H

_POSIX_C_SOURCE

_POSIX_SOURCE

_STDC_PREDEF_H

_STDINT_H

_SYS_CDEFS_H

__FD_SETSIZE

__GLIBC_MINOR__

__GLIBC_USE_C2X_STRTOL

__GLIBC_USE_DEPRECATED_GETS

__GLIBC_USE_DEPRECATED_SCANF

__GLIBC_USE_IEC_60559_BFP_EXT

__GLIBC_USE_IEC_60559_BFP_EXT_C2X

__GLIBC_USE_IEC_60559_EXT

__GLIBC_USE_IEC_60559_FUNCS_EXT

__GLIBC_USE_IEC_60559_FUNCS_EXT_C2X

__GLIBC_USE_IEC_60559_TYPES_EXT

__GLIBC_USE_ISOC2X

__GLIBC_USE_LIB_EXT2

__GLIBC__

__GNU_LIBRARY__

__HAVE_GENERIC_SELECTION

__INO_T_MATCHES_INO64_T

__KERNEL_OLD_TIMEVAL_MATCHES_TIMEVAL64

__LDOUBLE_REDIRECTS_TO_FLOAT128_ABI

__OFF_T_MATCHES_OFF64_T

__RLIM_T_MATCHES_RLIM64_T

__STATFS_MATCHES_STATFS64

__STDC_IEC_559_COMPLEX__

__STDC_IEC_559__

__STDC_IEC_60559_BFP__

__STDC_IEC_60559_COMPLEX__

__STDC_ISO_10646__

__SYSCALL_WORDSIZE

__TIMESIZE

__USE_ATFILE

__USE_FORTIFY_LEVEL

__USE_ISOC11

__USE_ISOC95

__USE_ISOC99

__USE_MISC

__USE_POSIX

__USE_POSIX2

__USE_POSIX199309

__USE_POSIX199506

__USE_POSIX_IMPLICITLY

__USE_XOPEN2K

__USE_XOPEN2K8

__WORDSIZE

__WORDSIZE_TIME64_COMPAT32

__glibc_c99_flexarr_available

Functions

MaaAdbControllerCreate^⚠

MaaAgentClientAlive^⚠

MaaAgentClientBindResource^⚠

MaaAgentClientConnect^⚠

MaaAgentClientConnected^⚠

MaaAgentClientCreate^⚠

MaaAgentClientCreateSocket^⚠

MaaAgentClientCreateTcp^⚠

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^⚠

MaaContextWaitFreezes^⚠

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

__blkcnt64_t

__blkcnt_t

__blksize_t

__caddr_t

__clock_t

__clockid_t

__daddr_t

__dev_t

__fsblkcnt64_t

__fsblkcnt_t

__fsfilcnt64_t

__fsfilcnt_t

__fsword_t

__gid_t

__id_t

__ino64_t

__ino_t

__int8_t

__int16_t

__int32_t

__int64_t

__int_least8_t

__int_least16_t

__int_least32_t

__int_least64_t

__intmax_t

__intptr_t

__key_t

__loff_t

__mode_t

__nlink_t

__off64_t

__off_t

__pid_t

__quad_t

__rlim64_t

__rlim_t

__sig_atomic_t

__socklen_t

__ssize_t

__suseconds64_t

__suseconds_t

__syscall_slong_t

__syscall_ulong_t

__time_t

__timer_t

__u_char

__u_int

__u_long

__u_quad_t

__u_short

__uid_t

__uint8_t

__uint16_t

__uint32_t

__uint64_t

__uint_least8_t

__uint_least16_t

__uint_least32_t

__uint_least64_t

__uintmax_t

__useconds_t

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