React Native CDP Status

Emulation Domain

This domain emulates different environments for the page.

Methods

Emulation.clearDeviceMetricsOverride #

Clears the overridden device metrics.

Emulation.clearGeolocationOverride #

Clears the overridden Geolocation Position and Error.

Emulation.clearIdleOverride #

Clears Idle state overrides.

Emulation.setCPUThrottlingRate #

Enables CPU throttling to emulate slow CPUs.

Parameters

rate

number

Throttling rate as a slowdown factor (1 is no throttle, 2 is 2x slowdown, etc).

Emulation.setDefaultBackgroundColorOverride #

Sets or clears an override of the default background color of the frame. This override is used if the content does not specify one.

Parameters

color
Optional

DOM.RGBA

RGBA of the default background color. If not specified, any existing override will be cleared.

Emulation.setDeviceMetricsOverride #

Overrides the values of device screen dimensions (window.screen.width, window.screen.height, window.innerWidth, window.innerHeight, and "device-width"/"device-height"-related CSS media query results).

Parameters

width

integer

Overriding width value in pixels (minimum 0, maximum 10000000). 0 disables the override.

height

integer

Overriding height value in pixels (minimum 0, maximum 10000000). 0 disables the override.

deviceScaleFactor

number

Overriding device scale factor value. 0 disables the override.

mobile

boolean

Whether to emulate mobile device. This includes viewport meta tag, overlay scrollbars, text autosizing and more.

scale
Optional

number

Scale to apply to resulting view image.

Experimental

screenWidth
Optional

integer

Overriding screen width value in pixels (minimum 0, maximum 10000000).

Experimental

screenHeight
Optional

integer

Overriding screen height value in pixels (minimum 0, maximum 10000000).

Experimental

positionX
Optional

integer

Overriding view X position on screen in pixels (minimum 0, maximum 10000000).

Experimental

positionY
Optional

integer

Overriding view Y position on screen in pixels (minimum 0, maximum 10000000).

Experimental

dontSetVisibleSize
Optional

boolean

Do not set visible view size, rely upon explicit setVisibleSize call.

Experimental

screenOrientation
Optional

ScreenOrientation

Screen orientation override.

viewport
Optional

Page.Viewport

If set, the visible area of the page will be overridden to this viewport. This viewport change is not observed by the page, e.g. viewport-relative elements do not change positions.

Experimental

displayFeature
Optional

DisplayFeature

If set, the display feature of a multi-segment screen. If not set, multi-segment support is turned-off. Deprecated, use Emulation.setDisplayFeaturesOverride.

ExperimentalDeprecated

devicePosture
Optional

DevicePosture

If set, the posture of a foldable device. If not set the posture is set to continuous. Deprecated, use Emulation.setDevicePostureOverride.

ExperimentalDeprecated

Emulation.setEmulatedMedia #

Emulates the given media type or media feature for CSS media queries.

Parameters

media
Optional

string

Media type to emulate. Empty string disables the override.

features
Optional

array[ MediaFeature ]

Media features to emulate.

Emulation.setEmulatedOSTextScale #

Emulates the given OS text scale.

Parameters

scale
Optional

number

Emulation.setEmulatedVisionDeficiency #

Emulates the given vision deficiency.

Parameters

type

string

Vision deficiency to emulate. Order: best-effort emulations come first, followed by any physiologically accurate emulations for medically recognized color vision deficiencies.

Allowed values: none, blurredVision, reducedContrast, achromatopsia, deuteranopia, protanopia, tritanopia

Emulation.setGeolocationOverride #

Overrides the Geolocation Position or Error. Omitting latitude, longitude or accuracy emulates position unavailable.

Parameters

latitude
Optional

number

Mock latitude

longitude
Optional

number

Mock longitude

accuracy
Optional

number

Mock accuracy

altitude
Optional

number

Mock altitude

altitudeAccuracy
Optional

number

Mock altitudeAccuracy

heading
Optional

number

Mock heading

speed
Optional

number

Mock speed

Emulation.setIdleOverride #

Overrides the Idle state.

Parameters

isUserActive

boolean

Mock isUserActive

isScreenUnlocked

boolean

Mock isScreenUnlocked

Emulation.setScriptExecutionDisabled #

Switches script execution in the page.

Parameters

value

boolean

Whether script execution should be disabled in the page.

Emulation.setTimezoneOverride #

Overrides default host system timezone with the specified one.

Parameters

timezoneId

string

The timezone identifier. List of supported timezones: https://source.chromium.org/chromium/chromium/deps/icu.git/+/faee8bc70570192d82d2978a71e2a615788597d1:source/data/misc/metaZones.txt If empty, disables the override and restores default host system timezone.

Emulation.setTouchEmulationEnabled #

