Class: IWSDKAdapter

Defined in: service-framework-iwsdk/src/iwsdk-adapter.ts:71

Implements

• RuntimeAdapter

Constructors

Constructor

new IWSDKAdapter(world: IWSDKWorldLike): IWSDKAdapter;

Defined in: service-framework-iwsdk/src/iwsdk-adapter.ts:112

Parameters

Parameter	Type
world	IWSDKWorldLike

Returns

IWSDKAdapter

Properties

Property	Modifier	Type	Description	Defined in
session	readonly	SessionFacet	Session lifecycle over the world's launchXR / exitXR entry points.	service-framework-iwsdk/src/iwsdk-adapter.ts:94

Methods

clearCapabilityOverrides()

clearCapabilityOverrides(): void;

Defined in: service-framework-iwsdk/src/iwsdk-adapter.ts:172

Drop every manual override and fall back to the derived capabilities.

Returns

void

---

dispose()

dispose(): void;

Defined in: service-framework-iwsdk/src/iwsdk-adapter.ts:188

Release everything the adapter holds: the visibility subscription, the session's own listener, any in-flight session wait, the manual overrides and every listener.

Returns

void

---

emitFrame()

emitFrame(timestamp: number, delta: number): void;

Defined in: service-framework-iwsdk/src/iwsdk-adapter.ts:178

Called once per frame by the ECS bridge system.

Parameters

Parameter	Type
timestamp	number
delta	number

Returns

void

---

getCapabilities()

getCapabilities(): AdapterCapabilities;

Defined in: service-framework-iwsdk/src/iwsdk-adapter.ts:130

Current XR capabilities (may change once a session is established).

Returns

AdapterCapabilities

Implementation of

RuntimeAdapter.getCapabilities

---

getWorld()

getWorld(): IWSDKWorldLike;

Defined in: service-framework-iwsdk/src/iwsdk-adapter.ts:142

The IWSDK World this adapter is bound to.

Returns

IWSDKWorldLike

---

onCapabilitiesChange()

onCapabilitiesChange(listener: CapabilitiesListener): Unsubscribe;

Defined in: service-framework-iwsdk/src/iwsdk-adapter.ts:134

Subscribe to capability changes; returns an unsubscribe handle. Mirrors RuntimeAdapter.onFrame so gating services can react to a session coming online instead of polling RuntimeAdapter.getCapabilities every frame.

Parameters

Parameter	Type
listener	CapabilitiesListener

Returns

Unsubscribe

Implementation of

RuntimeAdapter.onCapabilitiesChange

---

onFrame()

onFrame(listener: FrameListener): Unsubscribe;

Defined in: service-framework-iwsdk/src/iwsdk-adapter.ts:123

Subscribe to per-frame updates; returns an unsubscribe handle.

Parameters

Parameter	Type
listener	FrameListener

Returns

Unsubscribe

Implementation of

RuntimeAdapter.onFrame

---

refreshCapabilities()

refreshCapabilities(): void;

Defined in: service-framework-iwsdk/src/iwsdk-adapter.ts:152

Re-read the live session and publish any capability change. The adapter does this itself whenever the visibility signal fires and whenever the session's input sources change; call it directly on a host whose signal has no subscribe, or after the host enables a feature mid-session.

Returns

void

---

setCapabilities()

setCapabilities(capabilities: Partial<AdapterCapabilities>): void;

Defined in: service-framework-iwsdk/src/iwsdk-adapter.ts:166

Force capability flags regardless of what the session reports. Overrides are a layer on top of the derived values: they win for as long as they are set, survive every later derivation, and are dropped only by IWSDKAdapter.clearCapabilityOverrides or IWSDKAdapter.dispose. Subscribers are notified if the effective capabilities changed.

Parameters

Parameter	Type
capabilities	Partial<AdapterCapabilities>

Returns

void