MaaTasker.h File Reference

The tasker API. More...

#include "../MaaDef.h"
#include "../MaaPort.h"

Go to the source code of this file.

Functions
MAA_FRAMEWORK_API MaaTasker *	MaaTaskerCreate ()
MAA_FRAMEWORK_API void	MaaTaskerDestroy (MaaTasker *tasker)
MAA_FRAMEWORK_API MaaSinkId	MaaTaskerAddSink (MaaTasker *tasker, MaaEventCallback sink, void *trans_arg)
MAA_FRAMEWORK_API void	MaaTaskerRemoveSink (MaaTasker *tasker, MaaSinkId sink_id)
MAA_FRAMEWORK_API void	MaaTaskerClearSinks (MaaTasker *tasker)
MAA_FRAMEWORK_API MaaSinkId	MaaTaskerAddContextSink (MaaTasker *tasker, MaaEventCallback sink, void *trans_arg)
MAA_FRAMEWORK_API void	MaaTaskerRemoveContextSink (MaaTasker *tasker, MaaSinkId sink_id)
MAA_FRAMEWORK_API void	MaaTaskerClearContextSinks (MaaTasker *tasker)
MAA_FRAMEWORK_API MaaBool	MaaTaskerSetOption (MaaTasker *tasker, MaaTaskerOption key, MaaOptionValue value, MaaOptionValueSize val_size)
MAA_FRAMEWORK_API MaaBool	MaaTaskerBindResource (MaaTasker *tasker, MaaResource *res)
MAA_FRAMEWORK_API MaaBool	MaaTaskerBindController (MaaTasker *tasker, MaaController *ctrl)
MAA_FRAMEWORK_API MaaBool	MaaTaskerInited (const MaaTasker *tasker)
MAA_FRAMEWORK_API MaaTaskId	MaaTaskerPostTask (MaaTasker *tasker, const char *entry, const char *pipeline_override)
MAA_FRAMEWORK_API MaaTaskId	MaaTaskerPostRecognition (MaaTasker *tasker, const char *reco_type, const char *reco_param, const MaaImageBuffer *image)
MAA_FRAMEWORK_API MaaTaskId	MaaTaskerPostAction (MaaTasker *tasker, const char *action_type, const char *action_param, const MaaRect *box, const char *reco_detail)
MAA_FRAMEWORK_API MaaStatus	MaaTaskerStatus (const MaaTasker *tasker, MaaTaskId id)
MAA_FRAMEWORK_API MaaStatus	MaaTaskerWait (const MaaTasker *tasker, MaaTaskId id)
MAA_FRAMEWORK_API MaaBool	MaaTaskerRunning (const MaaTasker *tasker)
MAA_FRAMEWORK_API MaaTaskId	MaaTaskerPostStop (MaaTasker *tasker)
MAA_FRAMEWORK_API MaaBool	MaaTaskerStopping (const MaaTasker *tasker)
MAA_FRAMEWORK_API MaaResource *	MaaTaskerGetResource (const MaaTasker *tasker)
MAA_FRAMEWORK_API MaaController *	MaaTaskerGetController (const MaaTasker *tasker)
MAA_FRAMEWORK_API MaaBool	MaaTaskerClearCache (MaaTasker *tasker)
MAA_FRAMEWORK_API MaaBool	MaaTaskerGetRecognitionDetail (const MaaTasker *tasker, MaaRecoId reco_id, MaaStringBuffer *node_name, MaaStringBuffer *algorithm, MaaBool *hit, MaaRect *box, MaaStringBuffer *detail_json, MaaImageBuffer *raw, MaaImageListBuffer *draws)
MAA_FRAMEWORK_API MaaBool	MaaTaskerGetActionDetail (const MaaTasker *tasker, MaaActId action_id, MaaStringBuffer *node_name, MaaStringBuffer *action, MaaRect *box, MaaBool *success, MaaStringBuffer *detail_json)
MAA_FRAMEWORK_API MaaBool	MaaTaskerGetNodeDetail (const MaaTasker *tasker, MaaNodeId node_id, MaaStringBuffer *node_name, MaaRecoId *reco_id, MaaActId *action_id, MaaBool *completed)
MAA_FRAMEWORK_API MaaBool	MaaTaskerGetTaskDetail (const MaaTasker *tasker, MaaTaskId task_id, MaaStringBuffer *entry, MaaNodeId *node_id_list, MaaSize *node_id_list_size, MaaStatus *status)
MAA_FRAMEWORK_API MaaBool	MaaTaskerGetLatestNode (const MaaTasker *tasker, const char *node_name, MaaNodeId *latest_id)

Detailed Description

The tasker API.

Author

Copyright

Copyright (c) 2024

Function Documentation

MaaTaskerCreate()

MAA_FRAMEWORK_API MaaTasker * MaaTaskerCreate

(

)

MaaTaskerDestroy()

MAA_FRAMEWORK_API void MaaTaskerDestroy

(

MaaTasker *

tasker

)

MaaTaskerAddSink()

MAA_FRAMEWORK_API MaaSinkId MaaTaskerAddSink	(	MaaTasker *	tasker,
		MaaEventCallback	sink,
		void *	trans_arg
	)

MaaTaskerRemoveSink()

MAA_FRAMEWORK_API void MaaTaskerRemoveSink	(	MaaTasker *	tasker,
		MaaSinkId	sink_id
	)

MaaTaskerClearSinks()

MAA_FRAMEWORK_API void MaaTaskerClearSinks

(

MaaTasker *

tasker

)

MaaTaskerAddContextSink()

