startRecording
Begin capturing one window or display to record a demo; optionally add webcam, microphone, or system audio, return once capture starts, then drive the app and stop when done.
Instructions
Start recording one window (preferred: nothing else on the desktop is captured) or one display. Returns once capture has started; then drive the app and call stopRecording. By default the pointer is recorded as data, so the export draws a clean cursor and the zooms planned from the clicks. A webcam recorded with it shows as a picture-in-picture in the project. Hiding the desktop icons follows the user's own Record mode setting. On Linux the desktop's own picker asks the user which window to record.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| camera | No | Also record the webcam: true for the default camera, or part of a camera's name. | |
| cursor | No | editable-overlay (default): the pointer is recorded as data, drawn clean by the export, with zooms on its clicks. system: the system's own pointer is burned into the video, with no zooms on clicks and no setPointerTrack. | |
| window | No | Part of the title of the window to record, ignoring case. Wins over display. | |
| display | No | Index of the display to record, from listSources. Default 0. | |
| microphone | No | true for the default microphone, or part of a microphone's name. | |
| systemAudio | No | Also record the computer's sound. |