Skip to main content Module emulation Copy item path Source events AddScreen Add a new screen to the device. Only supported in headless mode. AddScreenBuilder Builder for AddScreen AddScreenReturnObject Add a new screen to the device. Only supported in headless mode. AddScreenReturnObjectBuilder Builder for AddScreenReturnObject CanEmulate CanEmulateReturnObject Deprecated Tells whether emulation is supported. CanEmulateReturnObjectBuilder Builder for CanEmulateReturnObject ClearDeviceMetricsOverride ClearDeviceMetricsOverrideReturnObject Clears the overridden device metrics. ClearDevicePostureOverride ClearDevicePostureOverrideReturnObject 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. ClearDisplayFeaturesOverride ClearDisplayFeaturesOverrideReturnObject 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. ClearGeolocationOverride ClearGeolocationOverrideReturnObject Clears the overridden Geolocation Position and Error. ClearIdleOverride ClearIdleOverrideReturnObject Clears Idle state overrides. DevicePosture DevicePostureBuilder Builder for DevicePosture DisplayFeature DisplayFeatureBuilder Builder for DisplayFeature GetOverriddenSensorInformation GetOverriddenSensorInformationBuilder Builder for GetOverriddenSensorInformation GetOverriddenSensorInformationReturnObject GetOverriddenSensorInformationReturnObjectBuilder Builder for GetOverriddenSensorInformationReturnObject GetScreenInfos GetScreenInfosReturnObject Returns device’s screen configuration. GetScreenInfosReturnObjectBuilder Builder for GetScreenInfosReturnObject MediaFeature MediaFeatureBuilder Builder for MediaFeature PressureMetadata PressureMetadataBuilder Builder for PressureMetadata RemoveScreen Remove screen from the device. Only supported in headless mode. RemoveScreenBuilder Builder for RemoveScreen RemoveScreenReturnObject Remove screen from the device. Only supported in headless mode. ResetPageScaleFactor ResetPageScaleFactorReturnObject Requests that page scale factor is reset to initial values. SafeAreaInsets SafeAreaInsetsBuilder Builder for SafeAreaInsets ScreenInfo Screen information similar to the one returned by window.getScreenDetails() method,
see https://w3c.github.io/window-management/#screendetailed . ScreenInfoBuilder Builder for ScreenInfo ScreenOrientation Screen orientation. ScreenOrientationBuilder Builder for ScreenOrientation SensorMetadata SensorMetadataBuilder Builder for SensorMetadata SensorReading SensorReadingBuilder Builder for SensorReading SensorReadingQuaternion SensorReadingQuaternionBuilder Builder for SensorReadingQuaternion SensorReadingSingle SensorReadingSingleBuilder Builder for SensorReadingSingle SensorReadingXyz SensorReadingXyzBuilder Builder for SensorReadingXyz SetAutoDarkModeOverride Automatically render all web contents using a dark theme. SetAutoDarkModeOverrideBuilder Builder for SetAutoDarkModeOverride SetAutoDarkModeOverrideReturnObject Automatically render all web contents using a dark theme. SetAutomationOverride Allows overriding the automation flag. SetAutomationOverrideBuilder Builder for SetAutomationOverride SetAutomationOverrideReturnObject Allows overriding the automation flag. SetCPUThrottlingRate Enables CPU throttling to emulate slow CPUs. SetCPUThrottlingRateBuilder Builder for SetCPUThrottlingRate SetCPUThrottlingRateReturnObject Enables CPU throttling to emulate slow CPUs. SetDataSaverOverride Override the value of navigator.connection.saveData SetDataSaverOverrideBuilder Builder for SetDataSaverOverride SetDataSaverOverrideReturnObject Override the value of navigator.connection.saveData 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. SetDefaultBackgroundColorOverrideBuilder Builder for SetDefaultBackgroundColorOverride SetDefaultBackgroundColorOverrideReturnObject Sets or clears an override of the default background color of the frame. This override is used
if the content does not specify one. 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). SetDeviceMetricsOverrideBuilder Builder for SetDeviceMetricsOverride SetDeviceMetricsOverrideReturnObject 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). SetDevicePostureOverride Start reporting the given posture value to the Device Posture API.
This override can also be set in setDeviceMetricsOverride(). SetDevicePostureOverrideBuilder Builder for SetDevicePostureOverride SetDevicePostureOverrideReturnObject Start reporting the given posture value to the Device Posture API.
This override can also be set in setDeviceMetricsOverride(). SetDisabledImageTypes SetDisabledImageTypesBuilder Builder for SetDisabledImageTypes SetDisabledImageTypesReturnObject SetDisplayFeaturesOverride Start using the given display features to pupulate the Viewport Segments API.
This override can also be set in setDeviceMetricsOverride(). SetDisplayFeaturesOverrideBuilder Builder for SetDisplayFeaturesOverride SetDisplayFeaturesOverrideReturnObject Start using the given display features to pupulate the Viewport Segments API.
This override can also be set in setDeviceMetricsOverride(). SetDocumentCookieDisabled SetDocumentCookieDisabledBuilder Builder for SetDocumentCookieDisabled SetDocumentCookieDisabledReturnObject SetEmitTouchEventsForMouse SetEmitTouchEventsForMouseBuilder Builder for SetEmitTouchEventsForMouse SetEmitTouchEventsForMouseReturnObject SetEmulatedMedia Emulates the given media type or media feature for CSS media queries. SetEmulatedMediaBuilder Builder for SetEmulatedMedia SetEmulatedMediaReturnObject Emulates the given media type or media feature for CSS media queries. SetEmulatedOSTextScale Emulates the given OS text scale. SetEmulatedOSTextScaleBuilder Builder for SetEmulatedOSTextScale SetEmulatedOSTextScaleReturnObject Emulates the given OS text scale. SetEmulatedVisionDeficiency Emulates the given vision deficiency. SetEmulatedVisionDeficiencyBuilder Builder for SetEmulatedVisionDeficiency SetEmulatedVisionDeficiencyReturnObject Emulates the given vision deficiency. SetFocusEmulationEnabled Enables or disables simulating a focused and active page. SetFocusEmulationEnabledBuilder Builder for SetFocusEmulationEnabled SetFocusEmulationEnabledReturnObject Enables or disables simulating a focused and active page. SetGeolocationOverride Overrides the Geolocation Position or Error. Omitting latitude, longitude or
accuracy emulates position unavailable. SetGeolocationOverrideBuilder Builder for SetGeolocationOverride SetGeolocationOverrideReturnObject Overrides the Geolocation Position or Error. Omitting latitude, longitude or
accuracy emulates position unavailable. SetHardwareConcurrencyOverride SetHardwareConcurrencyOverrideBuilder Builder for SetHardwareConcurrencyOverride SetHardwareConcurrencyOverrideReturnObject SetIdleOverride Overrides the Idle state. SetIdleOverrideBuilder Builder for SetIdleOverride SetIdleOverrideReturnObject Overrides the Idle state. SetLocaleOverride Overrides default host system locale with the specified one. SetLocaleOverrideBuilder Builder for SetLocaleOverride SetLocaleOverrideReturnObject Overrides default host system locale with the specified one. SetNavigatorOverrides Deprecated Overrides value returned by the javascript navigator object. SetNavigatorOverridesBuilder Builder for SetNavigatorOverrides SetNavigatorOverridesReturnObject Deprecated Overrides value returned by the javascript navigator object. SetPageScaleFactor Sets a specified page scale factor. SetPageScaleFactorBuilder Builder for SetPageScaleFactor SetPageScaleFactorReturnObject Sets a specified page scale factor. SetPressureDataOverride 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. SetPressureDataOverrideBuilder Builder for SetPressureDataOverride SetPressureDataOverrideReturnObject 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. SetPressureSourceOverrideEnabled 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. SetPressureSourceOverrideEnabledBuilder Builder for SetPressureSourceOverrideEnabled SetPressureSourceOverrideEnabledReturnObject 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. SetPressureStateOverride 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. SetPressureStateOverrideBuilder Builder for SetPressureStateOverride SetPressureStateOverrideReturnObject 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. SetSafeAreaInsetsOverride 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. SetSafeAreaInsetsOverrideBuilder Builder for SetSafeAreaInsetsOverride SetSafeAreaInsetsOverrideReturnObject 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. SetScriptExecutionDisabled Switches script execution in the page. SetScriptExecutionDisabledBuilder Builder for SetScriptExecutionDisabled SetScriptExecutionDisabledReturnObject Switches script execution in the page. SetScrollbarsHidden SetScrollbarsHiddenBuilder Builder for SetScrollbarsHidden SetScrollbarsHiddenReturnObject SetSensorOverrideEnabled 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. SetSensorOverrideEnabledBuilder Builder for SetSensorOverrideEnabled SetSensorOverrideEnabledReturnObject 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. SetSensorOverrideReadings Updates the sensor readings reported by a sensor type previously overridden
by setSensorOverrideEnabled. SetSensorOverrideReadingsBuilder Builder for SetSensorOverrideReadings SetSensorOverrideReadingsReturnObject Updates the sensor readings reported by a sensor type previously overridden
by setSensorOverrideEnabled. SetSmallViewportHeightDifferenceOverride 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. SetSmallViewportHeightDifferenceOverrideBuilder Builder for SetSmallViewportHeightDifferenceOverride SetSmallViewportHeightDifferenceOverrideReturnObject 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. SetTimezoneOverride Overrides default host system timezone with the specified one. SetTimezoneOverrideBuilder Builder for SetTimezoneOverride SetTimezoneOverrideReturnObject Overrides default host system timezone with the specified one. SetTouchEmulationEnabled Enables touch on platforms which do not support them. SetTouchEmulationEnabledBuilder Builder for SetTouchEmulationEnabled SetTouchEmulationEnabledReturnObject Enables touch on platforms which do not support them. SetUserAgentOverride Allows overriding user agent with the given string.
userAgentMetadata must be set for Client Hint headers to be sent. SetUserAgentOverrideBuilder Builder for SetUserAgentOverride SetUserAgentOverrideReturnObject Allows overriding user agent with the given string.
userAgentMetadata must be set for Client Hint headers to be sent. SetVirtualTimePolicy 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. SetVirtualTimePolicyBuilder Builder for SetVirtualTimePolicy SetVirtualTimePolicyReturnObject 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. SetVirtualTimePolicyReturnObjectBuilder Builder for SetVirtualTimePolicyReturnObject SetVisibleSize Deprecated 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. SetVisibleSizeBuilder Builder for SetVisibleSize SetVisibleSizeReturnObject Deprecated 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. UserAgentBrandVersion Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints UserAgentBrandVersionBuilder Builder for UserAgentBrandVersion UserAgentMetadata 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. UserAgentMetadataBuilder Builder for UserAgentMetadata WorkAreaInsets WorkAreaInsetsBuilder Builder for WorkAreaInsets AddScreenBuilderError Error type for AddScreenBuilder AddScreenReturnObjectBuilderError Error type for AddScreenReturnObjectBuilder CanEmulateReturnObjectBuilderError Error type for CanEmulateReturnObjectBuilder DevicePostureBuilderError Error type for DevicePostureBuilder DevicePostureType DisabledImageType DisplayFeatureBuilderError Error type for DisplayFeatureBuilder DisplayFeatureOrientation GetOverriddenSensorInformationBuilderError Error type for GetOverriddenSensorInformationBuilder GetOverriddenSensorInformationReturnObjectBuilderError Error type for GetOverriddenSensorInformationReturnObjectBuilder GetScreenInfosReturnObjectBuilderError Error type for GetScreenInfosReturnObjectBuilder MediaFeatureBuilderError Error type for MediaFeatureBuilder PressureMetadataBuilderError Error type for PressureMetadataBuilder PressureSource PressureState RemoveScreenBuilderError Error type for RemoveScreenBuilder SafeAreaInsetsBuilderError Error type for SafeAreaInsetsBuilder ScreenInfoBuilderError Error type for ScreenInfoBuilder ScreenOrientationBuilderError Error type for ScreenOrientationBuilder ScreenOrientationType SensorMetadataBuilderError Error type for SensorMetadataBuilder SensorReadingBuilderError Error type for SensorReadingBuilder SensorReadingQuaternionBuilderError Error type for SensorReadingQuaternionBuilder SensorReadingSingleBuilderError Error type for SensorReadingSingleBuilder SensorReadingXyzBuilderError Error type for SensorReadingXyzBuilder SensorType SetAutoDarkModeOverrideBuilderError Error type for SetAutoDarkModeOverrideBuilder SetAutomationOverrideBuilderError Error type for SetAutomationOverrideBuilder SetCPUThrottlingRateBuilderError Error type for SetCPUThrottlingRateBuilder SetDataSaverOverrideBuilderError Error type for SetDataSaverOverrideBuilder SetDefaultBackgroundColorOverrideBuilderError Error type for SetDefaultBackgroundColorOverrideBuilder SetDeviceMetricsOverrideBuilderError Error type for SetDeviceMetricsOverrideBuilder SetDevicePostureOverrideBuilderError Error type for SetDevicePostureOverrideBuilder SetDisabledImageTypesBuilderError Error type for SetDisabledImageTypesBuilder SetDisplayFeaturesOverrideBuilderError Error type for SetDisplayFeaturesOverrideBuilder SetDocumentCookieDisabledBuilderError Error type for SetDocumentCookieDisabledBuilder SetEmitTouchEventsForMouseBuilderError Error type for SetEmitTouchEventsForMouseBuilder SetEmitTouchEventsForMouseConfigurationOption SetEmulatedMediaBuilderError Error type for SetEmulatedMediaBuilder SetEmulatedOSTextScaleBuilderError Error type for SetEmulatedOSTextScaleBuilder SetEmulatedVisionDeficiencyBuilderError Error type for SetEmulatedVisionDeficiencyBuilder SetEmulatedVisionDeficiencyTypeOption SetFocusEmulationEnabledBuilderError Error type for SetFocusEmulationEnabledBuilder SetGeolocationOverrideBuilderError Error type for SetGeolocationOverrideBuilder SetHardwareConcurrencyOverrideBuilderError Error type for SetHardwareConcurrencyOverrideBuilder SetIdleOverrideBuilderError Error type for SetIdleOverrideBuilder SetLocaleOverrideBuilderError Error type for SetLocaleOverrideBuilder SetNavigatorOverridesBuilderError Error type for SetNavigatorOverridesBuilder SetPageScaleFactorBuilderError Error type for SetPageScaleFactorBuilder SetPressureDataOverrideBuilderError Error type for SetPressureDataOverrideBuilder SetPressureSourceOverrideEnabledBuilderError Error type for SetPressureSourceOverrideEnabledBuilder SetPressureStateOverrideBuilderError Error type for SetPressureStateOverrideBuilder SetSafeAreaInsetsOverrideBuilderError Error type for SetSafeAreaInsetsOverrideBuilder SetScriptExecutionDisabledBuilderError Error type for SetScriptExecutionDisabledBuilder SetScrollbarsHiddenBuilderError Error type for SetScrollbarsHiddenBuilder SetSensorOverrideEnabledBuilderError Error type for SetSensorOverrideEnabledBuilder SetSensorOverrideReadingsBuilderError Error type for SetSensorOverrideReadingsBuilder SetSmallViewportHeightDifferenceOverrideBuilderError Error type for SetSmallViewportHeightDifferenceOverrideBuilder SetTimezoneOverrideBuilderError Error type for SetTimezoneOverrideBuilder SetTouchEmulationEnabledBuilderError Error type for SetTouchEmulationEnabledBuilder SetUserAgentOverrideBuilderError Error type for SetUserAgentOverrideBuilder SetVirtualTimePolicyBuilderError Error type for SetVirtualTimePolicyBuilder SetVirtualTimePolicyReturnObjectBuilderError Error type for SetVirtualTimePolicyReturnObjectBuilder SetVisibleSizeBuilderError Error type for SetVisibleSizeBuilder UserAgentBrandVersionBuilderError Error type for UserAgentBrandVersionBuilder UserAgentMetadataBuilderError Error type for UserAgentMetadataBuilder VirtualTimePolicy WorkAreaInsetsBuilderError Error type for WorkAreaInsetsBuilder ScreenId