Type Alias PuppeteerScreenRecorderOptions

PuppeteerScreenRecorderOptions: {
    aspectRatio?: "3:2" | "4:3" | "16:9";
    autopad?: {
        color?: string;
    };
    ffmpeg_Path?: string | null;
    followNewTab: boolean;
    format?: "jpeg" | "png";
    fps?: number;
    metadata?: string[];
    quality?: number;
    recordDurationLimit?: number;
    videOutputOptions?: string[];
    videoBitrate?: number;
    videoCodec?: string;
    videoCrf?: number;
    videoFrame?: {
        height: number | null;
        width: number | null;
    };
    videoPixelFormat?: string;
    videoPreset?: string;
}

Type declaration

Optional ReadonlyaspectRatio?: "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 Readonlyautopad?: {
color?: string;
}
Name
autopad

Member
PuppeteerScreenRecorderOptions

Description
Specify whether autopad option is used and its color. Default to autopad deactivation mode.
- Optionalcolor?: string
Optional Readonlyffmpeg_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
```
ReadonlyfollowNewTab: 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 Readonlyformat?: "jpeg" | "png"
Name
format

Member
PuppeteerScreenRecorderOptions

Description
specify the format for recording the video

Default
```
jpeg
```
Optional Readonlyfps?: 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 Readonlymetadata?: string[]
Name
metadata

Member
PuppeteerScreenRecorderOptions

Description
Specify metadata information as key value pairs.
Optional Readonlyquality?: 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 ReadonlyrecordDurationLimit?: 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 ReadonlyvideOutputOptions?: string[]
Name
videOutputOptions

Member
PuppeteerScreenRecorderOptions

Description
Allows you to pass additional options to the ffmpeg encoder -

Example
```
you might want to pass "-movflags +faststart"
```
Optional ReadonlyvideoBitrate?: number
Name
videoBitrate

Member
PuppeteerScreenRecorderOptions

Description
Specify the target bitrate of the final video file in bits/s. The default value is 1000.
Optional ReadonlyvideoCodec?: string
Name
videoCodec

Member
PuppeteerScreenRecorderOptions

Description
Specify the codec used by FFMPEG when creating the final video file. The default value is libx264.
Optional ReadonlyvideoCrf?: number
Name
videoCrf

Member
PuppeteerScreenRecorderOptions

Description
Specify the crf of the final video file. The default value is 23.
Optional ReadonlyvideoFrame?: {
height: number | null;
width: number | null;
}
Name
videoFrame

Member
PuppeteerScreenRecorderOptions

Description
An object which specifies the width and height of the output video frame. Note: VideoFrame option is not applicable for capturing the video.
- height: number | null
- width: number | null
Optional ReadonlyvideoPixelFormat?: string
Name
videoPixelFormat

Member
PuppeteerScreenRecorderOptions

Description
Specify the pixel format to use when encoding the video file. The default value is 'yuv420p'.
Optional ReadonlyvideoPreset?: string
Name
videoPreset

Member
PuppeteerScreenRecorderOptions

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

Type Alias PuppeteerScreenRecorderOptions

Type declaration

Optional ReadonlyaspectRatio?: "3:2" | "4:3" | "16:9"

Name

Member

Description

Default

Optional Readonlyautopad?: { color?: string; }

Name

Member

Description

Optionalcolor?: string

Optional Readonlyffmpeg_Path?: string | null

Name

Member

Description

Default

ReadonlyfollowNewTab: boolean

Name

Member

Description

Default

Optional Readonlyformat?: "jpeg" | "png"

Name

Member

Description

Default

Optional Readonlyfps?: number

Name

Member

Description

Default

Optional Readonlymetadata?: string[]

Name

Member

Description

Optional Readonlyquality?: number

Name

Member

Description

Default

Optional ReadonlyrecordDurationLimit?: number

Name

Member

Description

Optional ReadonlyvideOutputOptions?: string[]

Name

Member

Description

Example

Optional ReadonlyvideoBitrate?: number

Name

Member

Description

Optional ReadonlyvideoCodec?: string

Name

Member

Description

Optional ReadonlyvideoCrf?: number

Name

Member

Description

Optional ReadonlyvideoFrame?: { height: number | null; width: number | null; }

Name

Member

Description

height: number | null

width: number | null

Optional ReadonlyvideoPixelFormat?: string

Name

Member

Description

Optional ReadonlyvideoPreset?: string

Name

Member

Description

Settings

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

`Optional` `Readonly`autopad?: {
color?: string;
}

`Optional`color?: string

`Optional` `Readonly`ffmpeg_Path?: string | null

`Readonly`followNewTab: boolean

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

`Optional` `Readonly`fps?: number

`Optional` `Readonly`metadata?: string[]

`Optional` `Readonly`quality?: number

`Optional` `Readonly`recordDurationLimit?: number

`Optional` `Readonly`videOutputOptions?: string[]

`Optional` `Readonly`videoBitrate?: number

`Optional` `Readonly`videoCodec?: string

`Optional` `Readonly`videoCrf?: number

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

`Optional` `Readonly`videoPixelFormat?: string

`Optional` `Readonly`videoPreset?: string