tap-client/io.github.noamcohen48.tap.sdk/DeviceInfo

DeviceInfo

data class DeviceInfo(val apiLevel: Int, val manufacturer: String, val model: String, val product: String, val displayWidth: Int, val displayHeight: Int, val displayRotation: DisplayRotation, val currentPackage: String?, val screenOn: Boolean, val keyguardLocked: Boolean, val keyguardSecure: Boolean, val keyboardShown: Boolean, val autoRotate: Boolean, val animationsEnabled: Boolean, val darkMode: Boolean, val fontScale: Float, val densityDpi: Int, val airplaneMode: Boolean, val wifiEnabled: Boolean, val mobileDataEnabled: Boolean, val systemLocales: List<String> = emptyList(), val stayAwake: Boolean = false, val highContrastText: Boolean? = null, val colorInversion: Boolean? = null, val boldText: Boolean = false) : Artifact(source)

Facts about the device at the moment of Device.info: identity, display geometry and rotation, screen, keyguard and keyboard state, the package owning the focused window and the device conditions (Device.setAnimations and the rest). Serialized as JSON.

Constructors

constructor(apiLevel: Int, manufacturer: String, model: String, product: String, displayWidth: Int, displayHeight: Int, displayRotation: DisplayRotation, currentPackage: String?, screenOn: Boolean, keyguardLocked: Boolean, keyguardSecure: Boolean, keyboardShown: Boolean, autoRotate: Boolean, animationsEnabled: Boolean, darkMode: Boolean, fontScale: Float, densityDpi: Int, airplaneMode: Boolean, wifiEnabled: Boolean, mobileDataEnabled: Boolean, systemLocales: List<String> = emptyList(), stayAwake: Boolean = false, highContrastText: Boolean? = null, colorInversion: Boolean? = null, boldText: Boolean = false)

Properties

val airplaneMode: Boolean

Airplane mode is on.

animationsEnabled

val animationsEnabled: Boolean

Window, transition or animator animations run (any of the three scales is not 0).

val apiLevel: Int

val autoRotate: Boolean

Auto-rotate is on: the sensor turns the display (off while a rotation is frozen).

val boldText: Boolean

The system font is bold (API 31+; always false below).

open override val bytes: ByteArray

The serialized form: PNG, UTF-8 XML, UTF-8 JSON or UTF-8 text.

val colorInversion: Boolean?

Color inversion is on; null when Android does not let Tap read it.

val currentPackage: String?

The package owning the focused window, when there is one.

val darkMode: Boolean

The UI is in night mode (dark theme).

val densityDpi: Int

The display density apps see, in dpi.

val displayHeight: Int

displayRotation

val displayRotation: DisplayRotation

val displayWidth: Int

open override val extension: String

The usual file extension for bytes, without the dot, e.g. png.

val fontScale: Float

The font scale apps see (1.0 = the default size).

highContrastText

val highContrastText: Boolean?

High-contrast text is on; null when Android does not let Tap read it.

val keyboardShown: Boolean

A soft keyboard (any input method's window) is on screen.

val keyguardLocked: Boolean

The keyguard (lock screen) is showing.

val keyguardSecure: Boolean

A PIN, pattern or password is set: Tap cannot dismiss this keyguard.

val manufacturer: String

open override val mediaType: String

The IANA media type of bytes, e.g. image/png.

mobileDataEnabled

val mobileDataEnabled: Boolean

Mobile data is switched on; false on a device without telephony.

val model: String

val orientation: Orientation

PORTRAIT when the display is at least as tall as it is wide.

val product: String

val screenOn: Boolean

The screen is on (interactive).

val stayAwake: Boolean

The screen stays on while plugged in (Device.setStayAwake).

val systemLocales: List<String>

The device's languages, BCP-47 tags in preference order (Device.setSystemLocales).

val wifiEnabled: Boolean

Wi-Fi is switched on (also while airplane mode is on); says nothing about a connection.

Functions

open fun save(path: Path): Path

Writes bytes to path (parent directories are created) and returns path.