Heading

session.heading reports the phone’s compass heading. Subscribe with onUpdate() to get a HeadingData every time the heading changes.

src/background/index.ts

const off = session.heading.onUpdate((data) => {
  session.display.render([{type: "text", id: "msg", box: {x: 0, y: 0, w: 576, h: 288}, text: `${Math.round(data.degrees)}°`}]);
});

Heading needs the LOCATION permission in your manifest, the same key session.location uses.

Continuous updates

onUpdate() delivers a HeadingData on each heading change. It returns an unsubscribe function.

const off = session.heading.onUpdate((data) => {
  session.display.render([{type: "text", id: "msg", box: {x: 0, y: 0, w: 576, h: 288}, text: `${Math.round(data.degrees)}°`}]);
});

off(); // stop receiving updates

HeadingData

Field	Type	Notes
`degrees`	`number`	Compass heading in degrees. `0` = north, `90` = east.

Permission

session.heading.hasPermission is true when LOCATION is declared in your manifest. It reports the manifest declaration, not the OS grant: if the user denied the system location prompt, onUpdate() produces no reading. See Permissions.

session.heading works on both Android and iOS. It shares the LOCATION manifest key with session.location.

Location

IMU

Getting Started

Core Concepts

UI Layer

Display

Audio & Speech

Sensors & Input

Camera

Phone & System

Data

Reference

Continuous updates

HeadingData

Permission

​Continuous updates

​HeadingData

​Permission

Continuous updates

HeadingData

Permission