Module maa_framework::internal

Available on crate feature internal only.

Structs

• MaaControllerAPI
• MaaCustomActionAPI
  @brief The custom action API.
• MaaCustomControllerAPI
  @brief The custom controller API.
• MaaCustomRecognizerAPI
  @brief The custom recognizer API.
• MaaImageBuffer
• MaaInstanceAPI
• MaaRect
• MaaResourceAPI
• MaaStringBuffer
• MaaSyncContextAPI

Constants

• MaaAdbControllerTypeEnum_MaaAdbControllerType_Input_Preset_Adb
• MaaAdbControllerTypeEnum_MaaAdbControllerType_Input_Preset_AutoDetect
• MaaAdbControllerTypeEnum_MaaAdbControllerType_Input_Preset_Maatouch
• MaaAdbControllerTypeEnum_MaaAdbControllerType_Input_Preset_Minitouch
• MaaAdbControllerTypeEnum_MaaAdbControllerType_Invalid
• MaaAdbControllerTypeEnum_MaaAdbControllerType_Key_Adb
• MaaAdbControllerTypeEnum_MaaAdbControllerType_Key_AutoDetect
• MaaAdbControllerTypeEnum_MaaAdbControllerType_Key_MaaTouch
• MaaAdbControllerTypeEnum_MaaAdbControllerType_Screencap_Encode
  \deprecated
• MaaAdbControllerTypeEnum_MaaAdbControllerType_Screencap_EncodeToFile
  \deprecated
• MaaAdbControllerTypeEnum_MaaAdbControllerType_Screencap_FastestLosslessWay
  \deprecated
• MaaAdbControllerTypeEnum_MaaAdbControllerType_Screencap_FastestWay
  \deprecated
• MaaAdbControllerTypeEnum_MaaAdbControllerType_Screencap_FastestWay_Compatible
  \deprecated
• MaaAdbControllerTypeEnum_MaaAdbControllerType_Screencap_MinicapDirect
  \deprecated
• MaaAdbControllerTypeEnum_MaaAdbControllerType_Screencap_MinicapStream
  \deprecated
• MaaAdbControllerTypeEnum_MaaAdbControllerType_Screencap_RawByNetcat
  \deprecated
• MaaAdbControllerTypeEnum_MaaAdbControllerType_Screencap_RawWithGzip
  \deprecated
• MaaAdbControllerTypeEnum_MaaAdbControllerType_Touch_Adb
• MaaAdbControllerTypeEnum_MaaAdbControllerType_Touch_AutoDetect
• MaaAdbControllerTypeEnum_MaaAdbControllerType_Touch_MaaTouch
• MaaAdbControllerTypeEnum_MaaAdbControllerType_Touch_MiniTouch
• MaaAdbControllerType_Key_Mask
• MaaAdbControllerType_Screencap_Mask
• MaaAdbControllerType_Touch_Mask
• MaaCtrlOptionEnum_MaaCtrlOption_DefaultAppPackage
  For StopApp
• MaaCtrlOptionEnum_MaaCtrlOption_DefaultAppPackageEntry
  For StartApp
• MaaCtrlOptionEnum_MaaCtrlOption_Invalid
• MaaCtrlOptionEnum_MaaCtrlOption_Recording
  Dump all screenshots and actions
• 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.
• MaaDbgControllerTypeEnum_MaaDbgControllerType_CarouselImage
• MaaDbgControllerTypeEnum_MaaDbgControllerType_ReplayRecording
• MaaDbgControllerTypeEnum_MaaDbgController_Invalid
• MaaGlobalOptionEnum_MaaGlobalOption_DebugMessage
  Whether to callback debug message
• MaaGlobalOptionEnum_MaaGlobalOption_Invalid
• MaaGlobalOptionEnum_MaaGlobalOption_LogDir
  Log dir
• MaaGlobalOptionEnum_MaaGlobalOption_Recording
  Dump all screenshots and actions
• MaaGlobalOptionEnum_MaaGlobalOption_SaveDraw
  Whether to save draw
• MaaGlobalOptionEnum_MaaGlobalOption_ShowHitDraw
  Whether to show hit draw
