package headlessexperimental

Import Path
	github.com/chromedp/cdproto/headlessexperimental (on go.dev)

Dependency Relation
	imports 8 packages, and imported by one package

Involved Source Files

	    easyjson.go
	  d headlessexperimental.go
		Package headlessexperimental provides the Chrome DevTools Protocol
		commands, types, and events for the HeadlessExperimental domain.
		
		This domain provides experimental commands only supported in headless
		mode.
		
		Generated by the cdproto-gen command.

	    types.go
Package-Level Type Names (total 4)

	/* sort by: alphabet | popularity */
	 type BeginFrameParams (struct)
		BeginFrameParams 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.gle/chrome-headless-rendering for more background.

		Fields (total 4)
			FrameTimeTicks float64
				// Timestamp of this BeginFrame in Renderer TimeTicks (milliseconds of uptime). If not set, the current time will be used.

			Interval float64
				// 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 bool
				// 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 *ScreenshotParams
				// 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.

		Methods (total 9)
			(*BeginFrameParams) Do(ctx context.Context) (hasDamage bool, screenshotData []byte, err error)
				Do executes HeadlessExperimental.beginFrame against the provided context.
				
				returns:
				
					hasDamage - 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 - Base64-encoded image data of the screenshot, if one was requested and successfully taken.

			( BeginFrameParams) MarshalEasyJSON(w *jwriter.Writer)
				MarshalEasyJSON supports easyjson.Marshaler interface

			( BeginFrameParams) MarshalJSON() ([]byte, error)
				MarshalJSON supports json.Marshaler interface

			(*BeginFrameParams) UnmarshalEasyJSON(l *jlexer.Lexer)
				UnmarshalEasyJSON supports easyjson.Unmarshaler interface

			(*BeginFrameParams) UnmarshalJSON(data []byte) error
				UnmarshalJSON supports json.Unmarshaler interface

			( BeginFrameParams) WithFrameTimeTicks(frameTimeTicks float64) *BeginFrameParams
				WithFrameTimeTicks timestamp of this BeginFrame in Renderer TimeTicks
				(milliseconds of uptime). If not set, the current time will be used.

			( BeginFrameParams) WithInterval(interval float64) *BeginFrameParams
				WithInterval 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.

			( BeginFrameParams) WithNoDisplayUpdates(noDisplayUpdates bool) *BeginFrameParams
				WithNoDisplayUpdates 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.

			( BeginFrameParams) WithScreenshot(screenshot *ScreenshotParams) *BeginFrameParams
				WithScreenshot 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.

		Implements (at least 7)
			 BeginFrameParams : github.com/goccy/go-json.Marshaler
			*BeginFrameParams : github.com/goccy/go-json.Unmarshaler
			 BeginFrameParams : github.com/mailru/easyjson.Marshaler
			*BeginFrameParams : github.com/mailru/easyjson.MarshalerUnmarshaler
			*BeginFrameParams : github.com/mailru/easyjson.Unmarshaler
			 BeginFrameParams : encoding/json.Marshaler
			*BeginFrameParams : encoding/json.Unmarshaler
		As Outputs Of (at least 5)
			func BeginFrame() *BeginFrameParams
			func BeginFrameParams.WithFrameTimeTicks(frameTimeTicks float64) *BeginFrameParams
			func BeginFrameParams.WithInterval(interval float64) *BeginFrameParams
			func BeginFrameParams.WithNoDisplayUpdates(noDisplayUpdates bool) *BeginFrameParams
			func BeginFrameParams.WithScreenshot(screenshot *ScreenshotParams) *BeginFrameParams

	 type BeginFrameReturns (struct)
		BeginFrameReturns return values.

		Fields (total 2)
			HasDamage bool
				// 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 string
				// Base64-encoded image data of the screenshot, if one was requested and successfully taken.

		Methods (total 4)
			( BeginFrameReturns) MarshalEasyJSON(w *jwriter.Writer)
				MarshalEasyJSON supports easyjson.Marshaler interface

			( BeginFrameReturns) MarshalJSON() ([]byte, error)
				MarshalJSON supports json.Marshaler interface

			(*BeginFrameReturns) UnmarshalEasyJSON(l *jlexer.Lexer)
				UnmarshalEasyJSON supports easyjson.Unmarshaler interface

			(*BeginFrameReturns) UnmarshalJSON(data []byte) error
				UnmarshalJSON supports json.Unmarshaler interface

		Implements (at least 7)
			 BeginFrameReturns : github.com/goccy/go-json.Marshaler
			*BeginFrameReturns : github.com/goccy/go-json.Unmarshaler
			 BeginFrameReturns : github.com/mailru/easyjson.Marshaler
			*BeginFrameReturns : github.com/mailru/easyjson.MarshalerUnmarshaler
			*BeginFrameReturns : github.com/mailru/easyjson.Unmarshaler
			 BeginFrameReturns : encoding/json.Marshaler
			*BeginFrameReturns : encoding/json.Unmarshaler

	 type ScreenshotParams (struct)
		ScreenshotParams encoding options for a screenshot.
		
		See: https://chromedevtools.github.io/devtools-protocol/tot/HeadlessExperimental#type-ScreenshotParams

		Fields (total 3)
			Format ScreenshotParamsFormat
				// Image compression format (defaults to png).

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

			Quality int64
				// Compression quality from range [0..100] (jpeg and webp only).

		Methods (total 4)
			( ScreenshotParams) MarshalEasyJSON(w *jwriter.Writer)
				MarshalEasyJSON supports easyjson.Marshaler interface

			( ScreenshotParams) MarshalJSON() ([]byte, error)
				MarshalJSON supports json.Marshaler interface

			(*ScreenshotParams) UnmarshalEasyJSON(l *jlexer.Lexer)
				UnmarshalEasyJSON supports easyjson.Unmarshaler interface

			(*ScreenshotParams) UnmarshalJSON(data []byte) error
				UnmarshalJSON supports json.Unmarshaler interface

		Implements (at least 7)
			 ScreenshotParams : github.com/goccy/go-json.Marshaler
			*ScreenshotParams : github.com/goccy/go-json.Unmarshaler
			 ScreenshotParams : github.com/mailru/easyjson.Marshaler
			*ScreenshotParams : github.com/mailru/easyjson.MarshalerUnmarshaler
			*ScreenshotParams : github.com/mailru/easyjson.Unmarshaler
			 ScreenshotParams : encoding/json.Marshaler
			*ScreenshotParams : encoding/json.Unmarshaler
		As Inputs Of (at least one exported)
			func BeginFrameParams.WithScreenshot(screenshot *ScreenshotParams) *BeginFrameParams

	 type ScreenshotParamsFormat string (basic type)
		ScreenshotParamsFormat image compression format (defaults to png).
		
		See: https://chromedevtools.github.io/devtools-protocol/tot/HeadlessExperimental#type-ScreenshotParams

		Methods (total 5)
			( ScreenshotParamsFormat) MarshalEasyJSON(out *jwriter.Writer)
				MarshalEasyJSON satisfies easyjson.Marshaler.

			( ScreenshotParamsFormat) MarshalJSON() ([]byte, error)
				MarshalJSON satisfies json.Marshaler.

			( ScreenshotParamsFormat) String() string
				String returns the ScreenshotParamsFormat as string value.

			(*ScreenshotParamsFormat) UnmarshalEasyJSON(in *jlexer.Lexer)
				UnmarshalEasyJSON satisfies easyjson.Unmarshaler.

			(*ScreenshotParamsFormat) UnmarshalJSON(buf []byte) error
				UnmarshalJSON satisfies json.Unmarshaler.

		Implements (at least 9)
			 ScreenshotParamsFormat : github.com/goccy/go-json.Marshaler
			*ScreenshotParamsFormat : github.com/goccy/go-json.Unmarshaler
			 ScreenshotParamsFormat : github.com/mailru/easyjson.Marshaler
			*ScreenshotParamsFormat : github.com/mailru/easyjson.MarshalerUnmarshaler
			*ScreenshotParamsFormat : github.com/mailru/easyjson.Unmarshaler
			 ScreenshotParamsFormat : encoding/json.Marshaler
			*ScreenshotParamsFormat : encoding/json.Unmarshaler
			 ScreenshotParamsFormat : expvar.Var
			 ScreenshotParamsFormat : fmt.Stringer
		As Types Of (total 3)
			const ScreenshotParamsFormatJpeg
			const ScreenshotParamsFormatPng
			const ScreenshotParamsFormatWebp


Package-Level Functions (only one)

	 func BeginFrame() *BeginFrameParams
		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.gle/chrome-headless-rendering for more background.
		
		See: https://chromedevtools.github.io/devtools-protocol/tot/HeadlessExperimental#method-beginFrame
		
		parameters:


Package-Level Constants (total 4)

	const CommandBeginFrame = "HeadlessExperimental.beginFrame"
		Command names.

	const ScreenshotParamsFormatJpeg ScreenshotParamsFormat = "jpeg"
		ScreenshotParamsFormat values.

	const ScreenshotParamsFormatPng ScreenshotParamsFormat = "png"
		ScreenshotParamsFormat values.

	const ScreenshotParamsFormatWebp ScreenshotParamsFormat = "webp"
		ScreenshotParamsFormat values.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.