Skip to main content

record

Start recording the current browser viewport. Must be followed by a stopRecord step. Only runs in Chrome browsers when they are visible. Supported extensions: [ '.mp4', '.webm', '.gif' ]

Fields

FieldTypeDescriptionDefault
pathstringOptional. File path of the recording. Supports the .mp4, .webm, and .gif extensions. If not specified, the file name is the ID of the step, and the extension is .mp4.
directorystringOptional. Directory of the file. If the directory doesn't exist, creates the directory.
overwritestringOptional. If true, overwrites the existing recording at path if it exists.

Accepted values: true, false

Examples

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