chrome-devtools-kotlin/org.hildan.chrome.devtools.domains.emulation/EmulationDomain

EmulationDomain

class EmulationDomain

This domain emulates different environments for the page.

Official doc

Functions

canEmulate

suspend fun ~~canEmulate~~(): CanEmulateResponse

Tells whether emulation is supported.

clearDeviceMetricsOverride

suspend fun clearDeviceMetricsOverride(): ClearDeviceMetricsOverrideResponse

Clears the overridden device metrics.

clearDevicePostureOverride

suspend fun clearDevicePostureOverride(): ClearDevicePostureOverrideResponse

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.

clearGeolocationOverride

suspend fun clearGeolocationOverride(): ClearGeolocationOverrideResponse

Clears the overridden Geolocation Position and Error.

clearIdleOverride

suspend fun clearIdleOverride(): ClearIdleOverrideResponse

Clears Idle state overrides.

events

fun events(): Flow<EmulationEvent>

Subscribes to all events related to this domain.

getOverriddenSensorInformation

suspend fun getOverriddenSensorInformation(input: GetOverriddenSensorInformationRequest): GetOverriddenSensorInformationResponse

suspend fun getOverriddenSensorInformation(type: SensorType): GetOverriddenSensorInformationResponse

(undocumented in the protocol definition)

resetPageScaleFactor

suspend fun resetPageScaleFactor(): ResetPageScaleFactorResponse

Requests that page scale factor is reset to initial values.

setAutoDarkModeOverride

@JvmOverloads

inline suspend fun setAutoDarkModeOverride(optionalArgs: SetAutoDarkModeOverrideRequest.Builder.() -> Unit = {}): SetAutoDarkModeOverrideResponse

suspend fun setAutoDarkModeOverride(input: SetAutoDarkModeOverrideRequest): SetAutoDarkModeOverrideResponse

Automatically render all web contents using a dark theme.

setAutomationOverride

suspend fun setAutomationOverride(enabled: Boolean): SetAutomationOverrideResponse

suspend fun setAutomationOverride(input: SetAutomationOverrideRequest): SetAutomationOverrideResponse

Allows overriding the automation flag.

setCPUThrottlingRate

suspend fun setCPUThrottlingRate(rate: Double): SetCPUThrottlingRateResponse

suspend fun setCPUThrottlingRate(input: SetCPUThrottlingRateRequest): SetCPUThrottlingRateResponse

Enables CPU throttling to emulate slow CPUs.

setDefaultBackgroundColorOverride

@JvmOverloads

inline suspend fun setDefaultBackgroundColorOverride(optionalArgs: SetDefaultBackgroundColorOverrideRequest.Builder.() -> Unit = {}): SetDefaultBackgroundColorOverrideResponse

suspend fun setDefaultBackgroundColorOverride(input: SetDefaultBackgroundColorOverrideRequest): SetDefaultBackgroundColorOverrideResponse

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

suspend fun setDeviceMetricsOverride(input: SetDeviceMetricsOverrideRequest): SetDeviceMetricsOverrideResponse

@JvmOverloads

inline suspend fun setDeviceMetricsOverride(width: Int, height: Int, deviceScaleFactor: Double, mobile: Boolean, optionalArgs: SetDeviceMetricsOverrideRequest.Builder.() -> Unit = {}): SetDeviceMetricsOverrideResponse

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

suspend fun setDevicePostureOverride(posture: DevicePosture): SetDevicePostureOverrideResponse

suspend fun setDevicePostureOverride(input: SetDevicePostureOverrideRequest): SetDevicePostureOverrideResponse

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

setDisabledImageTypes

suspend fun setDisabledImageTypes(imageTypes: List<DisabledImageType>): SetDisabledImageTypesResponse

suspend fun setDisabledImageTypes(input: SetDisabledImageTypesRequest): SetDisabledImageTypesResponse

(undocumented in the protocol definition)

setDocumentCookieDisabled

suspend fun setDocumentCookieDisabled(disabled: Boolean): SetDocumentCookieDisabledResponse

suspend fun setDocumentCookieDisabled(input: SetDocumentCookieDisabledRequest): SetDocumentCookieDisabledResponse

(undocumented in the protocol definition)

setEmitTouchEventsForMouse

suspend fun setEmitTouchEventsForMouse(input: SetEmitTouchEventsForMouseRequest): SetEmitTouchEventsForMouseResponse

@JvmOverloads

inline suspend fun setEmitTouchEventsForMouse(enabled: Boolean, optionalArgs: SetEmitTouchEventsForMouseRequest.Builder.() -> Unit = {}): SetEmitTouchEventsForMouseResponse

(undocumented in the protocol definition)

setEmulatedMedia

@JvmOverloads

inline suspend fun setEmulatedMedia(optionalArgs: SetEmulatedMediaRequest.Builder.() -> Unit = {}): SetEmulatedMediaResponse

suspend fun setEmulatedMedia(input: SetEmulatedMediaRequest): SetEmulatedMediaResponse

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

setEmulatedVisionDeficiency

suspend fun setEmulatedVisionDeficiency(type: EmulatedVisionDeficiencyType): SetEmulatedVisionDeficiencyResponse

suspend fun setEmulatedVisionDeficiency(input: SetEmulatedVisionDeficiencyRequest): SetEmulatedVisionDeficiencyResponse

Emulates the given vision deficiency.

setFocusEmulationEnabled

suspend fun setFocusEmulationEnabled(enabled: Boolean): SetFocusEmulationEnabledResponse

