Package io.webfolder.cdp.command

Interface HeadlessExperimental

public interface HeadlessExperimental

This domain provides experimental commands only supported in headless mode

Method Summary

Modifier and Type	Method	Description
BeginFrameResult	beginFrame()	Sends a BeginFrame to the target and returns when the frame was completed.
BeginFrameResult	beginFrame(Double frameTime, Double frameTimeTicks, Double deadline, Double deadlineTicks, Double interval, Boolean noDisplayUpdates, ScreenshotParams screenshot)	Sends a BeginFrame to the target and returns when the frame was completed.
void	disable()	Disables headless events for the target.
void	enable()	Enables headless events for the target.
void	enterDeterministicMode()	Puts the browser into deterministic mode.
void	enterDeterministicMode(Double initialDate)	Puts the browser into deterministic mode.

Method Detail

beginFrame

BeginFrameResult beginFrame(Double frameTime,
                            Double frameTimeTicks,
                            Double deadline,
                            Double deadlineTicks,
                            Double interval,
                            Boolean noDisplayUpdates,
                            ScreenshotParams screenshot)

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.

Parameters:

frameTime - Timestamp of this BeginFrame (milliseconds since epoch). If not set, the current time will be used unless frameTicks is specified.

frameTimeTicks - Timestamp of this BeginFrame in Renderer TimeTicks (milliseconds of uptime). If not set, the current time will be used unless frameTime is specified.

deadline - Deadline of this BeginFrame (milliseconds since epoch). If not set, the deadline will be calculated from the frameTime and interval unless deadlineTicks is specified.

deadlineTicks - Deadline of this BeginFrame in Renderer TimeTicks (milliseconds of uptime). If not set, the deadline will be calculated from the frameTime and interval unless deadline is specified.

interval - The interval between BeginFrames that is reported to the compositor, in milliseconds. Defaults to a 60 frames/second interval, i.e. about 16.666 milliseconds.

noDisplayUpdates - Whether updates should not be committed and drawn onto the display. False by default. If true, only side effects of the BeginFrame will be run, such as layout and animations, but any visual updates may not be visible on the display or in screenshots.

screenshot - If set, a screenshot of the frame will be captured and returned in the response. Otherwise, no screenshot will be captured. Note that capturing a screenshot can fail, for example, during renderer initialization. In such a case, no screenshot data will be returned.

Returns:

BeginFrameResult

enterDeterministicMode

void enterDeterministicMode(Double initialDate)

Puts the browser into deterministic mode. Only effective for subsequently created web contents. Only supported in headless mode. Once set there's no way of leaving deterministic mode.

Parameters:

initialDate - Number of seconds since the Epoch

disable

void disable()

Disables headless events for the target.

enable

void enable()

Enables headless events for the target.

beginFrame

BeginFrameResult beginFrame()

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.

Returns:

BeginFrameResult

enterDeterministicMode

void enterDeterministicMode()

Puts the browser into deterministic mode. Only effective for subsequently created web contents. Only supported in headless mode. Once set there's no way of leaving deterministic mode.