chrome-devtools-kotlin/org.hildan.chrome.devtools.domains.page/CaptureScreenshotRequest

CaptureScreenshotRequest

@Serializable

data class CaptureScreenshotRequest(val format: ScreenshotFormat? = null, val quality: Int? = null, val clip: Viewport? = null, val fromSurface: Boolean? = null, val captureBeyondViewport: Boolean? = null, val optimizeForSpeed: Boolean? = null)

Request object containing input parameters for the PageDomain.captureScreenshot command.

Constructors

CaptureScreenshotRequest

constructor(format: ScreenshotFormat? = null, quality: Int? = null, clip: Viewport? = null, fromSurface: Boolean? = null, captureBeyondViewport: Boolean? = null, optimizeForSpeed: Boolean? = null)

Types

A builder for CaptureScreenshotRequest, which allows setting the optional parameters of the PageDomain.captureScreenshot command via a lambda.

Properties

captureBeyondViewport

val captureBeyondViewport: Boolean? = null

Capture the screenshot beyond the viewport. Defaults to false.

val clip: Viewport? = null

Capture the screenshot of a given region only.

val format: ScreenshotFormat? = null

Image compression format (defaults to png).

val fromSurface: Boolean? = null

Capture the screenshot from the surface, rather than the view. Defaults to true.

optimizeForSpeed

val optimizeForSpeed: Boolean? = null

Optimize image encoding for speed, not for resulting size (defaults to false)

val quality: Int? = null

Compression quality from range 0..100 (jpeg only).