Take a screenshot of a screen
capture_screenshotTake a new screenshot of one screen and return it as an image; nothing on the screen changes.
When to use:
Checking what a screen shows, e.g. after set_screen_content or control_screens.
When NOT to use:
Learning why: use get_screen_status. Polling in a loop.
What to know:
Waits up to about 5 seconds; a slow or offline screen returns its last frame with fresh:false. A frame over 2 MB returns latestFrameUrl only. Needs screen.edit (it sends a device command).
Parameters:
screenId: one scr_… id from list_items kind screens; for several screens, call once each. An id outside this connection's reach reads as not found and nothing is sent.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| screenId | Yes | Screen id. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fresh | No | true when the frame was taken after this call. | |
| latestFrameAt | No | ISO 8601 time the returned frame was taken. | |
| latestFrameUrl | No | Link to the frame. | |
| latestScreenshotId | No | Id of the stored frame. |