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

EmulationDomain

class EmulationDomain(source)

This domain emulates different environments for the page.

Official doc

Functions

Link copied to clipboard
suspend fun canEmulate(): CanEmulateResponse

Tells whether emulation is supported.

Link copied to clipboard
suspend fun clearDeviceMetricsOverride(): ClearDeviceMetricsOverrideResponse

Clears the overridden device metrics.

Link copied to clipboard
suspend fun clearGeolocationOverride(): ClearGeolocationOverrideResponse

Clears the overridden Geolocation Position and Error.

Link copied to clipboard
suspend fun clearIdleOverride(): ClearIdleOverrideResponse

Clears Idle state overrides.

Link copied to clipboard
fun events(): Flow<EmulationEvent>

Subscribes to all events related to this domain.

Link copied to clipboard
suspend fun resetPageScaleFactor(): ResetPageScaleFactorResponse

Requests that page scale factor is reset to initial values.

Link copied to clipboard
@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.

Link copied to clipboard
Link copied to clipboard
suspend fun setCPUThrottlingRate(rate: Double): SetCPUThrottlingRateResponse
suspend fun setCPUThrottlingRate(input: SetCPUThrottlingRateRequest): SetCPUThrottlingRateResponse

Enables CPU throttling to emulate slow CPUs.

Link copied to clipboard
@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.

Link copied to clipboard
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).

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@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.

Link copied to clipboard
Link copied to clipboard
suspend fun setFocusEmulationEnabled(enabled: Boolean): SetFocusEmulationEnabledResponse
suspend fun setFocusEmulationEnabled(input: SetFocusEmulationEnabledRequest): SetFocusEmulationEnabledResponse

Enables or disables simulating a focused and active page.

Link copied to clipboard
@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.

Link copied to clipboard
Link copied to clipboard
suspend fun setIdleOverride(input: SetIdleOverrideRequest): SetIdleOverrideResponse
suspend fun setIdleOverride(isUserActive: Boolean, isScreenUnlocked: Boolean): SetIdleOverrideResponse

Overrides the Idle state.

Link copied to clipboard
@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.

Link copied to clipboard
suspend fun setNavigatorOverrides(platform: String): SetNavigatorOverridesResponse
suspend fun setNavigatorOverrides(input: SetNavigatorOverridesRequest): SetNavigatorOverridesResponse

Overrides value returned by the javascript navigator object.

Link copied to clipboard
suspend fun setPageScaleFactor(pageScaleFactor: Double): SetPageScaleFactorResponse
suspend fun setPageScaleFactor(input: SetPageScaleFactorRequest): SetPageScaleFactorResponse

Sets a specified page scale factor.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
suspend fun setTimezoneOverride(timezoneId: String): SetTimezoneOverrideResponse
suspend fun setTimezoneOverride(input: SetTimezoneOverrideRequest): SetTimezoneOverrideResponse

Overrides default host system timezone with the specified one.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
Link copied to clipboard
fun virtualTimeBudgetExpiredEvents(): Flow<EmulationEvent.VirtualTimeBudgetExpired>

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