> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.doc-detective.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.doc-detective.com/_mcp/server.

# record

> Reference for the `record` schema.

## Referenced In

* [Markup definition](/reference/schemas/markup-definition)
* [test](/reference/schemas/test)
* [Resolved context](/reference/schemas/resolved-context)

## Fields

| Field  | Type                                                                                         | Description                                                                                                                                                                                                                                                                                                                                                                                 | Default |
| :----- | :------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :------ |
| record | one of: - string - object([Record (detailed)](/reference/schemas/record-detailed)) - boolean | Required. Start recording. Must be followed by a `stopRecord` step. The `browser` engine captures the Chrome viewport (works under concurrency); the `ffmpeg` engine captures the screen and supports any application. On Android/iOS contexts, recording captures the device screen through the device itself — `engine` doesn't apply. Supported extensions: \[ '.mp4', '.webm', '.gif' ] | —       |

## Examples

```json
{
  "record": true
}
```

```json
{
  "record": "results.mp4"
}
```

```json
{
  "record": {
    "path": "results.mp4",
    "directory": "static/media",
    "overwrite": "true"
  }
}
```

```json
{
  "record": {
    "path": "results.mp4",
    "engine": "ffmpeg"
  }
}
```

```json
{
  "record": {
    "path": "results.mp4",
    "checkpoints": true
  }
}
```

```json
{
  "record": {
    "path": "results.mp4",
    "checkpoints": {
      "maxVariation": 0.02,
      "directory": "baselines/results"
    }
  }
}
```

```json
{
  "record": {
    "path": "results.mp4",
    "engine": {
      "name": "ffmpeg",
      "target": "window",
      "fps": 60
    }
  }
}
```

```json
{
  "record": {
    "path": "notepad.mp4",
    "surface": {
      "app": "notepad"
    }
  }
}
```

```json
{
  "record": {
    "path": "full-screen.mp4",
    "surface": {
      "app": "notepad"
    },
    "engine": {
      "name": "ffmpeg",
      "target": "display"
    }
  }
}
```