Enables touch on platforms which do not support them.

Parameters

enabled

boolean

Whether the touch event emulation should be enabled.

maxTouchPoints
Optional

integer

Maximum touch points supported. Defaults to one.

Emulation.setUserAgentOverride #

Allows overriding user agent with the given string. userAgentMetadata must be set for Client Hint headers to be sent.

Parameters

userAgent

string

User agent to use.

acceptLanguage
Optional

string

Browser language to emulate.

platform
Optional

string

The platform navigator.platform should return.

userAgentMetadata
Optional

UserAgentMetadata

To be sent in Sec-CH-UA-* headers and returned in navigator.userAgentData

Experimental

Emulation.canEmulate Deprecated#

Tells whether emulation is supported.

Return object

result

boolean

True if emulation is supported.

Emulation.addScreen Experimental#

Add a new screen to the device. Only supported in headless mode.

Parameters

left

integer

Offset of the left edge of the screen in pixels.

top

integer

Offset of the top edge of the screen in pixels.

width

integer

The width of the screen in pixels.

height

integer

The height of the screen in pixels.

workAreaInsets
Optional

WorkAreaInsets

Specifies the screen's work area. Default is entire screen.

devicePixelRatio
Optional

number

Specifies the screen's device pixel ratio. Default is 1.

rotation
Optional

integer

Specifies the screen's rotation angle. Available values are 0, 90, 180 and 270. Default is 0.

colorDepth
Optional

integer

Specifies the screen's color depth in bits. Default is 24.

label
Optional

string

Specifies the descriptive label for the screen. Default is none.

isInternal
Optional

boolean

Indicates whether the screen is internal to the device or external, attached to the device. Default is false.

Return object

screenInfo

ScreenInfo

Emulation.clearDevicePostureOverride Experimental#

Clears a device posture override set with either setDeviceMetricsOverride() or setDevicePostureOverride() and starts using posture information from the platform again. Does nothing if no override is set.

Emulation.clearDisplayFeaturesOverride Experimental#

Clears the display features override set with either setDeviceMetricsOverride() or setDisplayFeaturesOverride() and starts using display features from the platform again. Does nothing if no override is set.

Emulation.getOverriddenSensorInformation Experimental#

Parameters

type

SensorType

Return object

requestedSamplingFrequency

number

Emulation.getScreenInfos Experimental#

Returns device's screen configuration.

Return object

screenInfos

array[ ScreenInfo ]

Emulation.removeScreen Experimental#

Remove screen from the device. Only supported in headless mode.

Parameters

screenId

ScreenId

Emulation.resetPageScaleFactor Experimental#

Requests that page scale factor is reset to initial values.

Emulation.setAutoDarkModeOverride Experimental#

Automatically render all web contents using a dark theme.

Parameters

enabled
Optional

boolean

Whether to enable or disable automatic dark mode. If not specified, any existing override will be cleared.

Emulation.setAutomationOverride Experimental#

Allows overriding the automation flag.

Parameters

enabled

boolean

Whether the override should be enabled.

Emulation.setDataSaverOverride Experimental#

Override the value of navigator.connection.saveData

Parameters

dataSaverEnabled
Optional

boolean

Override value. Omitting the parameter disables the override.

Emulation.setDevicePostureOverride Experimental#

Start reporting the given posture value to the Device Posture API. This override can also be set in setDeviceMetricsOverride().

Parameters

posture

DevicePosture

Emulation.setDisabledImageTypes Experimental#

Parameters

imageTypes

array[ DisabledImageType ]

Image types to disable.

Emulation.setDisplayFeaturesOverride Experimental#

Start using the given display features to pupulate the Viewport Segments API. This override can also be set in setDeviceMetricsOverride().

Parameters

features

array[ DisplayFeature ]

Emulation.setDocumentCookieDisabled Experimental#

Parameters

disabled

boolean

Whether document.coookie API should be disabled.

Emulation.setEmitTouchEventsForMouse Experimental#

Parameters

enabled

boolean

Whether touch emulation based on mouse input should be enabled.

configuration
Optional

string

Touch/gesture events configuration. Default: current platform.

Allowed values: mobile, desktop

Emulation.setFocusEmulationEnabled Experimental#

Enables or disables simulating a focused and active page.

Parameters

enabled

boolean

Whether to enable to disable focus emulation.

Emulation.setHardwareConcurrencyOverride Experimental#

Parameters

hardwareConcurrency

integer

Hardware concurrency to report

Emulation.setLocaleOverride Experimental#

Overrides default host system locale with the specified one.

Parameters

locale
Optional

string

ICU style C locale (e.g. "en_US"). If not specified or empty, disables the override and restores default host system locale.

