Macro Handler

Macro Handler

Android Automation Platform

Object MethodScanning and Detection

Snap.region(region)

Limits screen capture to the given Region and takes a fresh frame.

Documented for app version 1.0.51Updated:

Detailed Explanation

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

How To Call It

Snap is a global table: call its functions with a dot (Snap.<method>(...)), not a colon.

When To Use It

In detection flow, refresh the screen with Snap.screenRefresh() first, then narrow the search area and confidence using Region and FindParam.

Parameters and Return

Required: region. Returns nothing.

Best Combined With

It is typically combined with Snap, Region, Asset, and FindParam; you can feed the result into quickTap(), click(), or a follow-up OCR step.

Example Usage

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

lua
Try in Editor →
Snap.region(Region(0, 0, 540, 960))

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 →
Snap.region(Region(0, 0, 540, 960))

Simple

Wraps the base call with minimal flow control.

Simple
lua
Try in Editor →
local stepOk = true
Snap.region(Region(0, 0, 540, 960))
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, err = pcall(function()
  Snap.region(Region(0, 0, 540, 960))
end)

if not ok then
  print("API step failed: Snap.region: " .. tostring(err))
  requestStop()
end

Detailed

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

Detailed
lua
Try in Editor →
-- In detection flow, refresh the screen with Snap.screenRefresh() first, then narrow the search area and confidence using Region and FindParam.
local function run_region_step()
  Snap.region(Region(0, 0, 540, 960))
end

local ok, err = pcall(run_region_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 →
Snap.screenRefresh()
Snap.region(Region(0, 0, 540, 960))

local target = Region():find(Asset.image("target"), FindParam.timeout(3000))
if target then
  quickTap(target)
end
toast("Detection step completed")