Macro Handler

Macro Handler

Android Automation Platform

Object MethodScanning and Detection

Region:beginVisualTargetFrame()

Pins one fresh shared screenshot for subsequent visual searches. Returns true when opened, or false when capture is unavailable or a frame is already open. Release it with endVisualTargetFrame before running actions.

Documented for app version 1.0.57Updated:

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

This is an object method: call it with a colon on a Region object created with Region(x, y, w, h), or Region() for the whole screen (region:<method>(...)). The global Region table does not have this method.

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

Takes no arguments. Returns a boolean (true or false).

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 →
local owner = Region()
if owner:beginVisualTargetFrame() then
  local ok, err = pcall(function()
    -- Run the related visual searches here.
  end)
  owner:endVisualTargetFrame()
  if not ok then error(err) end
end

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 →
local owner = Region()
if owner:beginVisualTargetFrame() then
  local ok, err = pcall(function()
    -- Run the related visual searches here.
  end)
  owner:endVisualTargetFrame()
  if not ok then error(err) end
end

Simple

Wraps the base call with minimal flow control.

Simple
lua
Try in Editor →
local stepOk = true
local owner = Region()
if owner:beginVisualTargetFrame() then
  local ok, err = pcall(function()
    -- Run the related visual searches here.
  end)
  owner:endVisualTargetFrame()
  if not ok then error(err) end
end
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()
  local owner = Region()
  if owner:beginVisualTargetFrame() then
    local ok, err = pcall(function()
      -- Run the related visual searches here.
    end)
    owner:endVisualTargetFrame()
    if not ok then error(err) end
  end
end)

if not ok then
  print("API step failed: Region:beginVisualTargetFrame: " .. 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_beginvisualtargetframe_step()
  local owner = Region()
  if owner:beginVisualTargetFrame() then
    local ok, err = pcall(function()
      -- Run the related visual searches here.
    end)
    owner:endVisualTargetFrame()
    if not ok then error(err) end
  end
end

local ok, err = pcall(run_beginvisualtargetframe_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()
local owner = Region()
if owner:beginVisualTargetFrame() then
  local ok, err = pcall(function()
    -- Run the related visual searches here.
  end)
  owner:endVisualTargetFrame()
  if not ok then error(err) end
end

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