Object MethodScanning and Detection

Capture:stop()

Starts or stops a Capture 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

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

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. This API becomes most valuable in screen-driven decision scenarios.

Parameters and Return

This entry does not require mandatory parameters. 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 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

-- Capture:stop
local result = Capture:stop()
-- 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

-- Capture:stop
local result = Capture:stop()
-- Use the result in your script flow

Simple

Wraps the base call with minimal flow control.

Simple

lua

local stepOk = true
-- Capture:stop
local result = Capture:stop()
-- 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()
  -- Capture:stop
  local result = Capture:stop()
  -- Use the result in your script flow
end)

if not ok then
  print("API step failed: Capture:stop")
  requestStop()
end

Detailed

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

Detailed

lua

-- In detection flow, refresh the screen with Snap.screenRefresh() first, then narrow the search area and confidence using Region and FindParam.
local function run_stop_step()
  -- Capture:stop
  local result = Capture:stop()
  -- Use the result in your script flow
end

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

Snap.screenRefresh()
local region = Region()
local param = FindParam()
param:timeout(3000)

local result = region:find(Asset.image("target"), param)
if result then
  quickTap(result)
  wait(250)
  toast("Detection step completed")
end