Emulation.setPageScaleFactor Experimental#

Sets a specified page scale factor.

Parameters

pageScaleFactor

number

Page scale factor.

Emulation.setPressureDataOverride Experimental#

Provides a given pressure data set that will be processed and eventually be delivered to PressureObserver users. |source| must have been previously overridden by setPressureSourceOverrideEnabled.

Parameters

source

PressureSource

state

PressureState

ownContributionEstimate
Optional

number

Emulation.setPressureSourceOverrideEnabled Experimental#

Overrides a pressure source of a given type, as used by the Compute Pressure API, so that updates to PressureObserver.observe() are provided via setPressureStateOverride instead of being retrieved from platform-provided telemetry data.

Parameters

enabled

boolean

source

PressureSource

metadata
Optional

PressureMetadata

Emulation.setPressureStateOverride Experimental#

TODO: OBSOLETE: To remove when setPressureDataOverride is merged. Provides a given pressure state that will be processed and eventually be delivered to PressureObserver users. |source| must have been previously overridden by setPressureSourceOverrideEnabled.

Parameters

source

PressureSource

state

PressureState

Emulation.setSafeAreaInsetsOverride Experimental#

Overrides the values for env(safe-area-inset-) and env(safe-area-max-inset-). Unset values will cause the respective variables to be undefined, even if previously overridden.

Parameters

insets

SafeAreaInsets

Emulation.setScrollbarsHidden Experimental#

Parameters

hidden

boolean

Whether scrollbars should be always hidden.

Emulation.setSensorOverrideEnabled Experimental#

Overrides a platform sensor of a given type. If |enabled| is true, calls to Sensor.start() will use a virtual sensor as backend rather than fetching data from a real hardware sensor. Otherwise, existing virtual sensor-backend Sensor objects will fire an error event and new calls to Sensor.start() will attempt to use a real sensor instead.

Parameters

enabled

boolean

type

SensorType

metadata
Optional

SensorMetadata

Emulation.setSensorOverrideReadings Experimental#

Updates the sensor readings reported by a sensor type previously overridden by setSensorOverrideEnabled.

Parameters

type

SensorType

reading

SensorReading

Emulation.setSmallViewportHeightDifferenceOverride Experimental#

Allows overriding the difference between the small and large viewport sizes, which determine the value of the svh and lvh unit, respectively. Only supported for top-level frames.

Parameters

difference

integer

This will cause an element of size 100svh to be difference pixels smaller than an element of size 100lvh.

Emulation.setVirtualTimePolicy Experimental#

Turns on virtual time for all frames (replacing real-time with a synthetic time source) and sets the current virtual time policy. Note this supersedes any previous time budget.

Parameters

policy

VirtualTimePolicy

budget
Optional

number

If set, after this many virtual milliseconds have elapsed virtual time will be paused and a virtualTimeBudgetExpired event is sent.

maxVirtualTimeTaskStarvationCount
Optional

integer

If set this specifies the maximum number of tasks that can be run before virtual is forced forwards to prevent deadlock.

initialVirtualTime
Optional

Network.TimeSinceEpoch

If set, base::Time::Now will be overridden to initially return this value.

Return object

virtualTimeTicksBase

number

Absolute timestamp at which virtual time was first enabled (up time in milliseconds).

Emulation.setNavigatorOverrides ExperimentalDeprecated#

Overrides value returned by the javascript navigator object.

Parameters

platform

string

The platform navigator.platform should return.

Emulation.setVisibleSize ExperimentalDeprecated#

Resizes the frame/viewport of the page. Note that this does not affect the frame's container (e.g. browser window). Can be used to produce screenshots of the specified size. Not supported on Android.

Parameters

width

integer

Frame width (DIP).

height

integer

Frame height (DIP).

Events

Emulation.virtualTimeBudgetExpired Experimental#

Notification sent after the virtual time budget for the current VirtualTimePolicy has run out.

Types

Emulation.DevicePosture #

Type: object

Properties

type

string

Current posture of the device

Allowed values: continuous, folded

Emulation.DisplayFeature #

Type: object

Properties

orientation

string

Orientation of a display feature in relation to screen

Allowed values: vertical, horizontal

offset

integer

The offset from the screen origin in either the x (for vertical orientation) or y (for horizontal orientation) direction.

maskLength

integer

A display feature may mask content such that it is not physically displayed - this length along with the offset describes this area. A display feature that only splits content will have a 0 mask_length.

Emulation.MediaFeature #

Type: object

Properties

name

string

value

string

Emulation.ScreenOrientation #

Screen orientation.

Type: object

Properties

type

string

Orientation type.

Allowed values: portraitPrimary, portraitSecondary, landscapePrimary, landscapeSecondary

angle

integer

