puppeteer-screen-recorder

Type declaration

• Optional Readonly aspectRatio?: "3:2" | "4:3" | "16:9"

  name

  aspectRatio

  member

  PuppeteerScreenRecorderOptions

  description

  Specify the aspect ratio of the video. Default value is 4:3.

  default

  4:3

• Optional Readonly autopad?: { color?: string }

  name

  autopad

  member

  PuppeteerScreenRecorderOptions

  description

  Specify whether autopad option is used and its color. Default to autopad deactivation mode.

  • Optional color?: string

• Optional Readonly ffmpeg_Path?: string | null

  name

  ffmpeg_Path

  member

  PuppeteerScreenRecorderOptions

  description

  String value pointing to the installation of FFMPEG. Default is null (Automatically install the FFMPEG and use it).

  default

  null

• Readonly followNewTab: boolean

  name

  followNewTab

  member

  PuppeteerScreenRecorderOptions

  description

  Boolean value which is indicate whether to follow the tab or not. Default value is true.

  default

  true

• Optional Readonly format?: "jpeg" | "png"

  name

  format

  member

  PuppeteerScreenRecorderOptions

  description

  specify the format for recording the video

  default

  jpeg

• Optional Readonly fps?: number

  name

  fps

  member

  PuppeteerScreenRecorderOptions

  description

  Numeric value which denotes no.of Frames per second in which the video should be recorded. default value is 25.

  default

  25

• Optional Readonly quality?: number

  name

  quality

  member

  PuppeteerScreenRecorderOptions

  description

  Numeric value which denotes no.of quality of individual frame captured by chrome. Value accepted 0 - 100. 100 denotes the highest quality and 0 denotes the lowest quality

  default

  100

• Optional Readonly recordDurationLimit?: number

  name

  recordDurationLimit

  member

  PuppeteerScreenRecorderOptions

  description

  Numerical value specify duration (in seconds) to record the video. By default video is recorded till stop method is invoked`. (Note: It's mandatory to invoke Stop() method even if this value is set)

• Optional Readonly videoBitrate?: number

  name

  videoBitrate

  member

  PuppeteerScreenRecorderOptions

  description

  Specify the target bitrate of the final video file in bits/s. The default value is 1000.

• Optional Readonly videoCodec?: string

  name

  videoCodec

  member

  PuppeteerScreenRecorderOptions

  description

  Specify the codec used by FFMPEG when creating the final video file. The default value is libx264.

• Optional Readonly videoCrf?: number

  name

  videoCrf

  member

  PuppeteerScreenRecorderOptions

  description

  Specify the crf of the final video file. The default value is 23.

• Optional Readonly videoFrame?: { height: number | null; width: number | null }

  name

  videoFrame

  member

  PuppeteerScreenRecorderOptions

  description

  An object which is to specify the width and height of the capturing video frame. Default to browser viewport size.

  • height: number | null

  • width: number | null

• Optional Readonly videoPixelFormat?: string

  name

  videoPixelFormat

  member

  PuppeteerScreenRecorderOptions

  description

  Specify the pixel format to use when encoding the video file. The default value is 'yuv420p'.

• Optional Readonly videoPreset?: string

  name

  videoPreset

  member

  PuppeteerScreenRecorderOptions

  description

  Specify the preset to use when encoding the video file. The default value is 'ultrafast'.