Capture

Read the capture region

The capture region VisionPiper holds (vision_region_get): the rect, the display it sits on, its generation, whether the border indicator is showing and whether a recording is running. status is no_region when no region is stored, and region / display_id are then absent.

Refusals use the precondition_failed envelope with a typed reason (visionpiper_unavailable), so a caller classifies instead of parsing the message.

get/v1/vision/region

Request

  • Base URL: http://localhost:9998
  • URL: http://localhost:9998/v1/vision/region
  • Auth: HTTP bearer

Response

The current capture region state

status'ready' | 'no_region' | 'region_set' required
generationinteger required

Region generation; moves every time the region changes.

recordingboolean required

Whether a recording is running.

selection_pendingboolean required

Whether the drag-to-select overlay is waiting for the user.

display_idinteger

CGDirectDisplayID the region sits on.

indicator_visibleboolean

Whether the region's border indicator is showing.

Changes

No recorded changes to this operation across all 1 revision of this API.