Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Recorder

The recorder API enables the taking of screenshot or recording a video.

The output defaults to the os.tmpdir() directory, but can be overridden by the recorder.outputPath option.

Hierarchy

  • Recorder

Index

Properties

isRecording

isRecording: boolean

Returns true if a recording is in progress, false otherwise

Methods

startRecording

  • startRecording(): void
  • Start recording a video.

    Videos are recorded in .webm format.

    Returns void

stopRecording

  • stopRecording(fileName?: undefined | string): Promise<void>
  • Stop recording a video.

    Optionally specify the destination fileName.

    Parameters

    • Optional fileName: undefined | string

    Returns Promise<void>

takeScreenshot

  • takeScreenshot(fileName?: undefined | string): void
  • Take a screenshot.

    Optionally specify the destination `fileName.

    Parameters

    • Optional fileName: undefined | string

    Returns void

Generated using TypeDoc