类型 Session

Open starts config's application in a driver and paints its first frame. canvas may be nil.

Click clicks at a logical-pixel point.

ClickLabel clicks the center of the region labelled label.

Close releases the session.

DoubleClick double-clicks at a logical-pixel point.

DoubleClickLabel double-clicks the center of the region labelled label.

Driver exposes the underlying driver for operations the session does not wrap.

Drop delivers files dragged from the system onto a logical-pixel window point. With ui.FileDropOver it is the hover, with ui.FileDropDrop the drop; the result is whether the hit under the point takes files.

HasText reports whether any painted text contains substring.

Hit returns the front-most reachable region whose accessibility label is exactly label, or failing that contains it (case-insensitively).

Image renders the current frame at the session's scale, window chrome the platform draws over the scene included.

KeyDown presses and holds one key named as Keys names it, without modifiers: a key such as "left" or "x", or a modifier such as "shift", "ctrl", "alt", "cmd" (left side; "rshift", "rctrl", "ralt", "rcmd" for the right). Modifiers stay held for every pointer, scroll and key until KeyUp.

KeyUp releases a key KeyDown pressed.

Keys delivers a key chord written as plus-separated parts, for example "tab", "shift+tab", "enter", "backspace", "left", "cmd+a", or a single character such as "x". Command chords are editing shortcuts in text fields; Control and a terminal-configured Alt chord are raw application input. A bare character is typed into the focused text field.

LoseFocus makes the window lose the keyboard: held keys are released.

Move moves the pointer to a logical-pixel point.

Press presses the primary button at a point; Release releases it.

PressAt reports what a press at a point would do in a custom-titlebar window (see app.Driver.PressAt).

Record plays options.Duration of animation and writes it to dir as a PNG sequence, frame-0000.png onwards, plus a manifest.json that says how long each frame is on screen. A frame whose pixels did not change is written once and its duration grows instead, so an application at rest records as one still frame rather than hundreds, and a recording costs disk only where something moved. The number of PNG files written is returned; when Record fails partway that is how many were written before the error.

Recording needs the offscreen renderer Image needs, and returns ErrNoRenderer without one. dir is created when it does not exist; use a fresh directory per recording, because a recording shorter than an earlier one in the same directory leaves that recording's frames behind (the manifest lists the ones this one wrote).

The manifest is:

{
  "version": 1,
  "width": 1400, "height": 900, "scale": 2, "fps": 60,
  "duration_ns": 700000000,
  "frames": [{"file": "frame-0000.png", "duration_ns": 16666666}, ...]
}

width and height are logical pixels; the PNG files are scale times that. The durations sum to duration_ns. ffmpeg assembles them with a concat script (file frame-0000.png, duration 0.016666666, and so on), or the frames can be reviewed one by one.

Release releases the primary button at a point.

Resize changes the content size in logical pixels.

Rest advances the animation clock until no transition is in flight, so the frame shows the interface at rest: a dialog that has just been opened is in, not still fading. A slow display, such as a spinner, does not hold it. The clock moves at most five seconds.

RightClick presses and releases the secondary button at a logical-pixel point, which is what opens a context menu.

RightClickLabel right-clicks the center of the region labelled label.

Screenshot renders the current frame to a PNG file.

Scroll delivers a scroll gesture at a logical-pixel window point.

SetSystemAppearance changes the system appearance the run reports, and tells whoever watches it, as the system would.

Settle applies background wakes until none arrives for quiet, or timeout passes, so work that was kicked off has landed before the next look.

Snapshot captures the current frame.

Texts returns every text the application painted, in paint order.

Type inserts text into the focused text field.

Wait advances the animation clock.

WaitFor applies background wakes in real time until condition holds for the current frame, or timeout passes. It is for work that takes real time, such as a network connection. The real time it waits also passes for the application's timers: a frame the application asked for in 400 ms is due after 400 ms of waiting, as in a window, so a page that hands over after a delay does so here too. Animations that a script wants to step exactly are moved with Wait instead.