# Scrapfly Documentation ## Table of Contents ### Dashboard - [Intro](https://scrapfly.io/docs) - [Project](https://scrapfly.io/docs/project) - [Account](https://scrapfly.io/docs/account) - [Workspace & Team](https://scrapfly.io/docs/workspace-and-team) - [Billing](https://scrapfly.io/docs/billing) ### Products #### MCP Server - [Getting Started](https://scrapfly.io/docs/mcp/getting-started) - [Tools & API Spec](https://scrapfly.io/docs/mcp/tools) - [Authentication](https://scrapfly.io/docs/mcp/authentication) - [Examples & Use Cases](https://scrapfly.io/docs/mcp/examples) - [FAQ](https://scrapfly.io/docs/mcp/faq) ##### Integrations - [Overview](https://scrapfly.io/docs/mcp/integrations) - [Claude Desktop](https://scrapfly.io/docs/mcp/integrations/claude-desktop) - [Claude Code](https://scrapfly.io/docs/mcp/integrations/claude-code) - [ChatGPT](https://scrapfly.io/docs/mcp/integrations/chatgpt) - [Cursor](https://scrapfly.io/docs/mcp/integrations/cursor) - [Cline](https://scrapfly.io/docs/mcp/integrations/cline) - [Windsurf](https://scrapfly.io/docs/mcp/integrations/windsurf) - [Zed](https://scrapfly.io/docs/mcp/integrations/zed) - [Roo Code](https://scrapfly.io/docs/mcp/integrations/roo-code) - [VS Code](https://scrapfly.io/docs/mcp/integrations/vscode) - [LangChain](https://scrapfly.io/docs/mcp/integrations/langchain) - [LlamaIndex](https://scrapfly.io/docs/mcp/integrations/llamaindex) - [CrewAI](https://scrapfly.io/docs/mcp/integrations/crewai) - [OpenAI](https://scrapfly.io/docs/mcp/integrations/openai) - [n8n](https://scrapfly.io/docs/mcp/integrations/n8n) - [Make](https://scrapfly.io/docs/mcp/integrations/make) - [Zapier](https://scrapfly.io/docs/mcp/integrations/zapier) - [Vapi AI](https://scrapfly.io/docs/mcp/integrations/vapi) - [Agent Builder](https://scrapfly.io/docs/mcp/integrations/agent-builder) - [Custom Client](https://scrapfly.io/docs/mcp/integrations/custom-client) #### Web Scraping API - [Getting Started](https://scrapfly.io/docs/scrape-api/getting-started) - [API Specification]() - [Monitoring](https://scrapfly.io/docs/monitoring) - [Customize Request](https://scrapfly.io/docs/scrape-api/custom) - [Debug](https://scrapfly.io/docs/scrape-api/debug) - [Unblocker (formerly ASP)](https://scrapfly.io/docs/scrape-api/unblocker) - [Proxy](https://scrapfly.io/docs/scrape-api/proxy) - [Proxy Mode](https://scrapfly.io/docs/scrape-api/proxy-mode) - [Proxy Mode - Screaming Frog](https://scrapfly.io/docs/scrape-api/proxy-mode/screaming-frog) - [Proxy Mode - Apify](https://scrapfly.io/docs/scrape-api/proxy-mode/apify) - [(Auto) Data Extraction](https://scrapfly.io/docs/scrape-api/extraction) - [Javascript Rendering](https://scrapfly.io/docs/scrape-api/javascript-rendering) - [Javascript Scenario](https://scrapfly.io/docs/scrape-api/javascript-scenario) - [SSL](https://scrapfly.io/docs/scrape-api/ssl) - [DNS](https://scrapfly.io/docs/scrape-api/dns) - [Cache](https://scrapfly.io/docs/scrape-api/cache) - [Batch (Multi-URL Scraping)](https://scrapfly.io/docs/scrape-api/batch) - [Session](https://scrapfly.io/docs/scrape-api/session) - [Webhook](https://scrapfly.io/docs/scrape-api/webhook) - [Schedule](https://scrapfly.io/docs/scrape-api/schedule) - [Screenshot](https://scrapfly.io/docs/scrape-api/screenshot) - [Errors](https://scrapfly.io/docs/scrape-api/errors) - [Timeout](https://scrapfly.io/docs/scrape-api/understand-timeout) - [Throttling](https://scrapfly.io/docs/throttling) - [Troubleshoot](https://scrapfly.io/docs/scrape-api/troubleshoot) - [Billing](https://scrapfly.io/docs/scrape-api/billing) - [FAQ](https://scrapfly.io/docs/scrape-api/faq) #### Crawler API - [Getting Started](https://scrapfly.io/docs/crawler-api/getting-started) - [API Specification]() - [Retrieving Results](https://scrapfly.io/docs/crawler-api/results) - [WARC Format](https://scrapfly.io/docs/crawler-api/warc-format) - [Data Extraction](https://scrapfly.io/docs/crawler-api/extraction-rules) - [Search](https://scrapfly.io/docs/crawler-api/search) - [Prompt & Extract](https://scrapfly.io/docs/crawler-api/prompt) - [Auto Refresh](https://scrapfly.io/docs/crawler-api/refresh) - [Webhook](https://scrapfly.io/docs/crawler-api/webhook) - [Schedule](https://scrapfly.io/docs/crawler-api/schedule) - [Billing](https://scrapfly.io/docs/crawler-api/billing) - [Errors](https://scrapfly.io/docs/crawler-api/errors) - [Troubleshoot](https://scrapfly.io/docs/crawler-api/troubleshoot) - [FAQ](https://scrapfly.io/docs/crawler-api/faq) #### Screenshot API - [Getting Started](https://scrapfly.io/docs/screenshot-api/getting-started) - [API Specification]() - [Accessibility Testing](https://scrapfly.io/docs/screenshot-api/accessibility) - [Webhook](https://scrapfly.io/docs/screenshot-api/webhook) - [Schedule](https://scrapfly.io/docs/screenshot-api/schedule) - [Billing](https://scrapfly.io/docs/screenshot-api/billing) - [Errors](https://scrapfly.io/docs/screenshot-api/errors) #### Extraction API - [Getting Started](https://scrapfly.io/docs/extraction-api/getting-started) - [API Specification]() - [Rules Template](https://scrapfly.io/docs/extraction-api/rules-and-template) - [LLM Extraction](https://scrapfly.io/docs/extraction-api/llm-prompt) - [AI Auto Extraction](https://scrapfly.io/docs/extraction-api/automatic-ai) - [Webhook](https://scrapfly.io/docs/extraction-api/webhook) - [Billing](https://scrapfly.io/docs/extraction-api/billing) - [Errors](https://scrapfly.io/docs/extraction-api/errors) - [FAQ](https://scrapfly.io/docs/extraction-api/faq) #### Data API #### Proxy Saver - [Getting Started](https://scrapfly.io/docs/proxy-saver/getting-started) - [Fingerprints](https://scrapfly.io/docs/proxy-saver/fingerprints) - [Optimizations](https://scrapfly.io/docs/proxy-saver/optimizations) - [SSL Certificates](https://scrapfly.io/docs/proxy-saver/certificates) - [Protocols](https://scrapfly.io/docs/proxy-saver/protocols) - [Pacfile](https://scrapfly.io/docs/proxy-saver/pacfile) - [Secure Credentials](https://scrapfly.io/docs/proxy-saver/security) - [Billing](https://scrapfly.io/docs/proxy-saver/billing) #### Cloud Browser API - [Getting Started](https://scrapfly.io/docs/cloud-browser-api/getting-started) - [Proxy & Geo-Targeting](https://scrapfly.io/docs/cloud-browser-api/proxy) - [Unblock API](https://scrapfly.io/docs/cloud-browser-api/unblock) - [Captcha Solver](https://scrapfly.io/docs/cloud-browser-api/captcha-solver) - [File Downloads](https://scrapfly.io/docs/cloud-browser-api/file-downloads) - [Session Resume](https://scrapfly.io/docs/cloud-browser-api/session-resume) - [Human-in-the-Loop](https://scrapfly.io/docs/cloud-browser-api/human-in-the-loop) - [Debug Mode](https://scrapfly.io/docs/cloud-browser-api/debug-mode) - [Browser Extensions](https://scrapfly.io/docs/cloud-browser-api/extensions) - [Credential Vault](https://scrapfly.io/docs/cloud-browser-api/credential-vault) - [Native Browser MCP](https://scrapfly.io/docs/cloud-browser-api/mcp) - [DevTools Protocol](https://scrapfly.io/docs/cloud-browser-api/cdp-reference) ##### Integrations - [Puppeteer](https://scrapfly.io/docs/cloud-browser-api/puppeteer) - [Playwright](https://scrapfly.io/docs/cloud-browser-api/playwright) - [Selenium](https://scrapfly.io/docs/cloud-browser-api/selenium) - [Vercel Agent Browser](https://scrapfly.io/docs/cloud-browser-api/agent-browser) - [Browser Use](https://scrapfly.io/docs/cloud-browser-api/browser-use) - [Stagehand](https://scrapfly.io/docs/cloud-browser-api/stagehand) - [1Password](https://scrapfly.io/docs/cloud-browser-api/1password) - [Billing](https://scrapfly.io/docs/cloud-browser-api/billing) - [Errors](https://scrapfly.io/docs/cloud-browser-api/errors) ### Tools - [Antibot Detector](https://scrapfly.io/docs/tools/antibot-detector) ### SDK - [Golang](https://scrapfly.io/docs/sdk/golang) - [Python](https://scrapfly.io/docs/sdk/python) - [Rust](https://scrapfly.io/docs/sdk/rust) - [TypeScript](https://scrapfly.io/docs/sdk/typescript) - [Scrapy](https://scrapfly.io/docs/sdk/scrapy) ### Integrations - [Getting Started](https://scrapfly.io/docs/integration/getting-started) - [LangChain](https://scrapfly.io/docs/integration/langchain) - [LlamaIndex](https://scrapfly.io/docs/integration/llamaindex) - [CrewAI](https://scrapfly.io/docs/integration/crewai) - [Zapier](https://scrapfly.io/docs/integration/zapier) - [Make](https://scrapfly.io/docs/integration/make) - [n8n](https://scrapfly.io/docs/integration/n8n) ### Academy - [Overview](https://scrapfly.io/academy) - [Web Scraping Overview](https://scrapfly.io/academy/scraping-overview) - [Tools](https://scrapfly.io/academy/tools-overview) - [Reverse Engineering](https://scrapfly.io/academy/reverse-engineering) - [Static Scraping](https://scrapfly.io/academy/static-scraping) - [HTML Parsing](https://scrapfly.io/academy/html-parsing) - [Dynamic Scraping](https://scrapfly.io/academy/dynamic-scraping) - [Hidden API Scraping](https://scrapfly.io/academy/hidden-api-scraping) - [Headless Browsers](https://scrapfly.io/academy/headless-browsers) - [Hidden Web Data](https://scrapfly.io/academy/hidden-web-data) - [JSON Parsing](https://scrapfly.io/academy/json-parsing) - [Data Processing](https://scrapfly.io/academy/data-processing) - [Scaling](https://scrapfly.io/academy/scaling) - [Walkthrough Summary](https://scrapfly.io/academy/walkthrough-summary) - [Scraper Blocking](https://scrapfly.io/academy/scraper-blocking) - [Proxies](https://scrapfly.io/academy/proxies) --- 1. [DevTools Protocol](https://scrapfly.io/docs/cloud-browser-api/cdp-reference) 2. Emulation # Emulation This domain emulates different environments for the page. Official Chrome DevTools Protocol domain, as shipped in Scrapium 155. Upstream reference: [Emulation](https://chromedevtools.github.io/devtools-protocol/tot/Emulation/). **Dependencies:** [DOM](https://scrapfly.io/docs/cloud-browser-api/cdp-reference/DOM), [Page](https://scrapfly.io/docs/cloud-browser-api/cdp-reference/Page), [Runtime](https://scrapfly.io/docs/cloud-browser-api/cdp-reference/Runtime) - [Commands (37)](#commands) - [Events (2)](#events) - [Types (21)](#types) No symbols match your filter. ## Commands #### `Emulation.canEmulate` Deprecated Tells whether emulation is supported. ###### Return Object | Name | Type | Description | |---|---|---| | `result` | `boolean` | True if emulation is supported. | #### `Emulation.clearDeviceMetricsOverride` Clears the overridden device metrics. #### `Emulation.clearGeolocationOverride` Clears the overridden Geolocation Position and Error. #### `Emulation.resetPageScaleFactor` Experimental Requests that page scale factor is reset to initial values. #### `Emulation.setFocusEmulationEnabled` Experimental Enables or disables simulating a focused and active page. ###### Parameters | Name | Type | Description | |---|---|---| | `enabled` | `boolean` | Whether to enable to disable focus emulation. | #### `Emulation.setAutoDarkModeOverride` Experimental Automatically render all web contents using a dark theme. ###### Parameters | Name | Type | Description | |---|---|---| | `enabled` (optional) | `boolean` | Whether to enable or disable automatic dark mode. If not specified, any existing override will be cleared. | #### `Emulation.setCPUThrottlingRate` Enables CPU throttling to emulate slow CPUs. ###### Parameters | Name | Type | Description | |---|---|---| | `rate` | `number` | Throttling rate as a slowdown factor (1 is no throttle, 2 is 2x slowdown, etc). | #### `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 | Name | Type | Description | |---|---|---| | `insets` | `SafeAreaInsets` | | #### `Emulation.setDevicePostureOverride` Experimental Start reporting the given posture value to the Device Posture API. This override can also be set in setDeviceMetricsOverride(). ###### Parameters | Name | Type | Description | |---|---|---| | `posture` | `DevicePosture` | | #### `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.setDisplayFeaturesOverride` Experimental Start using the given display features to pupulate the Viewport Segments API. This override can also be set in setDeviceMetricsOverride(). ###### Parameters | Name | Type | Description | |---|---|---| | `features` | `array<DisplayFeature>` | | #### `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.setScrollbarsHidden` Experimental ###### Parameters | Name | Type | Description | |---|---|---| | `hidden` | `boolean` | Whether scrollbars should be always hidden. | #### `Emulation.setDocumentCookieDisabled` Experimental ###### Parameters | Name | Type | Description | |---|---|---| | `disabled` | `boolean` | Whether document.coookie API should be disabled. | #### `Emulation.setEmitTouchEventsForMouse` Experimental ###### Parameters | Name | Type | Description | |---|---|---| | `enabled` | `boolean` | Whether touch emulation based on mouse input should be enabled. | | `configuration` (optional) | `string` | Touch/gesture events configuration. Default: current platform. | #### `Emulation.setEmulatedVisionDeficiency` Emulates the given vision deficiency. ###### Parameters | Name | Type | Description | |---|---|---| | `type` | `string` | Vision deficiency to emulate. Order: best-effort emulations come first, followed by any physiologically accurate emulations for medically recognized color vision deficiencies. | #### `Emulation.setEmulatedOSTextScale` Emulates the given OS text scale. ###### Parameters | Name | Type | Description | |---|---|---| | `scale` (optional) | `number` | | #### `Emulation.setGeolocationOverride` Overrides the Geolocation Position or Error. Omitting latitude, longitude or accuracy emulates position unavailable. ###### Parameters | Name | Type | Description | |---|---|---| | `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.getOverriddenSensorInformation` Experimental ###### Parameters | Name | Type | Description | |---|---|---| | `type` | `SensorType` | | ###### Return Object | Name | Type | Description | |---|---|---| | `requestedSamplingFrequency` | `number` | | #### `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 | Name | Type | Description | |---|---|---| | `enabled` | `boolean` | | | `type` | `SensorType` | | | `metadata` (optional) | `SensorMetadata` | | #### `Emulation.setSensorOverrideReadings` Experimental Updates the sensor readings reported by a sensor type previously overridden by setSensorOverrideEnabled. ###### Parameters | Name | Type | Description | |---|---|---| | `type` | `SensorType` | | | `reading` | `SensorReading` | | #### `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 | Name | Type | Description | |---|---|---| | `enabled` | `boolean` | | | `source` | `PressureSource` | | | `metadata` (optional) | `PressureMetadata` | | #### `Emulation.setPressureStateOverride` Experimental 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 | Name | Type | Description | |---|---|---| | `source` | `PressureSource` | | | `state` | `PressureState` | | #### `Emulation.setIdleOverride` Overrides the Idle state. ###### Parameters | Name | Type | Description | |---|---|---| | `isUserActive` | `boolean` | Mock isUserActive | | `isScreenUnlocked` | `boolean` | Mock isScreenUnlocked | #### `Emulation.clearIdleOverride` Clears Idle state overrides. #### `Emulation.setScriptExecutionDisabled` Switches script execution in the page. ###### Parameters | Name | Type | Description | |---|---|---| | `value` | `boolean` | Whether script execution should be disabled in the page. | #### `Emulation.setTouchEmulationEnabled` Enables touch on platforms which do not support them. ###### Parameters | Name | Type | Description | |---|---|---| | `enabled` | `boolean` | Whether the touch event emulation should be enabled. | | `maxTouchPoints` (optional) | `integer` | Maximum touch points supported. Defaults to one. | #### `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 | Name | Type | Description | |---|---|---| | `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 | Name | Type | Description | |---|---|---| | `virtualTimeTicksBase` | `number` | Absolute timestamp at which virtual time was first enabled (up time in milliseconds). | #### `Emulation.setDisabledImageTypes` Experimental ###### Parameters | Name | Type | Description | |---|---|---| | `imageTypes` | `array<DisabledImageType>` | Image types to disable. | #### `Emulation.setDataSaverOverride` Experimental Override the value of navigator.connection.saveData ###### Parameters | Name | Type | Description | |---|---|---| | `dataSaverEnabled` (optional) | `boolean` | Override value. Omitting the parameter disables the override. | #### `Emulation.setAutomationOverride` Experimental Allows overriding the automation flag. ###### Parameters | Name | Type | Description | |---|---|---| | `enabled` | `boolean` | Whether the override should be enabled. | #### `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 | Name | Type | Description | |---|---|---| | `difference` | `integer` | This will cause an element of size 100svh to be `difference` pixels smaller than an element of size 100lvh. | #### `Emulation.getScreenInfos` Experimental Returns device's screen configuration. In headful mode, the physical screens configuration is returned, whereas in headless mode, a virtual headless screen configuration is provided instead. ###### Return Object | Name | Type | Description | |---|---|---| | `screenInfos` | `array<ScreenInfo>` | | #### `Emulation.addScreen` Experimental Add a new screen to the device. Only supported in headless mode. ###### Parameters | Name | Type | Description | |---|---|---| | `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 | Name | Type | Description | |---|---|---| | `screenInfo` | `ScreenInfo` | | #### `Emulation.updateScreen` Experimental Updates specified screen parameters. Only supported in headless mode. ###### Parameters | Name | Type | Description | |---|---|---| | `screenId` | `ScreenId` | Target screen identifier. | | `left` (optional) | `integer` | Offset of the left edge of the screen in pixels. | | `top` (optional) | `integer` | Offset of the top edge of the screen in pixels. | | `width` (optional) | `integer` | The width of the screen in pixels. | | `height` (optional) | `integer` | The height of the screen in pixels. | | `workAreaInsets` (optional) | `WorkAreaInsets` | Specifies the screen's work area. | | `devicePixelRatio` (optional) | `number` | Specifies the screen's device pixel ratio. | | `rotation` (optional) | `integer` | Specifies the screen's rotation angle. Available values are 0, 90, 180 and 270. | | `colorDepth` (optional) | `integer` | Specifies the screen's color depth in bits. | | `label` (optional) | `string` | Specifies the descriptive label for the screen. | | `isInternal` (optional) | `boolean` | Indicates whether the screen is internal to the device or external, attached to the device. Default is false. | ###### Return Object | Name | Type | Description | |---|---|---| | `screenInfo` | `ScreenInfo` | | #### `Emulation.removeScreen` Experimental Remove screen from the device. Only supported in headless mode. ###### Parameters | Name | Type | Description | |---|---|---| | `screenId` | `ScreenId` | | #### `Emulation.setPrimaryScreen` Experimental Set primary screen. Only supported in headless mode. Note that this changes the coordinate system origin to the top-left of the new primary screen, updating the bounds and work areas of all existing screens accordingly. ###### Parameters | Name | Type | Description | |---|---|---| | `screenId` | `ScreenId` | | ## Events #### `Emulation.virtualTimeBudgetExpired` Experimental Notification sent after the virtual time budget for the current VirtualTimePolicy has run out. #### `Emulation.screenOrientationLockChanged` Experimental Fired when a page calls screen.orientation.lock() or screen.orientation.unlock() while device emulation is enabled. This allows the DevTools frontend to update the emulated device orientation accordingly. ###### Parameters | Name | Type | Description | |---|---|---| | `locked` | `boolean` | Whether the screen orientation is currently locked. | | `orientation` (optional) | `ScreenOrientation` | The orientation lock type requested by the page. Only set when locked is true. | ## Types #### `SafeAreaInsets` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `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. | #### `ScreenOrientation` (object) Screen orientation. ###### Properties | Name | Type | Description | |---|---|---| | `type` | `string` | Orientation type. | | `angle` | `integer` | Orientation angle. | #### `DisplayFeature` (object) ###### Properties | Name | Type | Description | |---|---|---| | `orientation` | `string` | Orientation of a display feature in relation to screen | | `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. | #### `DevicePosture` (object) ###### Properties | Name | Type | Description | |---|---|---| | `type` | `string` | Current posture of the device | #### `MediaFeature` (object) ###### Properties | Name | Type | Description | |---|---|---| | `name` | `string` | | | `value` | `string` | | #### `VirtualTimePolicy` (string) 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. ###### Allowed Values - `advance` - `pause` - `pauseIfNetworkFetchesPending` #### `UserAgentBrandVersion` (object) Experimental Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints ###### Properties | Name | Type | Description | |---|---|---| | `brand` | `string` | | | `version` | `string` | | #### `UserAgentMetadata` (object) 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. ###### Properties | Name | Type | Description | |---|---|---| | `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) Deprecated | `string` | | | `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 | #### `SensorType` (string) Experimental Used to specify sensor types to emulate. See https://w3c.github.io/sensors/#automation for more information. ###### Allowed Values - `absolute-orientation` - `accelerometer` - `ambient-light` - `gravity` - `gyroscope` - `linear-acceleration` - `magnetometer` - `relative-orientation` #### `SensorMetadata` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `available` (optional) | `boolean` | | | `minimumFrequency` (optional) | `number` | | | `maximumFrequency` (optional) | `number` | | #### `SensorReadingSingle` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `value` | `number` | | #### `SensorReadingXYZ` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `x` | `number` | | | `y` | `number` | | | `z` | `number` | | #### `SensorReadingQuaternion` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `x` | `number` | | | `y` | `number` | | | `z` | `number` | | | `w` | `number` | | #### `SensorReading` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `single` (optional) | `SensorReadingSingle` | | | `xyz` (optional) | `SensorReadingXYZ` | | | `quaternion` (optional) | `SensorReadingQuaternion` | | #### `PressureSource` (string) Experimental ###### Allowed Values - `cpu` #### `PressureState` (string) Experimental ###### Allowed Values - `nominal` - `fair` - `serious` - `critical` #### `PressureMetadata` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `available` (optional) | `boolean` | | #### `WorkAreaInsets` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `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; | #### `ScreenId` (string) Experimental #### `ScreenInfo` (object) Experimental Screen information similar to the one returned by window.getScreenDetails() method, see https://w3c.github.io/window-management/#screendetailed. ###### Properties | Name | Type | Description | |---|---|---| | `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. | #### `DisabledImageType` (string) Experimental Enum of image types that can be disabled. ###### Allowed Values - `avif` - `jxl` - `webp`