Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add advice on video compression #1880

Merged
merged 4 commits into from
Jul 17, 2019
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions source/guides/guides/screenshots-and-videos.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,38 @@ When using the `--record` flag while running your tests, videos are processed, c

Cypress clears any existing videos before a `cypress run`. If you do not want to clear your videos folder before a run, you can set {% url `trashAssetsBeforeRuns` configuration#Videos %} to `false`.

## Video encoding

If your specs are long, you might notice a time gap between a finished spec and a new spec starting. Cypress is encoding the captured video and possibly uploading it to the Dashboard. If the machine is encoding video slowly (which is often the case for virtual machines that use a single core), the encoding might take long time. In this case, you can modify the {% url `videoCompression` configuration#Videos %} parameter to make the encoding a little bit faster. Here are the common scenarios:

**Use minimal compression**

```json
{
"videoCompression": 0
}
```

The video will be larger, but the processing should be faster.

**Disable compression**

```json
{
"videoCompression": false
}
```

The compression step will be skipped completely, the video will be large.

{% note info %}
If you are a `ffmpeg` pro, and want to see all the settings and debug messages during the encoding, run Cypress with the following environment variable:

```text
DEBUG=cypress:server:video cypress run ...
```
{% endnote %}

# Now What?

So you are capturing screenshots and recording videos of your test runs, now what?
Expand Down