record | Doc Detective

Referenced In

Fields

Field	Type	Description	Default
record	one of: - string - object(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

{
  "record": true
}

{
  "record": "results.mp4"
}

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

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

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

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

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

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

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