CloudXR.js API Reference#
API reference documentation for the CloudXR.js SDK, automatically generated from TypeScript source.
For user guides, tutorials, and integration documentation, see the CloudXR SDK Documentation.
- Function: createSession()
- Function: getGridValidationError()
- Function: getGridValidationMessageForConnect()
- Function: getResolutionValidationError()
- Function: getResolutionValidationMessageForConnect()
- Function: validateDepthReprojectionGrid()
- Function: validatePerEyeResolution()
- Interface: GridValidationResult
- Interface: MessageChannel
- Interface: PerEyeResolutionValidationResult
- Interface: Session
- Interface: SessionDelegates
- Interface: SessionOptions
- Example
- Properties
- serverAddress
- serverPort
- useSecureConnection
- mediaAddress?
- mediaPort?
- signalingQueryParameters?
- signalingResourcePath?
- gl
- perEyeWidth
- perEyeHeight
- reprojectionGridCols?
- reprojectionGridRows?
- referenceSpace
- glBinding?
- codec?
- deviceFrameRate?
- maxStreamingBitrateKbps?
- telemetry?
- enablePoseSmoothing?
- posePredictionFactor?
- enableTexSubImage2D?
- useQuestColorWorkaround?
- iceServers?
- Interface: StreamingError
- Enumeration: MessageChannelStatus
- Enumeration: MetricsCadence
- Enumeration: MetricsName
- Enumeration: SessionState
- Type Alias: Metrics