pl.wendigo.chrome.api.headlessexperimental / BeginFrameResponse

BeginFrameResponse

data class BeginFrameResponse (source)

Represents response frame that is returned from HeadlessExperimental#beginFrame operation call. Sends a BeginFrame to the target and returns when the frame was completed. Optionally captures a screenshot from the resulting frame. Requires that the target was created with enabled BeginFrameControl. Designed for use with --run-all-compositor-stages-before-draw, see also https://goo.gl/3zHXhB for more background.

Link
HeadlessExperimental#beginFrame method documentation.

See Also

HeadlessExperimentalOperations.beginFrame

Constructors

<init>

BeginFrameResponse(hasDamage: Boolean, screenshotData: String? = null)

Represents response frame that is returned from HeadlessExperimental#beginFrame operation call. Sends a BeginFrame to the target and returns when the frame was completed. Optionally captures a screenshot from the resulting frame. Requires that the target was created with enabled BeginFrameControl. Designed for use with --run-all-compositor-stages-before-draw, see also https://goo.gl/3zHXhB for more background.

Properties

hasDamage

val hasDamage: Boolean

Whether the BeginFrame resulted in damage and, thus, a new frame was committed to the display. Reported for diagnostic uses, may be removed in the future.

screenshotData

val screenshotData: String?

Base64-encoded image data of the screenshot, if one was requested and successfully taken.