XRSession class

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers. The WebXR Device API's interface represents an ongoing XR session, providing methods and properties used to interact with and control the session. To open a WebXR session, use the XRSystem interface's requestSession() method. With methods, you can poll the viewer's position and orientation (the XRViewerPose), gather information about the user's environment, and present imagery to the user. supports both inline and immersive virtual and augmented reality modes.

EventTarget

XRSession

Implemented types

• EventTarget

Available extensions

• PropsEventTarget
• PropsXRSession

Annotations

• @JS()
• @staticInterop

Constructors

XRSession()

factory

Properties

depthDataFormat → XRDepthDataFormat

Available on XRSession, provided by the PropsXRSession extension

no setter

depthUsage → XRDepthUsage

Available on XRSession, provided by the PropsXRSession extension

no setter

domOverlayState → XRDOMOverlayState?

Available on XRSession, provided by the PropsXRSession extension

no setter

enabledFeatures → Iterable<String>

Available on XRSession, provided by the PropsXRSession extension

no setter

environmentBlendMode → XREnvironmentBlendMode

Available on XRSession, provided by the PropsXRSession extension

no setter

frameRate → double?

Available on XRSession, provided by the PropsXRSession extension

no setter

hashCode → int

The hash code for this object.

no setter, inherited

inputSources → XRInputSourceArray

Available on XRSession, provided by the PropsXRSession extension

no setter

interactionMode → XRInteractionMode

Available on XRSession, provided by the PropsXRSession extension

no setter

onend ↔ EventHandlerNonNull<Event>?

Available on XRSession, provided by the PropsXRSession extension

getter/setter pair

onframeratechange ↔ EventHandlerNonNull<Event>?

Available on XRSession, provided by the PropsXRSession extension

getter/setter pair

oninputsourceschange ↔ EventHandlerNonNull<Event>?

Available on XRSession, provided by the PropsXRSession extension

getter/setter pair

onselect ↔ EventHandlerNonNull<Event>?

Available on XRSession, provided by the PropsXRSession extension

getter/setter pair

onselectend ↔ EventHandlerNonNull<Event>?

Available on XRSession, provided by the PropsXRSession extension

getter/setter pair

onselectstart ↔ EventHandlerNonNull<Event>?

Available on XRSession, provided by the PropsXRSession extension

getter/setter pair

onsqueeze ↔ EventHandlerNonNull<Event>?

Available on XRSession, provided by the PropsXRSession extension

getter/setter pair

onsqueezeend ↔ EventHandlerNonNull<Event>?

Available on XRSession, provided by the PropsXRSession extension

getter/setter pair

onsqueezestart ↔ EventHandlerNonNull<Event>?

Available on XRSession, provided by the PropsXRSession extension

getter/setter pair

onvisibilitychange ↔ EventHandlerNonNull<Event>?

Available on XRSession, provided by the PropsXRSession extension

getter/setter pair

preferredReflectionFormat → XRReflectionFormat

Available on XRSession, provided by the PropsXRSession extension

no setter

renderState → XRRenderState

Available on XRSession, provided by the PropsXRSession extension

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

supportedFrameRates → Float32List?

Available on XRSession, provided by the PropsXRSession extension

no setter

visibilityState → XRVisibilityState

Available on XRSession, provided by the PropsXRSession extension

no setter

Methods

addEventListener(String type, EventListener? callback, [dynamic options]) → void

Available on EventTarget, provided by the PropsEventTarget extension

cancelAnimationFrame(int handle) → void

Available on XRSession, provided by the PropsXRSession extension

dispatchEvent(Event event) → bool

Available on EventTarget, provided by the PropsEventTarget extension

end() → Future<void>

Available on XRSession, provided by the PropsXRSession extension

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

removeEventListener(String type, EventListener? callback, [dynamic options]) → void

Available on EventTarget, provided by the PropsEventTarget extension

requestAnimationFrame(XRFrameRequestCallback callback) → int

Available on XRSession, provided by the PropsXRSession extension

requestHitTestSource(XRHitTestOptionsInit options) → Future<XRHitTestSource>

Available on XRSession, provided by the PropsXRSession extension

requestHitTestSourceForTransientInput(XRTransientInputHitTestOptionsInit options) → Future<XRTransientInputHitTestSource>

Available on XRSession, provided by the PropsXRSession extension

requestLightProbe([XRLightProbeInit? options]) → Future<XRLightProbe>

Available on XRSession, provided by the PropsXRSession extension

requestReferenceSpace(XRReferenceSpaceType type) → Future<XRReferenceSpace>

Available on XRSession, provided by the PropsXRSession extension

toString() → String

A string representation of this object.

inherited

updateRenderState([XRRenderStateInit? state]) → void

Available on XRSession, provided by the PropsXRSession extension

updateTargetFrameRate(double rate) → Future<void>

Available on XRSession, provided by the PropsXRSession extension

Operators

operator ==(Object other) → bool

The equality operator.

inherited