API reference

One page per hook: its inputs, its outputs, and a contract for each function it exposes — what each argument does, what the call resolves to, and what failure looks like.

These pages are the contract, not a description of it. pixelkit-sdk runs npm run check-docs in CI, which clones this repository and fails the build if a hook it exports has no entry here, if an entry describes a hook it no longer exports, or if an entry documents a returned field that is not on the hook’s declared type.

Hooks by section

51 hooks across 6 sections. This index is generated from data/hooks, so a hook cannot be listed in the wrong section or listed twice.

Silicon and compute

Hook	What it reads
useADPF	How much thermal room is left before the phone slows itself down.
useADPFHintSession	Active frame workload negotiation with Android Dynamic Performance Framework and Tensor EAS.
useBatteryShare	Google Pixel Battery Share (Reverse Wireless Qi Charging) telemetry and actuator.
useChargingIntelligence	Deep battery health, cycle count, manufacturing dates, and charging wattage tiers.
useCPU	What the CPU is and how hard it is working right now.
useGPU	Which GPU this is, and whether your frames are arriving on time.
useMemory	System RAM, this app’s heaps, and how close the system is to killing you.
usePerfetto	System-level kernel and app performance profiling via Perfetto v54.
useTPU	Whether the on-device AI stack is installed and usable.

Neural and AI

Hook	What it reads
useAppFunctions	Exposes on-device actions and hardware capabilities to system AI and Gemini Assistant.
useEmbeddings	On-device vector embeddings and semantic cosine similarity scoring via Tensor EdgeTPU.
useGemini	Cloud Gemini chat with real multi-turn history.
useGeminiNano	Gemini Nano running on the phone, with no network and no API key.
useGenAITasks	Four focused text tasks that run locally: summarise, proofread, rewrite, describe.
useNaturalLanguageAI	Translation, language detection, smart replies and entity extraction, all offline.
useSpeech	Speaking text aloud with the voices the phone has installed.
useSpeechAI	Turning speech into text, on the device or in the cloud.
useVisionAI	Nine on-device vision capabilities, plus cloud scene understanding.

Sensors and actuators

Hook	What it reads
useAltimeter	Precision barometric altimetry, vertical climb/descent velocity, and weather trends.
useCamera	Lens, zoom, flash and torch, plus taking photos and recording video.
useCameraExtensions	Google computational photography vendor extensions (Night Sight, Ultra HDR, Portrait Bokeh).
useHaptics	Vibration, from simple taps to custom-shaped waveforms.
useHealthConnect	Platform health records, steps, and sensor vitals telemetry.
useMicrophoneArray	Multi-mic acoustic array topology, polar directivity, and beamforming controls.
useSensors	Motion, orientation, air pressure and ambient light, streaming live.
useThermometer	Non-contact infrared temperature measurement on Google Pixel Pro hardware.
useTorch	The rear flashlight, including variable brightness and an SOS strobe.

Radios and security

Hook	What it reads
useBiometrics	Fingerprint and face authentication.
useBLE	Bluetooth adapter state, Channel Sounding, bonded devices, and active BLE peripheral discovery.
useChannelSounding	Bluetooth Core 6.0 high-accuracy centimeter-precision Phase-Based Ranging (PBR).
useKeyAgreement	Hardware-isolated Elliptic Curve Diffie-Hellman session key derivation via Titan M2.
useLocation	Position, altitude, heading and speed from the satellite receiver.
useNFC	Reading and writing real NFC tags through reader mode.
usePlayIntegrity	Hardware Key Attestation and Google Play Integrity verdicts via Titan M2.
usePrivateSpace	Android 15+ Private Space profile isolation detection and vault policy.
useRadios	Every radio subsystem in one read.
useSatelliteNTN	3GPP Release-17 Non-Terrestrial Network (satellite SOS) status and alignment telemetry.
useSecurity	Encrypted storage for secrets, backed by hardware.
useWifi7MLO	Wi-Fi 7 (802.11be) Multi-Link Operation and 320 MHz channel telemetry.
useWifiRTT	Fine Timing Measurement (FTM / 802.11az) indoor centimeter-level positioning.

System and media

Hook	What it reads
useAudio	Microphone recording with levels and input choice, plus playback.
useCapabilities	What this particular phone actually has.
useCellular	Carrier, radio generation and network codes from the modem.
useDevice	Device identity, battery level, thermistor temperature, voltage, current, and wattage.
useDisplay	Refresh rate, HDR capability, brightness and the screen wake lock.
useMediaLibrary	Saving captures to the gallery, and reading what is there.
useNetwork	Connection type, address and whether traffic actually goes anywhere.
useSpatialAudio	Android Spatializer status, binaural rendering, and dynamic head tracking telemetry.
useVideo	Playing video back, with position, seeking and thumbnails.

Pixel Pro exclusives

Hook	What it reads
useHiLight	The eight-LED ring around the rear camera flash. Real LEDs or nothing.
useUWB	Ultra-wideband radio state, hardware ranging sessions, and spatial diagnostics.

Reading a hook’s source

Every hook returns source: 'hardware' | 'derived' | 'unavailable'. There is deliberately no simulated member, so a fabricated reading cannot be represented. A value that cannot be read is null, and the control that depends on it refuses rather than showing a number nobody measured.

Capability-gated hooks go further, reporting unsupported when the device physically lacks the hardware — which is a different answer from unavailable, meaning it is there but not reachable right now.

Not a hook

geminiClient	The cloud Gemini client the AI hooks call, and its constants.
Observability and provenance	How a reading reports where it came from, and what null means.
PixelNative module	The Kotlin module the hooks read through, and the events it emits.
OpenAPI 3.1 specification	Full OpenAPI 3.1.0 schema for the 51 hooks, hardware telemetry, and actuators.