MaaContext.h File Reference

Context is a context for running tasks, recognitions, actions, and other operations. More...

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

Go to the source code of this file.

Functions
MAA_FRAMEWORK_API MaaTaskId	MaaContextRunTask (MaaContext *context, const char *entry, const char *pipeline_override)
MAA_FRAMEWORK_API MaaRecoId	MaaContextRunRecognition (MaaContext *context, const char *entry, const char *pipeline_override, const MaaImageBuffer *image)
MAA_FRAMEWORK_API MaaActId	MaaContextRunAction (MaaContext *context, const char *entry, const char *pipeline_override, const MaaRect *box, const char *reco_detail)
MAA_FRAMEWORK_API MaaRecoId	MaaContextRunRecognitionDirect (MaaContext *context, const char *reco_type, const char *reco_param, const MaaImageBuffer *image)
	Run recognition directly with type and parameters, without requiring a pipeline entry.
MAA_FRAMEWORK_API MaaActId	MaaContextRunActionDirect (MaaContext *context, const char *action_type, const char *action_param, const MaaRect *box, const char *reco_detail)
	Run action directly with type and parameters, without requiring a pipeline entry.
MAA_FRAMEWORK_API MaaBool	MaaContextOverridePipeline (MaaContext *context, const char *pipeline_override)
MAA_FRAMEWORK_API MaaBool	MaaContextOverrideNext (MaaContext *context, const char *node_name, const MaaStringListBuffer *next_list)
MAA_FRAMEWORK_API MaaBool	MaaContextOverrideImage (MaaContext *context, const char *image_name, const MaaImageBuffer *image)
MAA_FRAMEWORK_API MaaBool	MaaContextGetNodeData (MaaContext *context, const char *node_name, MaaStringBuffer *buffer)
MAA_FRAMEWORK_API MaaTaskId	MaaContextGetTaskId (const MaaContext *context)
MAA_FRAMEWORK_API MaaTasker *	MaaContextGetTasker (const MaaContext *context)
MAA_FRAMEWORK_API MaaContext *	MaaContextClone (const MaaContext *context)
MAA_FRAMEWORK_API MaaBool	MaaContextSetAnchor (MaaContext *context, const char *anchor_name, const char *node_name)
MAA_FRAMEWORK_API MaaBool	MaaContextGetAnchor (MaaContext *context, const char *anchor_name, MaaStringBuffer *buffer)
MAA_FRAMEWORK_API MaaBool	MaaContextGetHitCount (MaaContext *context, const char *node_name, MaaSize *count)
MAA_FRAMEWORK_API MaaBool	MaaContextClearHitCount (MaaContext *context, const char *node_name)

Detailed Description

Context is a context for running tasks, recognitions, actions, and other operations.

Author

Copyright

Copyright (c) 2024

Function Documentation

MaaContextRunTask()

MAA_FRAMEWORK_API MaaTaskId MaaContextRunTask	(	MaaContext *	context,
		const char *	entry,
		const char *	pipeline_override
	)

MaaContextRunRecognition()

MAA_FRAMEWORK_API MaaRecoId MaaContextRunRecognition	(	MaaContext *	context,
		const char *	entry,
		const char *	pipeline_override,
		const MaaImageBuffer *	image
	)

MaaContextRunAction()

MAA_FRAMEWORK_API MaaActId MaaContextRunAction	(	MaaContext *	context,
		const char *	entry,
		const char *	pipeline_override,
		const MaaRect *	box,
		const char *	reco_detail
	)

MaaContextRunRecognitionDirect()

MAA_FRAMEWORK_API MaaRecoId MaaContextRunRecognitionDirect	(	MaaContext *	context,
		const char *	reco_type,
		const char *	reco_param,
		const MaaImageBuffer *	image
	)

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

Parameters

reco_type	Recognition type string (e.g., "OCR", "TemplateMatch")
reco_param	Recognition parameters json
image	Image to recognize

MaaContextRunActionDirect()

MAA_FRAMEWORK_API MaaActId MaaContextRunActionDirect	(	MaaContext *	context,
		const char *	action_type,
		const char *	action_param,
		const MaaRect *	box,
		const char *	reco_detail
	)

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

Parameters

action_type	Action type string (e.g., "Click", "Swipe")
action_param	Action parameters json
box	Previous recognition position
reco_detail	Previous recognition details

MaaContextOverridePipeline()

MAA_FRAMEWORK_API MaaBool MaaContextOverridePipeline	(	MaaContext *	context,
		const char *	pipeline_override
	)

MaaContextOverrideNext()

MAA_FRAMEWORK_API MaaBool MaaContextOverrideNext	(	MaaContext *	context,
		const char *	node_name,
		const MaaStringListBuffer *	next_list
	)

MaaContextOverrideImage()

MAA_FRAMEWORK_API MaaBool MaaContextOverrideImage	(	MaaContext *	context,
		const char *	image_name,
		const MaaImageBuffer *	image
	)

MaaContextGetNodeData()

MAA_FRAMEWORK_API MaaBool MaaContextGetNodeData	(	MaaContext *	context,
		const char *	node_name,
		MaaStringBuffer *	buffer
	)

MaaContextGetTaskId()

MAA_FRAMEWORK_API MaaTaskId MaaContextGetTaskId

(

const MaaContext *

context

)

MaaContextGetTasker()

MAA_FRAMEWORK_API MaaTasker * MaaContextGetTasker

(

const MaaContext *

context

)

MaaContextClone()

MAA_FRAMEWORK_API MaaContext * MaaContextClone

(

const MaaContext *

context

)

MaaContextSetAnchor()

MAA_FRAMEWORK_API MaaBool MaaContextSetAnchor	(	MaaContext *	context,
		const char *	anchor_name,
		const char *	node_name
	)

MaaContextGetAnchor()

MAA_FRAMEWORK_API MaaBool MaaContextGetAnchor	(	MaaContext *	context,
		const char *	anchor_name,
		MaaStringBuffer *	buffer
	)

MaaContextGetHitCount()

MAA_FRAMEWORK_API MaaBool MaaContextGetHitCount	(	MaaContext *	context,
		const char *	node_name,
		MaaSize *	count
	)

MaaContextClearHitCount()

MAA_FRAMEWORK_API MaaBool MaaContextClearHitCount	(	MaaContext *	context,
		const char *	node_name
	)