Test.Sandwich.WebDriver.Video

Functions for recording videos of browser windows.

Documentation

startBrowserVideoRecording

Arguments

:: (BaseVideoConstraints context m, WebDriver m)

=> FilePath

Output path

-> VideoSettings

-> m VideoProcess

Wrapper around startVideoRecording which uses WebDriver to find the rectangle corresponding to the browser.

startFullScreenVideoRecording

Arguments

:: BaseVideoConstraints context m

=> FilePath

Output path

-> VideoSettings

-> m VideoProcess

Wrapper around startVideoRecording which uses the full screen dimensions.

Lower-level

startVideoRecording

Arguments

:: BaseVideoConstraints context m

=> FilePath

Output path

-> (Word, Word, Int, Int)

Rectangle to record, specified as (width, height, x, y)

-> VideoSettings

-> m VideoProcess

Returns handle to video process and list of files created

Record video to a given path, for a given screen rectangle.

endVideoRecording :: (MonadLoggerIO m, MonadUnliftIO m) => VideoProcess -> m ()

Gracefully stop the ProcessHandle returned by startVideoRecording.

Wrap a test to conditionally record video

recordVideoIfConfigured

Arguments

:: (BaseVideoConstraints context m, WebDriver m, HasSomeCommandLineOptions context)

=> String

Session name

-> m a

-> m a

Record video around a given action, if configured to do so in the CommandLineWebdriverOptions.

This can be used to record video around individual tests. It can also keep videos only in case of exceptions, deleting them on successful runs.

Configuration

data VideoSettings

Constructors

VideoSettings

Fields

• xcbgrabOptions :: [String]

  Arguments to x11grab, used with Linux.

• avfoundationOptions :: [String]

  Arguments to avfoundation, used with OS X.

• gdigrabOptions :: [String]

  Arguments to gdigrab, used with Windows.

• hideMouseWhenRecording :: Bool

  Hide the mouse while recording video. Linux and Windows only.

• logToDisk :: Bool

  Log ffmpeg stdout and stderr to disk.

defaultVideoSettings :: VideoSettings

Default video settings.

fastX11VideoOptions :: [String]

Default options for fast X11 video recording.

qualityX11VideoOptions :: [String]

Default options for quality X11 video recording.

defaultAvfoundationOptions :: [String]

Default options for AVFoundation recording (for Darwin).

defaultGdigrabOptions :: [String]

Default options for gdigrab recording (for Windows).

Types

data VideoProcess

A type representing a live video recording process

videoProcessProcess :: VideoProcess -> ProcessHandle

The process handle

type BaseVideoConstraints context m = (MonadLoggerIO m, MonadUnliftIO m, MonadMask m, MonadReader context m, HasBaseContext context, HasWebDriverContext context)