1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294 | package Torello.Browser.BrowserAPI;
// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***
// Java-HTML Imports
// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***
import Torello.Browser.*;
import Torello.Browser.helper.*;
import Torello.Browser.JavaScriptAPI.*;
import Torello.JSON.*;
import Torello.Java.ReadOnly.ReadOnlyList;
import Torello.Java.ReadOnly.ReadOnlyArrayList;
import Torello.JavaDoc.Annotations.StaticFunctional;
import Torello.JavaDoc.Annotations.JDHeaderBackgroundImg;
import Torello.Browser.BrowserAPI.NestedHelpers.Commands.HeadlessExperimental$$Commands;
// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***
// JDK Imports
// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***
import javax.json.JsonObject;
import javax.json.JsonValue;
/**
* <SPAN CLASS=COPIEDJDK><B>This domain provides experimental commands only supported in headless mode.</B></SPAN>
* <EMBED CLASS='external-html' DATA-FILE-ID=CDP.CODE_GEN_NOTE>
*/
@StaticFunctional@JDHeaderBackgroundImg(EmbedTagFileID="CDP.WOOD_PLANK_NOTE")
public class HeadlessExperimental
{
// No Pubic Constructors
private HeadlessExperimental() { }
// ********************************************************************************************
// ********************************************************************************************
// Basic Types
// ********************************************************************************************
// ********************************************************************************************
/**
* Encoding options for a screenshot.
*
* <EMBED CLASS=globalDefs DATA-DOMAIN=HeadlessExperimental DATA-API=BrowserAPI>
*/
@JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_TYPE_JDHBI")
public static class ScreenshotParams
extends BaseType<ScreenshotParams>
implements java.io.Serializable
{
/** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
protected static final long serialVersionUID = 1;
private static final NestedHelper<HeadlessExperimental.ScreenshotParams> singleton =
Torello.Browser.BrowserAPI.NestedHelpers.Types.
HeadlessExperimental$$ScreenshotParams$$.singleton;
/**
* Image compression format (defaults to png).
* <BR /><B CLASS=Opt-Top>OPTIONAL</B>
* <EMBED CLASS='external-html' DATA-D=HeadlessExperimental DATA-C=ScreenshotParams DATA-F=format DATA-FILE-ID=CDP.EL1>
* @see BaseType#enumStrList(String)
*/
public final String format;
/**
* Compression quality from range [0..100] (jpeg and webp only).
* <BR /><B CLASS=Opt-Top>OPTIONAL</B>
*/
public final Integer quality;
/**
* Optimize image encoding for speed, not for resulting size (defaults to false)
* <BR /><B CLASS=Opt-Top>OPTIONAL</B>
*/
public final Boolean optimizeForSpeed;
/** Constructor. Please review this class' fields for documentation. */
public ScreenshotParams(
ReadOnlyList<Boolean> isPresent, String format, Integer quality,
Boolean optimizeForSpeed
)
{
super(singleton, Domains.HeadlessExperimental, "ScreenshotParams", 3);
this.format = format;
this.quality = quality;
this.optimizeForSpeed = optimizeForSpeed;
this.isPresent = (isPresent == null)
? singleton.generateIsPresentList(this)
: THROWS.check(isPresent, 3, "HeadlessExperimental.ScreenshotParams");
}
/** Creates an instance of this class from a {@link JsonObject}.*/
public static ScreenshotParams fromJSON(JsonObject jo)
{ return singleton.fromJSON(jo); }
/** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
public static NestedDescriptor<ScreenshotParams> descriptor()
{ return singleton.descriptor(); }
}
// ********************************************************************************************
// ********************************************************************************************
// Command-Return Types
// ********************************************************************************************
// ********************************************************************************************
/**
* 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.
*
* <EMBED CLASS=globalDefs DATA-DOMAIN=HeadlessExperimental DATA-API=BrowserAPI DATA-CMD=beginFrame>
* @see HeadlessExperimental#beginFrame
*/
@JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_CMD_JDHBI")
public static class beginFrame$$RET
extends BaseType<beginFrame$$RET>
implements java.io.Serializable
{
/** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
protected static final long serialVersionUID = 1;
private static final NestedHelper<HeadlessExperimental.beginFrame$$RET> singleton =
Torello.Browser.BrowserAPI.NestedHelpers.CmdReturns.
HeadlessExperimental$$beginFrame$$RET.singleton;
/**
* 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.
*/
public final boolean hasDamage;
/**
* Base64-encoded image data of the screenshot, if one was requested and successfully taken. (Encoded as a base64 string when passed over JSON)
* <BR /><B CLASS=Opt-Top>OPTIONAL</B>
*/
public final String screenshotData;
/** Constructor. Please review this class' fields for documentation. */
public beginFrame$$RET
(ReadOnlyList<Boolean> isPresent, boolean hasDamage, String screenshotData)
{
super(singleton, Domains.HeadlessExperimental, "beginFrame", 2);
this.hasDamage = hasDamage;
this.screenshotData = screenshotData;
this.isPresent = (isPresent == null)
? singleton.generateIsPresentList(this)
: THROWS.check(isPresent, 2, "HeadlessExperimental.beginFrame$$RET");
}
/** Creates an instance of this class from a {@link JsonObject}.*/
public static beginFrame$$RET fromJSON(JsonObject jo)
{ return singleton.fromJSON(jo); }
/** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
public static NestedDescriptor<beginFrame$$RET> descriptor()
{ return singleton.descriptor(); }
}
// ********************************************************************************************
// ********************************************************************************************
// Commands
// ********************************************************************************************
// ********************************************************************************************
/**
* 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.
*
* @param frameTimeTicks
* Timestamp of this BeginFrame in Renderer TimeTicks (milliseconds of uptime). If not set,
* the current time will be used.
* <BR /><B CLASS=Opt-Top>OPTIONAL</B>
*
* @param 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.
* <BR /><B CLASS=Opt-Top>OPTIONAL</B>
*
* @param 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.
* <BR /><B CLASS=Opt-Top>OPTIONAL</B>
*
* @param 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.
* <BR /><B CLASS=Opt-Top>OPTIONAL</B>
*
* @return An instance of <CODE>{@link Script}<{@link beginFrame$$RET}></CODE>
*
* <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
* {@link Script#exec(WebSocketSender) Script.exec}, and afterwards, a {@link Promise}
* <CODE><{@link beginFrame$$RET}></CODE> will be returned
*
* <BR /><BR />Finally, the <B>{@code Promise}</B> may be <B STYLE='color: red'>awaited</B>,
* using {@link Promise#await()}, <I>and the returned result of this Browser Function may
* be retrieved.</I>
*
* <BR /><BR /><DIV CLASS=JDHint>
* This Browser Function's {@code Promise} returns:{@link beginFrame$$RET}
* A dedicated return type implies that the browser may return more than 1 datum
* </DIV>
*/
public static Script<beginFrame$$RET> beginFrame(
Number frameTimeTicks, Number interval, Boolean noDisplayUpdates,
ScreenshotParams screenshot
)
{
// Convert all Method Parameters into a JSON Request-Object (as a String)
final String requestJSON = WriteJSON.get(
HeadlessExperimental$$Commands.beginFrame$$, "HeadlessExperimental.beginFrame",
frameTimeTicks, interval, noDisplayUpdates, screenshot
);
return new Script<>(
Domains.HeadlessExperimental, "beginFrame", requestJSON,
beginFrame$$RET::fromJSON,
beginFrame$$RET.class
);
}
/**
* Disables headless events for the target.
*
* <BR /><B CLASS=Dep-Top>DEPRECATED</B>
*
* @return An instance of <CODE>{@link Script}<Void></CODE>
*
* <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
* browser receives the invocation-request.
*
* <BR /><BR /><DIV CLASS=JDHint>
* This Browser-Function <I>does not have</I> a return-value. You may choose to
* <B STYLE='color: red'>await</B> the {@link Promise}{@code <Void>} to ensure that
* the Browser Function has run to completion.
* </DIV>
*/
public static Script<Void> disable()
{
// Ultra-Simple Request JSON - Because this method has no parameters
final String requestJSON = "{\"method\":\"HeadlessExperimental.disable\"}";
return Script.NO_RET(Domains.HeadlessExperimental, "disable", requestJSON);
}
/**
* Enables headless events for the target.
*
* <BR /><B CLASS=Dep-Top>DEPRECATED</B>
*
* @return An instance of <CODE>{@link Script}<Void></CODE>
*
* <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
* browser receives the invocation-request.
*
* <BR /><BR /><DIV CLASS=JDHint>
* This Browser-Function <I>does not have</I> a return-value. You may choose to
* <B STYLE='color: red'>await</B> the {@link Promise}{@code <Void>} to ensure that
* the Browser Function has run to completion.
* </DIV>
*/
public static Script<Void> enable()
{
// Ultra-Simple Request JSON - Because this method has no parameters
final String requestJSON = "{\"method\":\"HeadlessExperimental.enable\"}";
return Script.NO_RET(Domains.HeadlessExperimental, "enable", requestJSON);
}
}
|