Object MethodTouch and Actions

Replay:start(config?)

Starts or stops a Replay process.

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

Replay:start performs one focused job in script flow and can be chained cleanly with other API steps. Starts or stops a Replay process.

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

config define the purpose of the call; preparing them in clearly named variables before execution makes production debugging easier. This API is primarily side-effect driven; the important result is the device state change rather than the raw return value.

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

-- Replay:start
local result = Replay:start({})
-- Use the result in your script flow

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

-- Replay:start
local result = Replay:start({})
-- Use the result in your script flow

Simple

Wraps the base call with minimal flow control.

Simple

lua

local stepOk = true
-- Replay:start
local result = Replay:start({})
-- Use the result in your script flow
if stepOk then
  wait(200)
end

Practical Flow

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

Practical Flow

lua

local ok, result = pcall(function()
  -- Replay:start
  local result = Replay:start({})
  -- Use the result in your script flow
end)

if not ok then
  print("API step failed: Replay:start")
  requestStop()
end

Detailed

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

Detailed

lua

-- In automation flow, chain actions with short wait() intervals and use requestStop() or controlled retry on failure paths.
local function run_start_step()
  -- Replay:start
  local result = Replay:start({})
  -- Use the result in your script flow
end

local ok, err = pcall(run_start_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

local target = Point(540, 960)
quickTap(target)
wait(250)
-- Replay:start
local result = Replay:start({})
-- Use the result in your script flow
wait(250)
print("Automation chain completed")