Regrip API / session/smartCubeSession / SmartCubeSessionOptions

Type Alias: SmartCubeSessionOptions

SmartCubeSessionOptions = object

Defined in: packages/core/src/session/smartCubeSession.ts:111

Dependencies and optional host overrides for a smart-cube session.

Properties

connect

connect: () => Promise<SmartCubeTransportConnection>

Defined in: packages/core/src/session/smartCubeSession.ts:112

Returns

Promise<SmartCubeTransportConnection>

---

features?

optional features?: SessionFeaturesPatch

Defined in: packages/core/src/session/smartCubeSession.ts:124

App-layer feature overrides, applied after the selected device profile.

---

gyroFrameScheduler?

optional gyroFrameScheduler?: GyroFrameScheduler

Defined in: packages/core/src/session/smartCubeSession.ts:117

Schedules the latest contiguous gyro packet at display cadence. Supplying this is primarily useful for deterministic hosts and tests.

---

virtualRegrips?

optional virtualRegrips?: boolean

Defined in: packages/core/src/session/smartCubeSession.ts:122

Deprecated

Use features.regrip.enabled. This compatibility option will be removed after downstream callers migrate to the profile feature model.