MAA_FRAMEWORK_API MaaSinkId MaaTaskerAddContextSink	(	MaaTasker *	tasker,
		MaaEventCallback	sink,
		void *	trans_arg
	)

MaaTaskerRemoveContextSink()

MAA_FRAMEWORK_API void MaaTaskerRemoveContextSink	(	MaaTasker *	tasker,
		MaaSinkId	sink_id
	)

MaaTaskerClearContextSinks()

MAA_FRAMEWORK_API void MaaTaskerClearContextSinks

(

MaaTasker *

tasker

)

MaaTaskerSetOption()

MAA_FRAMEWORK_API MaaBool MaaTaskerSetOption	(	MaaTasker *	tasker,
		MaaTaskerOption	key,
		MaaOptionValue	value,
		MaaOptionValueSize	val_size
	)

Parameters

[in]

value

Parameters

value

byte array, int*, char*, bool*

MaaTaskerBindResource()

MAA_FRAMEWORK_API MaaBool MaaTaskerBindResource	(	MaaTasker *	tasker,
		MaaResource *	res
	)

MaaTaskerBindController()

MAA_FRAMEWORK_API MaaBool MaaTaskerBindController	(	MaaTasker *	tasker,
		MaaController *	ctrl
	)

MaaTaskerInited()

MAA_FRAMEWORK_API MaaBool MaaTaskerInited

(

const MaaTasker *

tasker

)

MaaTaskerPostTask()

MAA_FRAMEWORK_API MaaTaskId MaaTaskerPostTask	(	MaaTasker *	tasker,
		const char *	entry,
		const char *	pipeline_override
	)

MaaTaskerPostRecognition()

MAA_FRAMEWORK_API MaaTaskId MaaTaskerPostRecognition	(	MaaTasker *	tasker,
		const char *	reco_type,
		const char *	reco_param,
		const MaaImageBuffer *	image
	)

Parameters

reco_type	Recognition type string
reco_param	Recognition parameters json
image	Previous screenshot

MaaTaskerPostAction()

MAA_FRAMEWORK_API MaaTaskId MaaTaskerPostAction	(	MaaTasker *	tasker,
		const char *	action_type,
		const char *	action_param,
		const MaaRect *	box,
		const char *	reco_detail
	)

Parameters

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

MaaTaskerStatus()

MAA_FRAMEWORK_API MaaStatus MaaTaskerStatus	(	const MaaTasker *	tasker,
		MaaTaskId	id
	)

MaaTaskerWait()

MAA_FRAMEWORK_API MaaStatus MaaTaskerWait	(	const MaaTasker *	tasker,
		MaaTaskId	id
	)

MaaTaskerRunning()

MAA_FRAMEWORK_API MaaBool MaaTaskerRunning

(

const MaaTasker *

tasker

)

MaaTaskerPostStop()

MAA_FRAMEWORK_API MaaTaskId MaaTaskerPostStop

(

MaaTasker *

tasker

)

MaaTaskerStopping()

MAA_FRAMEWORK_API MaaBool MaaTaskerStopping

(

const MaaTasker *

tasker

)

MaaTaskerGetResource()

MAA_FRAMEWORK_API MaaResource * MaaTaskerGetResource

(

const MaaTasker *

tasker

)

MaaTaskerGetController()

MAA_FRAMEWORK_API MaaController * MaaTaskerGetController

(

const MaaTasker *

tasker

)

MaaTaskerClearCache()

MAA_FRAMEWORK_API MaaBool MaaTaskerClearCache

(

MaaTasker *

tasker

)

MaaTaskerGetRecognitionDetail()

MAA_FRAMEWORK_API MaaBool MaaTaskerGetRecognitionDetail	(	const MaaTasker *	tasker,
		MaaRecoId	reco_id,
		MaaStringBuffer *	node_name,
		MaaStringBuffer *	algorithm,
		MaaBool *	hit,
		MaaRect *	box,
		MaaStringBuffer *	detail_json,
		MaaImageBuffer *	raw,
		MaaImageListBuffer *	draws
	)

Parameters

[out]

hit

MaaTaskerGetActionDetail()

MAA_FRAMEWORK_API MaaBool MaaTaskerGetActionDetail	(	const MaaTasker *	tasker,
		MaaActId	action_id,
		MaaStringBuffer *	node_name,
		MaaStringBuffer *	action,
		MaaRect *	box,
		MaaBool *	success,
		MaaStringBuffer *	detail_json
	)

Parameters

[out]	action
[out]	box
[out]	success
[out]	detail_json

MaaTaskerGetNodeDetail()

MAA_FRAMEWORK_API MaaBool MaaTaskerGetNodeDetail	(	const MaaTasker *	tasker,
		MaaNodeId	node_id,
		MaaStringBuffer *	node_name,
		MaaRecoId *	reco_id,
		MaaActId *	action_id,
		MaaBool *	completed
	)

Parameters

[out]	reco_id
[out]	action_id
[out]	completed

MaaTaskerGetTaskDetail()

MAA_FRAMEWORK_API MaaBool MaaTaskerGetTaskDetail	(	const MaaTasker *	tasker,
		MaaTaskId	task_id,
		MaaStringBuffer *	entry,
		MaaNodeId *	node_id_list,
		MaaSize *	node_id_list_size,
		MaaStatus *	status
	)

Parameters

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

Parameters

node_id_list

array

MaaTaskerGetLatestNode()

MAA_FRAMEWORK_API MaaBool MaaTaskerGetLatestNode	(	const MaaTasker *	tasker,
		const char *	node_name,
		MaaNodeId *	latest_id
	)

Parameters

[out]

latest_id