Chrome Remote Interface v0.0.3 ChromeRemoteInterface.RPC.Input View Source

Link to this section Summary

Link to this section Functions

Link to this function dispatchKeyEvent(page_pid) View Source

Dispatches a key event to the page.

Parameters: type - - Type of the key event.modifiers - - Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8 (default: 0).timestamp - - Time at which the event occurred. Measured in UTC time in seconds since January 1, 1970 (default: current time).text - - Text as generated by processing a virtual key code with a keyboard layout. Not needed for for keyUp and rawKeyDown events (default: “”)unmodifiedText - - Text that would have been generated by the keyboard if no modifiers were pressed (except for shift). Useful for shortcut (accelerator) key handling (default: “”).keyIdentifier - - Unique key identifier (e.g., ‘U+0041’) (default: “”).code - - Unique DOM defined string value for each physical key (e.g., ‘KeyA’) (default: “”).key - - Unique DOM defined string value describing the meaning of the key in the context of active modifiers, keyboard layout, etc (e.g., ‘AltGr’) (default: “”).windowsVirtualKeyCode - - Windows virtual key code (default: 0).nativeVirtualKeyCode - - Native virtual key code (default: 0).autoRepeat - - Whether the event was generated from auto repeat (default: false).isKeypad - - Whether the event was generated from the keypad (default: false).isSystemKey - - Whether the event was a system key event (default: false).

Link to this function dispatchKeyEvent(page_pid, parameters) View Source
Link to this function dispatchKeyEvent(page_pid, parameters, opts) View Source
Link to this function dispatchMouseEvent(page_pid) View Source

Dispatches a mouse event to the page.

Parameters: type - - Type of the mouse event.x - - X coordinate of the event relative to the main frame’s viewport.y - - Y coordinate of the event relative to the main frame’s viewport. 0 refers to the top of the viewport and Y increases as it proceeds towards the bottom of the viewport.modifiers - - Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8 (default: 0).timestamp - - Time at which the event occurred. Measured in UTC time in seconds since January 1, 1970 (default: current time).button - - Mouse button (default: “none”).clickCount - - Number of times the mouse button was clicked (default: 0).

Link to this function dispatchMouseEvent(page_pid, parameters) View Source
Link to this function dispatchMouseEvent(page_pid, parameters, opts) View Source
Link to this function dispatchTouchEvent(page_pid) View Source

Dispatches a touch event to the page.

Parameters: type - - Type of the touch event.touchPoints - - Touch points.modifiers - - Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8 (default: 0).timestamp - - Time at which the event occurred. Measured in UTC time in seconds since January 1, 1970 (default: current time).

Link to this function dispatchTouchEvent(page_pid, parameters) View Source
Link to this function dispatchTouchEvent(page_pid, parameters, opts) View Source
Link to this function emulateTouchFromMouseEvent(page_pid) View Source

Emulates touch event from the mouse event parameters.

Parameters: type - - Type of the mouse event.x - - X coordinate of the mouse pointer in DIP.y - - Y coordinate of the mouse pointer in DIP.timestamp - - Time at which the event occurred. Measured in UTC time in seconds since January 1, 1970.button - - Mouse button.deltaX - - X delta in DIP for mouse wheel event (default: 0).deltaY - - Y delta in DIP for mouse wheel event (default: 0).modifiers - - Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8 (default: 0).clickCount - - Number of times the mouse button was clicked (default: 0).

Link to this function emulateTouchFromMouseEvent(page_pid, parameters) View Source
Link to this function emulateTouchFromMouseEvent(page_pid, parameters, opts) View Source
Link to this function setIgnoreInputEvents(page_pid) View Source

Ignores input events (useful while auditing page).

Parameters: ignore - - Ignores input events processing when set to true.

Link to this function setIgnoreInputEvents(page_pid, parameters) View Source
Link to this function setIgnoreInputEvents(page_pid, parameters, opts) View Source
Link to this function synthesizePinchGesture(page_pid) View Source

Synthesizes a pinch gesture over a time period by issuing appropriate touch events.

Parameters: x - - X coordinate of the start of the gesture in CSS pixels.y - - Y coordinate of the start of the gesture in CSS pixels.scaleFactor - - Relative scale factor after zooming (>1.0 zooms in, <1.0 zooms out).relativeSpeed - - Relative pointer speed in pixels per second (default: 800).gestureSourceType - - Which type of input events to be generated (default: ‘default’, which queries the platform for the preferred input type).

Link to this function synthesizePinchGesture(page_pid, parameters) View Source
Link to this function synthesizePinchGesture(page_pid, parameters, opts) View Source
Link to this function synthesizeScrollGesture(page_pid) View Source

Synthesizes a scroll gesture over a time period by issuing appropriate touch events.

Parameters: x - - X coordinate of the start of the gesture in CSS pixels.y - - Y coordinate of the start of the gesture in CSS pixels.xDistance - - The distance to scroll along the X axis (positive to scroll left).yDistance - - The distance to scroll along the Y axis (positive to scroll up).xOverscroll - - The number of additional pixels to scroll back along the X axis, in addition to the given distance.yOverscroll - - The number of additional pixels to scroll back along the Y axis, in addition to the given distance.preventFling - - Prevent fling (default: true).speed - - Swipe speed in pixels per second (default: 800).gestureSourceType - - Which type of input events to be generated (default: ‘default’, which queries the platform for the preferred input type).repeatCount - - The number of times to repeat the gesture (default: 0).repeatDelayMs - - The number of milliseconds delay between each repeat. (default: 250).interactionMarkerName - - The name of the interaction markers to generate, if not empty (default: “”).

Link to this function synthesizeScrollGesture(page_pid, parameters) View Source
Link to this function synthesizeScrollGesture(page_pid, parameters, opts) View Source
Link to this function synthesizeTapGesture(page_pid) View Source

Synthesizes a tap gesture over a time period by issuing appropriate touch events.

Parameters: x - - X coordinate of the start of the gesture in CSS pixels.y - - Y coordinate of the start of the gesture in CSS pixels.duration - - Duration between touchdown and touchup events in ms (default: 50).tapCount - - Number of times to perform the tap (e.g. 2 for double tap, default: 1).gestureSourceType - - Which type of input events to be generated (default: ‘default’, which queries the platform for the preferred input type).

Link to this function synthesizeTapGesture(page_pid, parameters) View Source
Link to this function synthesizeTapGesture(page_pid, parameters, opts) View Source