suspend fun setFocusEmulationEnabled(input: SetFocusEmulationEnabledRequest): SetFocusEmulationEnabledResponse

Enables or disables simulating a focused and active page.

setGeolocationOverride

@JvmOverloads

inline suspend fun setGeolocationOverride(optionalArgs: SetGeolocationOverrideRequest.Builder.() -> Unit = {}): SetGeolocationOverrideResponse

suspend fun setGeolocationOverride(input: SetGeolocationOverrideRequest): SetGeolocationOverrideResponse

Overrides the Geolocation Position or Error. Omitting any of the parameters emulates position unavailable.

setHardwareConcurrencyOverride

suspend fun setHardwareConcurrencyOverride(hardwareConcurrency: Int): SetHardwareConcurrencyOverrideResponse

suspend fun setHardwareConcurrencyOverride(input: SetHardwareConcurrencyOverrideRequest): SetHardwareConcurrencyOverrideResponse

(undocumented in the protocol definition)

setIdleOverride

suspend fun setIdleOverride(input: SetIdleOverrideRequest): SetIdleOverrideResponse

suspend fun setIdleOverride(isUserActive: Boolean, isScreenUnlocked: Boolean): SetIdleOverrideResponse

Overrides the Idle state.

setLocaleOverride

@JvmOverloads

inline suspend fun setLocaleOverride(optionalArgs: SetLocaleOverrideRequest.Builder.() -> Unit = {}): SetLocaleOverrideResponse

suspend fun setLocaleOverride(input: SetLocaleOverrideRequest): SetLocaleOverrideResponse

Overrides default host system locale with the specified one.

setNavigatorOverrides

suspend fun ~~setNavigatorOverrides~~(platform: String): SetNavigatorOverridesResponse

suspend fun ~~setNavigatorOverrides~~(input: SetNavigatorOverridesRequest): SetNavigatorOverridesResponse

Overrides value returned by the javascript navigator object.

setPageScaleFactor

suspend fun setPageScaleFactor(pageScaleFactor: Double): SetPageScaleFactorResponse

suspend fun setPageScaleFactor(input: SetPageScaleFactorRequest): SetPageScaleFactorResponse

Sets a specified page scale factor.

setScriptExecutionDisabled

suspend fun setScriptExecutionDisabled(value: Boolean): SetScriptExecutionDisabledResponse

suspend fun setScriptExecutionDisabled(input: SetScriptExecutionDisabledRequest): SetScriptExecutionDisabledResponse

Switches script execution in the page.

setScrollbarsHidden

suspend fun setScrollbarsHidden(hidden: Boolean): SetScrollbarsHiddenResponse

suspend fun setScrollbarsHidden(input: SetScrollbarsHiddenRequest): SetScrollbarsHiddenResponse

(undocumented in the protocol definition)

setSensorOverrideEnabled

suspend fun setSensorOverrideEnabled(input: SetSensorOverrideEnabledRequest): SetSensorOverrideEnabledResponse

@JvmOverloads

inline suspend fun setSensorOverrideEnabled(enabled: Boolean, type: SensorType, optionalArgs: SetSensorOverrideEnabledRequest.Builder.() -> Unit = {}): SetSensorOverrideEnabledResponse

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

suspend fun setSensorOverrideReadings(input: SetSensorOverrideReadingsRequest): SetSensorOverrideReadingsResponse

suspend fun setSensorOverrideReadings(type: SensorType, reading: SensorReading): SetSensorOverrideReadingsResponse

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

setTimezoneOverride

suspend fun setTimezoneOverride(timezoneId: String): SetTimezoneOverrideResponse

suspend fun setTimezoneOverride(input: SetTimezoneOverrideRequest): SetTimezoneOverrideResponse

Overrides default host system timezone with the specified one.

setTouchEmulationEnabled

suspend fun setTouchEmulationEnabled(input: SetTouchEmulationEnabledRequest): SetTouchEmulationEnabledResponse

@JvmOverloads

inline suspend fun setTouchEmulationEnabled(enabled: Boolean, optionalArgs: SetTouchEmulationEnabledRequest.Builder.() -> Unit = {}): SetTouchEmulationEnabledResponse

Enables touch on platforms which do not support them.

setUserAgentOverride

suspend fun setUserAgentOverride(input: SetUserAgentOverrideRequest): SetUserAgentOverrideResponse

@JvmOverloads

inline suspend fun setUserAgentOverride(userAgent: String, optionalArgs: SetUserAgentOverrideRequest.Builder.() -> Unit = {}): SetUserAgentOverrideResponse

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

setVirtualTimePolicy

suspend fun setVirtualTimePolicy(input: SetVirtualTimePolicyRequest): SetVirtualTimePolicyResponse

@JvmOverloads

inline suspend fun setVirtualTimePolicy(policy: VirtualTimePolicy, optionalArgs: SetVirtualTimePolicyRequest.Builder.() -> Unit = {}): SetVirtualTimePolicyResponse

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.

setVisibleSize

suspend fun ~~setVisibleSize~~(input: SetVisibleSizeRequest): SetVisibleSizeResponse

suspend fun ~~setVisibleSize~~(width: Int, height: Int): SetVisibleSizeResponse

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.

virtualTimeBudgetExpired

fun ~~virtualTimeBudgetExpired~~(): Flow<EmulationEvent.VirtualTimeBudgetExpired>

virtualTimeBudgetExpiredEvents

fun virtualTimeBudgetExpiredEvents(): Flow<EmulationEvent.VirtualTimeBudgetExpired>

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