Class HeadlessExperimentalImpl

java.lang.Object
io.webfolder.cdp.command.HeadlessExperimentalImpl
All Implemented Interfaces:
HeadlessExperimental

public class HeadlessExperimentalImpl
extends java.lang.Object
implements HeadlessExperimental
  • Constructor Summary

    Constructors 
    Constructor Description
    HeadlessExperimentalImpl​(SessionInvocationHandler handler)  
  • Method Summary

    Modifier and Type Method Description
    BeginFrameResult beginFrame()
    Sends a BeginFrame to the target and returns when the frame was completed.
    BeginFrameResult beginFrame​(java.lang.Double frameTimeTicks, java.lang.Double interval, java.lang.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.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

  • Method Details

    • beginFrame

      public BeginFrameResult beginFrame​(java.lang.Double frameTimeTicks, java.lang.Double interval, java.lang.Boolean noDisplayUpdates, ScreenshotParams screenshot)
      Description copied from interface: HeadlessExperimental
      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.
      Specified by:
      beginFrame in interface HeadlessExperimental
      Parameters:
      frameTimeTicks - Timestamp of this BeginFrame in Renderer TimeTicks (milliseconds of uptime). If not set, the current time will be used.
      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
    • disable

      public void disable()
      Description copied from interface: HeadlessExperimental
      Disables headless events for the target.
      Specified by:
      disable in interface HeadlessExperimental
    • enable

      public void enable()
      Description copied from interface: HeadlessExperimental
      Enables headless events for the target.
      Specified by:
      enable in interface HeadlessExperimental
    • beginFrame

      public BeginFrameResult beginFrame()
      Description copied from interface: HeadlessExperimental
      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.
      Specified by:
      beginFrame in interface HeadlessExperimental
      Returns:
      BeginFrameResult