• MaaGlobalOptionEnum_MaaGlobalOption_StdoutLevel
  The level of log output to stdout
• MaaInstOptionEnum_MaaInstOption_Invalid
• MaaLoggingLevelEunm_MaaLoggingLevel_All
• MaaLoggingLevelEunm_MaaLoggingLevel_Debug
• MaaLoggingLevelEunm_MaaLoggingLevel_Error
• MaaLoggingLevelEunm_MaaLoggingLevel_Fatal
• MaaLoggingLevelEunm_MaaLoggingLevel_Info
• MaaLoggingLevelEunm_MaaLoggingLevel_Off
• MaaLoggingLevelEunm_MaaLoggingLevel_Trace
• MaaLoggingLevelEunm_MaaLoggingLevel_Warn
• MaaResOptionEnum_MaaResOption_Invalid
• MaaStatusEnum_MaaStatus_Failed
• MaaStatusEnum_MaaStatus_Invalid
• MaaStatusEnum_MaaStatus_Pending
• MaaStatusEnum_MaaStatus_Running
• MaaStatusEnum_MaaStatus_Success
• MaaTaskParam_Empty
• MaaThriftControllerTypeEnum_MaaThriftControllerType_Socket
• MaaThriftControllerTypeEnum_MaaThriftControllerType_UnixDomainSocket
• MaaThriftControllerTypeEnum_MaaThriftController_Invalid
• MaaWin32ControllerTypeEnum_MaaWin32ControllerType_Key_SendMessage
• MaaWin32ControllerTypeEnum_MaaWin32ControllerType_Screencap_DXGI_DesktopDup
• MaaWin32ControllerTypeEnum_MaaWin32ControllerType_Screencap_DXGI_FramePool
• MaaWin32ControllerTypeEnum_MaaWin32ControllerType_Screencap_GDI
• MaaWin32ControllerTypeEnum_MaaWin32ControllerType_Touch_SendMessage
• MaaWin32ControllerTypeEnum_MaaWin32Controller_Invalid
• MaaWin32ControllerType_Key_Mask
• MaaWin32ControllerType_Screencap_Mask
• MaaWin32ControllerType_Touch_Mask

Functions

• MaaAdbControllerCreate^⚠
  \deprecated Use MaaAdbControllerCreateV2() instead.
• MaaAdbControllerCreateV2^⚠
  @brief Create a ADB controller instance.
• MaaBindController^⚠
  @brief Bind the instance to an initialized controller.
• MaaBindResource^⚠
  @brief Bind the instance to an initialized resource.
• MaaClearCustomAction^⚠
  @brief Clear all custom actions registered to the instance.
• MaaClearCustomRecognizer^⚠
  @brief Clear all custom recognizers registered to the instance.
• MaaClearImage^⚠
• MaaClearString^⚠
• MaaControllerConnected^⚠
  @brief Check if the controller is connected.
• MaaControllerDestroy^⚠
  @brief Free the controller instance.
• MaaControllerGetImage^⚠
  @brief Get the image buffer of the last screencap request.
• MaaControllerGetUUID^⚠
  @brief Get the UUID of the controller.
• MaaControllerPostClick^⚠
• MaaControllerPostConnection^⚠
  @defgroup MaaControllerPostRequest Controller Requests
• MaaControllerPostInputText^⚠
• MaaControllerPostPressKey^⚠
• MaaControllerPostScreencap^⚠
• MaaControllerPostSwipe^⚠
• MaaControllerPostTouchDown^⚠
• MaaControllerPostTouchMove^⚠
• MaaControllerPostTouchUp^⚠
• MaaControllerSetOption^⚠
  @brief Set options for a given controller instance.
• MaaControllerStatus^⚠
  @brief Get the status of a request identified by the given id.
• MaaControllerWait^⚠
  @brief Wait for the request identified by the given id to complete.
• MaaCreate^⚠
  @brief Create an instance.
• MaaCreateImageBuffer^⚠
• MaaCreateRectBuffer^⚠
• MaaCreateStringBuffer^⚠
• MaaCustomControllerCreate^⚠
  @brief Create a custom controller instance.