Orientation angle.

Emulation.DisabledImageType Experimental#

Enum of image types that can be disabled.

Type: string

Allowed values: avif, webp

Emulation.PressureMetadata Experimental#

Type: object

Properties

available
Optional

boolean

Emulation.PressureSource Experimental#

Type: string

Allowed values: cpu

Emulation.PressureState Experimental#

Type: string

Allowed values: nominal, fair, serious, critical

Emulation.SafeAreaInsets Experimental#

Type: object

Properties

top
Optional

integer

Overrides safe-area-inset-top.

topMax
Optional

integer

Overrides safe-area-max-inset-top.

left
Optional

integer

Overrides safe-area-inset-left.

leftMax
Optional

integer

Overrides safe-area-max-inset-left.

bottom
Optional

integer

Overrides safe-area-inset-bottom.

bottomMax
Optional

integer

Overrides safe-area-max-inset-bottom.

right
Optional

integer

Overrides safe-area-inset-right.

rightMax
Optional

integer

Overrides safe-area-max-inset-right.

Emulation.ScreenId Experimental#

Type: string

Emulation.ScreenInfo Experimental#

Screen information similar to the one returned by window.getScreenDetails() method, see https://w3c.github.io/window-management/#screendetailed.

Type: object

Properties

left

integer

Offset of the left edge of the screen.

top

integer

Offset of the top edge of the screen.

width

integer

Width of the screen.

height

integer

Height of the screen.

availLeft

integer

Offset of the left edge of the available screen area.

availTop

integer

Offset of the top edge of the available screen area.

availWidth

integer

Width of the available screen area.

availHeight

integer

Height of the available screen area.

devicePixelRatio

number

Specifies the screen's device pixel ratio.

orientation

ScreenOrientation

Specifies the screen's orientation.

colorDepth

integer

Specifies the screen's color depth in bits.

isExtended

boolean

Indicates whether the device has multiple screens.

isInternal

boolean

Indicates whether the screen is internal to the device or external, attached to the device.

isPrimary

boolean

Indicates whether the screen is set as the the operating system primary screen.

label

string

Specifies the descriptive label for the screen.

id

ScreenId

Specifies the unique identifier of the screen.

Emulation.SensorMetadata Experimental#

Type: object

Properties

available
Optional

boolean

minimumFrequency
Optional

number

maximumFrequency
Optional

number

Emulation.SensorReading Experimental#

Type: object

Properties

single
Optional

SensorReadingSingle

xyz
Optional

SensorReadingXYZ

quaternion
Optional

SensorReadingQuaternion

Emulation.SensorReadingQuaternion Experimental#

Type: object

Properties

x

number

y

number

z

number

w

number

Emulation.SensorReadingSingle Experimental#

Type: object

Properties

value

number

Emulation.SensorReadingXYZ Experimental#

Type: object

Properties

x

number

y

number

z

number

Emulation.SensorType Experimental#

Used to specify sensor types to emulate. See https://w3c.github.io/sensors/#automation for more information.

Type: string

Allowed values: absolute-orientation, accelerometer, ambient-light, gravity, gyroscope, linear-acceleration, magnetometer, relative-orientation

Emulation.UserAgentBrandVersion Experimental#

Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints

Type: object

Properties

brand

string

version

string

Emulation.UserAgentMetadata Experimental#

Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints Missing optional values will be filled in by the target with what it would normally use.

Type: object

Properties

brands
Optional

array[ UserAgentBrandVersion ]

Brands appearing in Sec-CH-UA.

fullVersionList
Optional

array[ UserAgentBrandVersion ]

Brands appearing in Sec-CH-UA-Full-Version-List.

fullVersion
Optional

stringDeprecated

platform

string

platformVersion

string

architecture

string

model

string

mobile

boolean

bitness
Optional

string

wow64
Optional

boolean

formFactors
Optional

array[ string ]

Used to specify User Agent form-factor values. See https://wicg.github.io/ua-client-hints/#sec-ch-ua-form-factors

Emulation.VirtualTimePolicy Experimental#

advance: If the scheduler runs out of immediate work, the virtual time base may fast forward to allow the next delayed task (if any) to run; pause: The virtual time base may not advance; pauseIfNetworkFetchesPending: The virtual time base may not advance if there are any pending resource fetches.

Type: string

Allowed values: advance, pause, pauseIfNetworkFetchesPending

Emulation.WorkAreaInsets Experimental#

Type: object

Properties

top
Optional

integer

Work area top inset in pixels. Default is 0;

left
Optional

integer

Work area left inset in pixels. Default is 0;

bottom
Optional

integer

Work area bottom inset in pixels. Default is 0;

right
Optional

integer

Work area right inset in pixels. Default is 0;