Macro Handler

Macro Handler

Android Automation Platform

Global FunctionTouch and Actions

Recorder(key, label)

Starts a touch gesture recorder.

Detailed Explanation

This section explains when to use the API, how to call it, and which structures it works best with in production flow.

What It Does

Recorder(key, label) performs one focused job in script flow and can be chained cleanly with other API steps. Starts a touch gesture recorder.

When To Use It

In automation flow, chain actions with short wait() intervals and use requestStop() or controlled retry on failure paths. This API becomes most valuable in touch and control-panel centric scenarios.

Parameters and Return

key, label define the purpose of the call; preparing them in clearly named variables before execution makes production debugging easier. The safest usage pattern is to store the call result in a variable, wrap it with pcall, and pass it into later steps in a controlled way.

Best Combined With

It works best together with wait(), Point, SwipeParam, ClickParam, and sometimes a Region result.

Example Usage

The snippet below is a starter pattern that can be applied directly in runtime flow.

lua
Try in Editor →
Recorder("record", "Record")

Copyable Progressive Examples

From foundation to combined usage, each level is provided as a separate code block so you can copy the level you need and adapt it directly.

Foundation

Shows the shortest direct way to call the API.

Foundation
lua
Try in Editor →
Recorder("record", "Record")

Simple

Wraps the base call with minimal flow control.

Simple
lua
Try in Editor →
local stepOk = true
Recorder("record", "Record")
if stepOk then
  wait(200)
end

Practical Flow

A practical pattern for real macros with pcall, logging, and guards.

Practical Flow
lua
Try in Editor →
local ok, result = pcall(function()
  Recorder("record", "Record")
end)

if not ok then
  print("API step failed: Recorder(key, label)")
  requestStop()
end

Detailed

This level packages the API into a reusable helper with error reporting.

Detailed
lua
Try in Editor →
-- In automation flow, chain actions with short wait() intervals and use requestStop() or controlled retry on failure paths.
local function run_recorder_step()
  Recorder("record", "Record")
end

local ok, err = pcall(run_recorder_step)
if not ok then
  toast("Step failed")
  print(err)
end

Combined

Combines the API with related structures to form a more realistic workflow.

Combined
lua
Try in Editor →
local target = Point(540, 960)
quickTap(target)
wait(250)
Recorder("record", "Record")
wait(250)
print("Automation chain completed")