• MaaDbgControllerCreate^⚠
• MaaDestroy^⚠
  @brief Free the instance.
• MaaDestroyImageBuffer^⚠
• MaaDestroyRectBuffer^⚠
• MaaDestroyStringBuffer^⚠
• MaaGetController^⚠
  @brief Get the controller handle of the instance.
• MaaGetImageEncoded^⚠
• MaaGetImageEncodedSize^⚠
• MaaGetImageHeight^⚠
• MaaGetImageRawData^⚠
• MaaGetImageType^⚠
• MaaGetImageWidth^⚠
• MaaGetRectH^⚠
• MaaGetRectW^⚠
• MaaGetRectX^⚠
• MaaGetRectY^⚠
• MaaGetResource^⚠
  @brief Get the resource handle of the instance.
• MaaGetString^⚠
• MaaGetStringSize^⚠
• MaaInited^⚠
  @brief Check if the instance is initialized.
• MaaIsImageEmpty^⚠
• MaaIsStringEmpty^⚠
• MaaPostStop^⚠
  @brief Post a stop signal to the instance.
• MaaPostTask^⚠
  @brief Post a task to the instance.
• MaaRegisterCustomAction^⚠
  @brief Register a custom action to the instance.
• MaaRegisterCustomRecognizer^⚠
  @brief Register a custom recognizer to the instance.
• MaaResourceClear^⚠
  @brief Clear the resource loading paths
• MaaResourceCreate^⚠
  @brief Create a resource.
• MaaResourceDestroy^⚠
  @brief Free the resource.
• MaaResourceGetHash^⚠
  @brief Get the hash of the resource.
• MaaResourceGetTaskList^⚠
  @brief Get the task list of the resource.
• MaaResourceLoaded^⚠
  @brief Check if resources are loaded.
• MaaResourcePostPath^⚠
  @brief Add a path to the resource loading paths
• MaaResourceSetOption^⚠
  @brief Set options for a given resource.
• MaaResourceStatus^⚠
  @brief Get the loading status of a resource identified by id.
• MaaResourceWait^⚠
  @brief Wait for a resource to be loaded.
• MaaRunning^⚠
  @brief Is maa running?
• MaaSetGlobalOption^⚠
  @brief Set options globally.
• MaaSetImageEncoded^⚠
• MaaSetImageRawData^⚠
• MaaSetOption^⚠
  @brief Set options for a given instance.
• MaaSetRect^⚠
• MaaSetRectH^⚠
• MaaSetRectW^⚠
• MaaSetRectX^⚠
• MaaSetRectY^⚠
• MaaSetString^⚠
• MaaSetStringEx^⚠
• MaaSetTaskParam^⚠
  @brief Set the parameter of a task.
• MaaStop^⚠
  \deprecated Use MaaPostStop() instead.
• MaaSyncContextClick^⚠
• MaaSyncContextInputText^⚠
• MaaSyncContextPressKey^⚠
• MaaSyncContextRunAction^⚠
• MaaSyncContextRunRecognizer^⚠
• MaaSyncContextRunTask^⚠
• MaaSyncContextScreencap^⚠
• MaaSyncContextSwipe^⚠
• MaaSyncContextTouchDown^⚠
• MaaSyncContextTouchMove^⚠
• MaaSyncContextTouchUp^⚠
• MaaTaskAllFinished^⚠
  \deprecated Use !MaaRunning() instead.
• MaaTaskStatus^⚠
  @brief Get the status of a task identified by the id.
• MaaThriftControllerCreate^⚠
• MaaToolkitFindDevice^⚠
  \deprecated Use MaaToolkitPostFindDevice() and MaaToolkitWaitForFindDeviceToComplete() instead.
• MaaToolkitFindDeviceWithAdb^⚠
  \deprecated Use MaaToolkitPostFindDeviceWithAdb() and MaaToolkitWaitForFindDeviceToComplete() instead.
• MaaToolkitFindWindow^⚠
  @brief Find a win32 window by class name and window name.
• MaaToolkitGetCursorWindow^⚠
  @brief Get the window handle of the window under the cursor. This uses the WindowFromPoint() system API.
• MaaToolkitGetDesktopWindow^⚠
  @brief Get the desktop window handle. This uses the GetDesktopWindow() system API.
• MaaToolkitGetDeviceAdbConfig^⚠
  @brief Get the device ADB config by index.
• MaaToolkitGetDeviceAdbControllerType^⚠
  @brief Get the device ADB controller type by index.
• MaaToolkitGetDeviceAdbPath^⚠
  @brief Get the device ADB path by index.
• MaaToolkitGetDeviceAdbSerial^⚠
  @brief Get the device ADB serial by index.
• MaaToolkitGetDeviceCount^⚠
  @brief Get the number of devices found.
• MaaToolkitGetDeviceName^⚠
  @brief Get the device name by index.
• MaaToolkitGetForegroundWindow^⚠
  @brief Get the foreground window handle. This uses the GetForegroundWindow() system API.
• MaaToolkitGetWindow^⚠
  @brief Get the window handle by index.
• MaaToolkitInit^⚠
  \deprecated Use MaaToolkitInitOptionConfig instead.
• MaaToolkitInitOptionConfig^⚠
• MaaToolkitIsFindDeviceCompleted^⚠
  @brief Check if the find device request is completed.
• MaaToolkitPostFindDevice^⚠
  @brief Post a request to find all ADB devices.
• MaaToolkitPostFindDeviceWithAdb^⚠
  @brief Post a request to find all ADB devices with a given ADB path.
• MaaToolkitRegisterCustomActionExecutor^⚠
• MaaToolkitRegisterCustomRecognizerExecutor^⚠
• MaaToolkitSearchWindow^⚠
  @brief Search a win32 window by class name and window name.
• MaaToolkitUninit^⚠
  \deprecated Don’t use it.
• MaaToolkitUnregisterCustomActionExecutor^⚠
• MaaToolkitUnregisterCustomRecognizerExecutor^⚠
• MaaToolkitWaitForFindDeviceToComplete^⚠
  @brief Wait for the find device request to complete.
• MaaUnregisterCustomAction^⚠
  @brief Unregister a custom action from the instance.
• MaaUnregisterCustomRecognizer^⚠
  @brief Unregister a custom recognizer from the instance.
• MaaVersion^⚠
  @brief Get the version of the framework.
• MaaWaitTask^⚠
  @brief Wait for a task to finish.
• MaaWin32ControllerCreate^⚠
  @brief Create a win32 controller instance.

Type Aliases

• MaaAPICallback
  @brief The callback function type.
• MaaAdbControllerType
• MaaAdbControllerTypeEnum
  @brief ADB controller type
• MaaBool
• MaaCallbackTransparentArg
• MaaControllerCallback
• MaaControllerHandle
• MaaCtrlId
• MaaCtrlOption
• MaaCtrlOptionEnum
  @brief Option keys for controller instance options. See MaaControllerSetOption().
• MaaCustomActionHandle
• MaaCustomControllerHandle
• MaaCustomRecognizerHandle
• MaaDbgControllerType
• MaaDbgControllerTypeEnum
• MaaGlobalOption
• MaaGlobalOptionEnum
• MaaId
• MaaImageBufferHandle
• MaaImageEncodedData
• MaaImageRawData
• MaaInstOption
• MaaInstOptionEnum
• MaaInstanceCallback
• MaaInstanceHandle
• MaaLoggingLevel
• MaaLoggingLevelEunm
• MaaOption
• MaaOptionValue
• MaaOptionValueSize
• MaaRectHandle
• MaaResId
• MaaResOption
• MaaResOptionEnum
• MaaResourceCallback
• MaaResourceHandle
• MaaSize
• MaaStatus
• MaaStatusEnum
• MaaStringBufferHandle
• MaaStringView
• MaaSyncContextHandle
• MaaTaskId
• MaaThriftControllerType
• MaaThriftControllerTypeEnum
• MaaTransparentArg
• MaaWin32ControllerType
• MaaWin32ControllerTypeEnum
  @brief Win32 controller type
• MaaWin32Hwnd
• 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